autotrackInViewport

From Genesys Documentation
Jump to: navigation, search
This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

Learn how to configure which element Genesys Predictive Engagement tracks on your websites as they appear and disappear from the viewport. This configuration provides accurate page tracking information for use in segments and outcomes.

Important
This article only applies to customers using web chat. If you are a Genesys Cloud CX customer, we encourage you to use the new web messaging feature to replace web chat.

Description

The autotrackInViewport module tracks when an element becomes visible in the viewport or disappears from the viewport. To use autotrackInViewport, configure the elements to track using the following options:

Signature


ac('load', 'autotrackInViewport', config, [callback]);

Example

ac('load', 'autotrackInViewport', {
  inViewportEvents: [
    { selector: 'button.bg-green', eventName: 'green_button_element' },
    { selector: 'footer *', eventName: 'footer_element' }
  ]
}, function () {
    console.log('"autotrackInViewport" has been loaded');
});

Config (required)

Description: Identifies an array of elements to track.

Type: Object

Properties: See the following table.

Name Description Type Status
selector String that selects elements. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Element/matches String required
eventName String used as the event name when an element matching the selector moves into or outside the viewport. String required

Example

{
  inViewportEvents: [
    { selector: 'button.bg-green', eventName: 'green_button_element' },
    { selector: 'footer', eventName: 'footer_element' }
  ]
}

Callback

When a module loads, callback is executed. No arguments pass to the callback.

Comments or questions about this documentation? Contact us for support!