Difference between revisions of "ATC/Current/SDK/Web tracking API"
(Published) |
(Published) |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
|DisplayName=Web Tracking API | |DisplayName=Web Tracking API | ||
|TocName=Web Tracking API | |TocName=Web Tracking API | ||
− | |Context=Learn how to track | + | |Context=Learn how to track visitor activity using an API. |
|ComingSoon=No | |ComingSoon=No | ||
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud | |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=About the Web Tracking API | |sectionHeading=About the Web Tracking API | ||
|alignment=Vertical | |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 | + | |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 | + | 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 | |Status=No | ||
}}{{Section | }}{{Section | ||
Line 17: | Line 21: | ||
|anchor=ObtainConsent | |anchor=ObtainConsent | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext={{NoteFormat|To | + | |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: | |
− | 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 | ||
<source lang="javascript"> | <source lang="javascript"> | ||
Line 42: | Line 45: | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
− | |sectionHeading=Stop tracking | + | |sectionHeading=Stop tracking when a visitor revokes consent |
|anchor=StopTracking | |anchor=StopTracking | ||
|alignment=Vertical | |alignment=Vertical | ||
Line 50: | Line 53: | ||
ac('destroy'); | ac('destroy'); | ||
</source> | </source> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} |
Latest revision as of 09:53, July 7, 2022
Contents
Learn how to track visitor activity using an API.
About the Web Tracking API
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 is created when the visitor has been idle for 30 minutes or more, but they all are linked to the same visitor.
Obtain consent before tracking visitors
To implement tracking after receiving consent, modify the tracking snippet so that the `ac('init')` and `ac('pageview')` are only called when consent is given, as shown in the following example:
(function(a,t,c,l,o,u,d){a['_genesysJourneySdk']=o;a[o]=a[o]||function(){
(a[o].q=a[o].q||[]).push(arguments)},a[o].l=1*new Date();u=t.createElement(c),
d=t.getElementsByTagName(c)[0];u.async=1;u.src=l;u.charset='utf-8';d.parentNode.insertBefore(u,d)
})(window, document, 'script', 'https://apps.inindca.com/journey/sdk/js/web/v1/ac.js', 'ac');
if (consentGiven) {
// Call the ac('init') function to enable tracking
ac('init', 'a061a3fe-7a80-4b50-9d3b-df88c0f9efad', { region: 'use1' });
ac('pageview');
}
You are responsible for setting the value for the `consentGiven` variable based on the visitor's choice.
Enable web tracking
To enable Web tracking on your website, initialize the Tracking SDK and then call the pageview method when a visitor navigates to a new page.
Stop tracking when a visitor revokes consent
If a visitor revokes consent at any point, invoke the destroy command to stop tracking and remove all cookies, as shown in the following example.
// to disable tracking and delete Genesys Predictive Engagement cookies
ac('destroy');