ATC/Current/SDK/Web tracking API - Revision history

Gayathri.Jaishankar.IX: Published

2022-07-07T09:53:22Z

Published

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

2021-11-09T21:28:53Z

Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

2021-08-10T10:36:18Z

Published

Barbara.martin@genesys.com: Published

2021-04-28T18:29:46Z

Published

Barbara.martin@genesys.com: Published

2021-04-16T16:45:40Z

Published

Barbara.martin@genesys.com: Published

2021-04-13T10:36:07Z

Published

Barbara.martin@genesys.com: Published

2020-12-17T16:00:52Z

Published

Barbara.martin@genesys.com: Published

2020-11-04T13:33:42Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:30:00Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureCloud([\|])" to "|Platform=$1GenesysCloud$2"

2020-07-15T11:59:54Z

Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2"

@@ Line 53: / Line 53: @@
 ac('destroy');
 </source>
 |Status=No
 }}
 }}

@@ Line 8: / Line 8: @@
 |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 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 />
+|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

@@ Line 3: / Line 3: @@
 |DisplayName=Web Tracking API
 |TocName=Web Tracking API
-|Context=Learn how to track visitor activity using an API.{{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud 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.
+|Context=Learn how to track visitor activity using an API.
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=About the Web Tracking API
 |alignment=Vertical

@@ Line 3: / Line 3: @@
 |DisplayName=Web Tracking API
 |TocName=Web Tracking API
-|Context=Learn how to track visitor activity using an API.
+|Context=Learn how to track visitor activity using an API.{{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud 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.
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud

@@ Line 103: / Line 103: @@
 |anchor=Guidelines
 |alignment=Vertical
-|structuredtext={{NoteFormat|Event names cannot exceed 255 characters. You can use any combination of lowercase alphanumeric characters and an underscore. Keep event names short and descriptive. |1}}
+|structuredtext={{NoteFormat|Event names:
 The suggested format for custom event names is: ''<tt>object-delimiter-action</tt>'', where object is the object that was interacted with, and action is the type of interaction that occurred.
 Examples of custom event names include:
@@ Line 115: / Line 117: @@
 *<tt>"address_selected"</tt>
 |Status=No
 }}
 }}

@@ Line 3: / Line 3: @@
 |DisplayName=Web Tracking API
 |TocName=Web Tracking API
-|Context=Learn how to track user activity via an API.
+|Context=Learn how to track visitor activity using an API.
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
@@ Line 9: / Line 9: @@
 |sectionHeading=About the Web Tracking API
 |alignment=Vertical
-|structuredtext=The Web Tracking API lets you track what visitors do on your website. Tracking data is collected through a series of interactions occurring on your website such as pageviews, button clicks, and custom events. These interactions are grouped into visits and act as a container for the actions taken on your website by a specific visitor.
+|structuredtext=The Web Tracking API lets you track what visitors do on your website. Tracking data is collected through a series of interactions occurring on your website such as pageviews, button clicks, and custom events. These interactions are grouped into visits and act as a container for the actions that a specific visitor takes on your website.
-Visits do not have a predefined duration. Depending on your visitor, the visit may be a few seconds or a couple of hours long. A new visit will be created when the visitor has been idle for 30 minutes or more, but they all will be linked to the same visitor.
+Visits do not have a predefined duration. Depending on your visitor, the visit may be a few seconds or a couple of hours long. A new visit is created when the visitor has been idle for 30 minutes or more, but they all are linked to the same visitor.
 |Status=No
 }}{{Section
@@ Line 17: / Line 17: @@
 |anchor=ObtainConsent
 |alignment=Vertical
-|structuredtext={{NoteFormat|To be compliant with GDPR requirements, consider if you need to obtain a visitor's consent before tracking their data. For more information on using {{MintyDocsProduct}} in a GDPR-compliant manner, see {{#mintydocs_link:topic=GDPR|manual=AdminGuide|version=Current|link text=GDPR.}}|1}}
+|structuredtext={{NoteFormat|To achieve compliance with GDPR requirements, consider whether you need to obtain a visitor's consent before tracking their data. For more information on using {{MintyDocsProduct}} in a GDPR-compliant manner, see {{#mintydocs_link:topic=GDPR|manual=AdminGuide|version=Current|link text=GDPR.}}|1}}
+To implement tracking after receiving consent, modify the tracking snippet so that the <tt>`ac('init')`</tt> and <tt>`ac('pageview')`</tt> are only called when consent is given, as shown in the following example:
 <source lang="javascript">
@@ Line 42: / Line 41: @@
 |Status=No
 }}{{Section
-|sectionHeading=Stop tracking if a visitor revokes consent
+|sectionHeading=Stop tracking when a visitor revokes consent
 |anchor=StopTracking
 |alignment=Vertical
@@ Line 55: / Line 54: @@
 |anchor=CollectionMethods
 |alignment=Vertical
-|structuredtext=The Journey JavaScript SDK lets you customize how you collect tracking data for your website. The most basic form of tracking is page view tracking. For page view tracking, {{MINTYDOCSPRODUCT}} records each page a visitor visits. You can also use the Journey JavaScript SDK to record custom visitor activities such as button clicks. For more information see ''Track custom events'', below.
+|structuredtext=The Journey JavaScript SDK lets you customize how you collect tracking data for your website. The most basic form of tracking is page view tracking. For page view tracking, {{MINTYDOCSPRODUCT}} records each page a visitor visits. You can also use the Journey JavaScript SDK to record custom visitor activities such as button clicks. For more information see {{Link-SomewhereInThisVersion|manual=SDK|topic=Web_tracking_API|anchor=record|display text=Track custom events}}.
 |Status=No
 }}{{Section
-|sectionHeading=Track pages viewed by your customers
+|sectionHeading=Track viewed pages
 |alignment=Vertical
-|structuredtext=The <tt>pageview</tt> method tracks the pages viewed by your visitors. To send a <tt>pageview</tt>, call the <tt>ac</tt> function and pass <tt>pageview</tt> as the first argument.
+|structuredtext=The <tt>pageview</tt> method tracks the webpages that your visitors view. To send a <tt>pageview</tt>, call the <tt>ac</tt> function and pass <tt>pageview</tt> as the first argument.
 <source lang="javascript">
 ac('pageview');
@@ Line 69: / Line 68: @@
 |anchor=record
 |alignment=Vertical
-|structuredtext=The <tt>record</tt> method allows you to track custom events, usually as a result of a person interacting with an element or control in your website, for example, the click of a button.
+|structuredtext=The <tt>record</tt> method allows you to track custom events, usually as a result of a person interacting with an element or control in your website. For example, the click of a button.
 The <tt>record</tt> method takes two parameters:
-*The name of the event to record as a string. '''Note:''' See ''Guidelines for custom event names'' below.
+*The name of the event to record as a string. '''Note:''' See {{Link-SomewhereInThisVersion|manual=SDK|topic=Web_tracking_API|anchor=Guidelines|display text=Guidelines for custom event names}}.
 *An (optional) key-value hash of properties for the event.
-*An (optional) callback function that will be invoked when the request is completed.
+*An (optional) callback function that invokes when the request is completed.
-*An (optional) callback timeout, in milliseconds, to configure how long to wait if the event is taking too long to complete. This is useful to capture events (such as file downloads) before navigating to a different page/URL, making sure the visitor is always redirected.
+*An (optional) callback timeout, in milliseconds, to configure how long to wait when the event takes too long to complete. This option is useful to capture events (such as file downloads) before navigating to a different page/URL, ensuring that the visitor is always redirected.
 <source lang="javascript">
@@ Line 81: / Line 81: @@
 </source>
-You may also provide extra metadata with your custom event:
+You can also provide extra metadata with your custom event:
 <source lang="javascript">
 ac('record', 'button_clicked', {
@@ Line 89: / Line 89: @@
 </source>
-The following code sample shows how to record a file downloaded and navigate to the file <tt>URL /files/pricing.pdf</tt> when the event is captured, or after 400 milliseconds:
+The following code sample shows how to record a file download and navigate to the file <tt>URL /files/pricing.pdf</tt> when capturing the event, or after 400 milliseconds:
 <source lang="javascript">
 ac('record', 'file.downloaded', {
@@ Line 101: / Line 101: @@
 }}{{Section
 |sectionHeading=Guidelines for custom event names
 |alignment=Vertical
-|structuredtext={{NoteFormat|Event names must be a maximum of 255 characters. You can use any combination of lowercase alphanumeric characters and an underscore. Keep event names short and descriptive. |1}}
+|structuredtext={{NoteFormat|Event names cannot exceed 255 characters. You can use any combination of lowercase alphanumeric characters and an underscore. Keep event names short and descriptive. |1}}
 The suggested format for custom event names is: ''<tt>object-delimiter-action</tt>'', where object is the object that was interacted with, and action is the type of interaction that occurred.

@@ Line 2: / Line 2: @@
 |Standalone=No
 |DisplayName=Web Tracking API
-|Platform=GenesysEngage-onpremises, PureConnect, GenesysCloud
+|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
 |TocName=Web Tracking API
 |ComingSoon=No

ATC/Current/SDK/Web tracking API - Revision history

Gayathri.Jaishankar.IX: Published

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureCloud([\|])" to "|Platform=$1GenesysCloud$2"