Difference between revisions of "ATC/Current/SDK/autotrackScrollDepth"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2")
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX")
 
(8 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
|DisplayName=autotrackScrollDepth
 
|DisplayName=autotrackScrollDepth
 
|TocName=autotrackScrollDepth
 
|TocName=autotrackScrollDepth
−
|Context=Learn how to configure which scroll milestones {{MINTYDOCSPRODUCT}} tracks on your websites, so you have more accurate page tracking information for use in segments and outcomes.
+
|Context=Learn how to configure which scroll milestones {{MINTYDOCSPRODUCT}} tracks on your websites. This configuration provides more accurate page tracking information for use in segments and outcomes.
 
|Dimension=Modules
 
|Dimension=Modules
 
|ComingSoon=No
 
|ComingSoon=No
−
|Platform=GenesysEngage-onpremises, PureConnect, PureCloud
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Section={{Section
 
|Section={{Section
 +
|alignment=Vertical
 +
|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud CX customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
 +
|Status=No
 +
}}{{Section
 
|sectionHeading=Description
 
|sectionHeading=Description
 
|anchor=Description
 
|anchor=Description
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=The <code>autotrackScrollDepth</code> module tracks when the user scrolls to see a specific percentage of a webpage. To use <code>autotrackScrollDepth</code>, use the following options to configure the click events that you want to track:
+
|structuredtext=The <code>autotrackScrollDepth</code> module tracks when a visitor scrolls to see a specific percentage of a webpage. To use <code>autotrackScrollDepth</code>, configure the click events to track using the following options:
  
−
*Config
+
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackScrollDepth|anchor=Config|display text=Config}}
−
*Callback
+
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackScrollDepth|anchor=Callback|display text=Callback}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 43: Line 47:
 
|anchor=Config
 
|anchor=Config
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=Description: identifies an array of scroll depths that should be tracked.
+
|structuredtext='''Description:''' Identifies an array of scroll depths to track.
  
−
Type: object
+
'''Type:''' Object
  
−
Properties:
+
'''Properties:''' See the following table.
 
{{{!}} class="wikitable" role="grid"
 
{{{!}} class="wikitable" role="grid"
 
! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" scope="col" role="columnheader" aria-label="Name: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Name
 
! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" scope="col" role="columnheader" aria-label="Name: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Name
Line 56: Line 60:
 
{{!}}- role="row"
 
{{!}}- role="row"
 
{{!}} class="confluenceTd"{{!}}percentage
 
{{!}} class="confluenceTd"{{!}}percentage
−
{{!}} class="confluenceTd"{{!}}A string that selects elements. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Element/matches
+
{{!}} class="confluenceTd"{{!}}String that selects elements. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Element/matches
 
{{!}} class="confluenceTd"{{!}}Number (0 - 100)
 
{{!}} class="confluenceTd"{{!}}Number (0 - 100)
 
{{!}} class="confluenceTd"{{!}}required
 
{{!}} class="confluenceTd"{{!}}required
Line 62: Line 66:
 
{{!}}- role="row"
 
{{!}}- role="row"
 
{{!}} class="confluenceTd"{{!}}eventName
 
{{!}} class="confluenceTd"{{!}}eventName
−
{{!}} class="confluenceTd"{{!}}is a string that will be used as the event name when an element matching the selector is clicked.
+
{{!}} class="confluenceTd"{{!}}String used as the event name when an element matching the selector is clicked.
 
{{!}} class="confluenceTd"{{!}}String
 
{{!}} class="confluenceTd"{{!}}String
 
{{!}} class="confluenceTd"{{!}}optional
 
{{!}} class="confluenceTd"{{!}}optional
Line 84: Line 88:
 
|anchor=Callback
 
|anchor=Callback
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=When a module fully loads, callback is executed. No arguments are passed to the callback.
+
|structuredtext=When a module loads, callback is executed. No arguments pass to the callback.
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 21:28, November 9, 2021

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

Learn how to configure which scroll milestones Genesys Predictive Engagement tracks on your websites. This configuration provides more 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 autotrackScrollDepth module tracks when a visitor scrolls to see a specific percentage of a webpage. To use autotrackScrollDepth, configure the click events to track using the following options:

Signature

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

Example

ac('load', 'autotrackScrollDepth', {
  scrollDepthEvents: [
    { percentage: 75, eventName: 'scroll_depth_75' },
    { percentage: 100, eventName: 'scroll_depth_100' }
  ]
}, function () {
    console.log('"autotrackScrollDepth" has been loaded');
});

Config (required)

Description: Identifies an array of scroll depths to track.

Type: Object

Properties: See the following table.

Name Description Type Status Default
percentage String that selects elements. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Element/matches Number (0 - 100) required NA
eventName String used as the event name when an element matching the selector is clicked. String optional scroll_depth_<percentage>

eg if "percentage" = 75, eventName defaults to "scroll_depth_75"

Example

{
  scrollDepthEvents: [
    { percentage: 50 },
    { percentage: 100, eventName: 'viewed_full_page' },
  ]
}

Callback (optional)

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

Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/autotrackScrollDepth (2025-06-22 04:55:29)"
Comments or questions about this documentation? Contact us for support!