Difference between revisions of "ATC/Current/AdminGuide/Tracking snippet"

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 23: Line 23:
 
#{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|display text=Configure web tracking.}}
 
#{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|display text=Configure web tracking.}}
 
{{NoteFormat|See a solutions article that includes the tracking snippet: {{#mintydocs_link:topic=Solution/ChatSolutions|standalone}}|2}}
 
{{NoteFormat|See a solutions article that includes the tracking snippet: {{#mintydocs_link:topic=Solution/ChatSolutions|standalone}}|2}}
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 28: Line 30:
 
|anchor=BeforeYouBegin
 
|anchor=BeforeYouBegin
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext=Before you deploy the {{MINTYDOCSPRODUCT}} tracking snippet be sure you understand:
 
|structuredtext=Before you deploy the {{MINTYDOCSPRODUCT}} tracking snippet be sure you understand:
  
Line 33: Line 37:
 
*How to deploy the tracking snippet to be compliant with {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=GDPR}}.
 
*How to deploy the tracking snippet to be compliant with {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=GDPR}}.
 
*The effect of {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=AdBlockers|display text=ad blockers}} on {{MINTYDOCSPRODUCT}}.
 
*The effect of {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=AdBlockers|display text=ad blockers}} on {{MINTYDOCSPRODUCT}}.
 +
*How to {{Link-Standalone|topic=ATC/GPEandWidgets|display text=prepare widgets for use with {{MINTYDOCSPRODUCT}}}}.
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 38: Line 45:
 
|anchor=AdBlockers
 
|anchor=AdBlockers
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext=Ad blockers are plug-ins or browser extensions that improve page load times and minimize questionable tracking. The majority of ad blockers tested with out-of-the-box settings do not interfere with {{MINTYDOCSPRODUCT}}'s tracking capabilities. However, there are a couple considerations if you use uBlock Origin:   
 
|structuredtext=Ad blockers are plug-ins or browser extensions that improve page load times and minimize questionable tracking. The majority of ad blockers tested with out-of-the-box settings do not interfere with {{MINTYDOCSPRODUCT}}'s tracking capabilities. However, there are a couple considerations if you use uBlock Origin:   
  
Line 46: Line 55:
  
 
Also, instead of using tag a manager to deploy the {{MINTYDOCSPRODUCT}} tracking snippet, consider manually placing the tracking snippet directly in the body or header of your website.|}}
 
Also, instead of using tag a manager to deploy the {{MINTYDOCSPRODUCT}} tracking snippet, consider manually placing the tracking snippet directly in the body or header of your website.|}}
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 51: Line 62:
 
|anchor=GetSnippet
 
|anchor=GetSnippet
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext={{MINTYDOCSPRODUCT}} provides a tracking snippet that you can copy and paste. Since you are logged in to PureCloud, the tracking snippet already contains your organization ID and region.
 
|structuredtext={{MINTYDOCSPRODUCT}} provides a tracking snippet that you can copy and paste. Since you are logged in to PureCloud, the tracking snippet already contains your organization ID and region.
  
Line 60: Line 73:
 
#Click '''Copy Snippet'''.
 
#Click '''Copy Snippet'''.
 
#For information on where to paste the snippet, read {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeploySnippet|display text=Deploy the snippet}}. <br />
 
#For information on where to paste the snippet, read {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeploySnippet|display text=Deploy the snippet}}. <br />
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 65: Line 80:
 
|anchor=TypesofSnippets
 
|anchor=TypesofSnippets
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext====Website snippet===
 
|structuredtext====Website snippet===
 
The Website snippet provides tracking support to traditional webpages that contain little or no dynamic content. Traditional websites load a new HTML page whenever the user navigates to a different URL. To provide tracking support to traditional webpages, the Website snippet calls <tt>{{Link-SomewhereInThisVersion|manual=SDK|topic=Pageview|display text=ac('pageview')}}</tt> each time the a new page is loaded by the web browser.
 
The Website snippet provides tracking support to traditional webpages that contain little or no dynamic content. Traditional websites load a new HTML page whenever the user navigates to a different URL. To provide tracking support to traditional webpages, the Website snippet calls <tt>{{Link-SomewhereInThisVersion|manual=SDK|topic=Pageview|display text=ac('pageview')}}</tt> each time the a new page is loaded by the web browser.
 
===SPA snippet===
 
===SPA snippet===
 
The SPA snippet can track activity on Single Page Applications (SPAs). SPAs load dynamic content on demand without requiring a hard reload of the HTML page. The SPA snippet can also track when users click relative links, which the Website snippet does not. The SPA snippet works on SPAs such as Angular, React, Vue.js, and so on. For more information about the additional tracking options available with the SPA snippet, see {{Link-SomewhereInThisVersion|manual=SDK|topic=autoTrackURLChange}}.
 
The SPA snippet can track activity on Single Page Applications (SPAs). SPAs load dynamic content on demand without requiring a hard reload of the HTML page. The SPA snippet can also track when users click relative links, which the Website snippet does not. The SPA snippet works on SPAs such as Angular, React, Vue.js, and so on. For more information about the additional tracking options available with the SPA snippet, see {{Link-SomewhereInThisVersion|manual=SDK|topic=autoTrackURLChange}}.
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 74: Line 93:
 
|anchor=SnippetRecs
 
|anchor=SnippetRecs
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext={{{!}} class="wikitable" style="font-size: 14px;"
 
|structuredtext={{{!}} class="wikitable" style="font-size: 14px;"
 
{{!}}-
 
{{!}}-
Line 88: Line 109:
 
{{!}}{{!}}Website
 
{{!}}{{!}}Website
 
{{!}}}
 
{{!}}}
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 93: Line 116:
 
|anchor=Customize
 
|anchor=Customize
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext=If needed, you can customize how the snippet tracks activity on your website:
 
|structuredtext=If needed, you can customize how the snippet tracks activity on your website:
  
Line 99: Line 124:
 
**{{Link-SomewhereInThisVersion|manual=SDK|display text=Use the Journey JavaScript SDK to track page view events and to configure how Altocloud updates cookies. }}
 
**{{Link-SomewhereInThisVersion|manual=SDK|display text=Use the Journey JavaScript SDK to track page view events and to configure how Altocloud updates cookies. }}
 
**{{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking|display text=Configure advanced tracking to enable tracking across multiple domains.}}
 
**{{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking|display text=Configure advanced tracking to enable tracking across multiple domains.}}
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 104: Line 131:
 
|anchor=DeploySnippet
 
|anchor=DeploySnippet
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext={{NoteFormat|The {{MINTYDOCSPRODUCT}} tracking snippet loads JavaScript asynchronously without slowing down page loading. For more details about how the tracking snippet works, see {{Link-SomewhereInThisVersion|manual=SDK|topic=About_the_tracking_snippet}}. }}
+
|Media=
−
 
+
|image=
−
After you {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=GetSnippet|display text=copy the snippet}}, review the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeploymentNotes|display text=deployment notes}}.  
+
|structuredtext=After you {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=GetSnippet|display text=copy the snippet}}, review the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeploymentNotes|display text=deployment notes}}.  
 
Then follow the instructions to deploy the tracking snippet:
 
Then follow the instructions to deploy the tracking snippet:
  
 
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=TagManagers|display text=Deploy the snippet with a tag manager.}}
 
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=TagManagers|display text=Deploy the snippet with a tag manager.}}
 
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeployManually|display text=Deploy the snippet manually.}}
 
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeployManually|display text=Deploy the snippet manually.}}
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 116: Line 145:
 
|anchor=DeploymentNotes
 
|anchor=DeploymentNotes
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=*Deploy the {{MINTYDOCSPRODUCT}} tracking snippet on the main window of the website you want to track.
+
|Media=
 +
|image=
 +
|structuredtext=*{{Link-Standalone|topic=ATC/GPEandWidgets|display text=Deploy the widgets transport}} above the location where you deploy the {{MINTYDOCSPRODUCT}} tracking snippet.
 +
*Deploy the {{MINTYDOCSPRODUCT}} tracking snippet on the main window of the website you want to track.
 
*Paste the tracking snippet in the head section of the website template page before the closing tag.
 
*Paste the tracking snippet in the head section of the website template page before the closing tag.
 
*Do not deploy the tracking snippet in an iframe.
 
*Do not deploy the tracking snippet in an iframe.
 +
*The {{MINTYDOCSPRODUCT}} tracking snippet loads JavaScript asynchronously without slowing down page loading. For more details about how the tracking snippet works, see {{Link-SomewhereInThisVersion|manual=SDK|topic=About_the_tracking_snippet}}.
 +
 +
<br />
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 124: Line 161:
 
|anchor=TagManagers
 
|anchor=TagManagers
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext=To easily deploy the {{MINTYDOCSPRODUCT}} tracking snippet, use your preferred tag manager. For example:
 
|structuredtext=To easily deploy the {{MINTYDOCSPRODUCT}} tracking snippet, use your preferred tag manager. For example:
  
Line 130: Line 169:
 
*Any other tag manager
 
*Any other tag manager
  
−
{{NoteFormat|uBlock and other ad blocking software is known to block tag managers, in which case the tracking snippet deployed through the tag manager would also be blocked. For more information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=AdBlockers|display text=Ad blockers}}.|}}
+
{{NoteFormat|
 +
*Deploy the widgets transport above the location where you deploy the Altocloud tracking snippet.
 +
*uBlock and other ad blocking software is known to block tag managers, in which case the tracking snippet deployed through the tag manager would also be blocked. For more information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=AdBlockers|display text=Ad blockers}}.|}}
 +
|structuredtextwide=
 
|FAQHeading=Can I use a tag management system to deploy the tracking snippet?
 
|FAQHeading=Can I use a tag management system to deploy the tracking snippet?
 
|Status=No
 
|Status=No
Line 137: Line 179:
 
|anchor=DeployManually
 
|anchor=DeployManually
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext=#'''Admin''' > '''Altocloud''' > '''Tracking Snippet'''.
 
|structuredtext=#'''Admin''' > '''Altocloud''' > '''Tracking Snippet'''.
 
#Next to the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=TypesofSnippets|display text=type of snippet}} you need, click '''Copy''' snippet.
 
#Next to the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=TypesofSnippets|display text=type of snippet}} you need, click '''Copy''' snippet.
 
#Before you paste the snippet on your website, review the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeploymentNotes|display text=deployment notes}}.
 
#Before you paste the snippet on your website, review the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeploymentNotes|display text=deployment notes}}.
 +
{{NoteFormat|Deploy the widgets transport above the location where you deploy the Altocloud tracking snippet.
 +
|}}<br />
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 145: Line 193:
 
|anchor=VerifySnippet
 
|anchor=VerifySnippet
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext=When the tracking snippet is properly executed and initialized:
 
|structuredtext=When the tracking snippet is properly executed and initialized:
  
 
*Use Live Now to verify that {{MINTYDOCSPRODUCT}} is tracking your website activity.
 
*Use Live Now to verify that {{MINTYDOCSPRODUCT}} is tracking your website activity.
 
*You should see an update every 4-5 seconds.<br />
 
*You should see an update every 4-5 seconds.<br />
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 154: Line 206:
 
|anchor=TroubleshootSnippet
 
|anchor=TroubleshootSnippet
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=If the tracking snippet does not work properly when you load it on your web pages, check the following things:
+
|Media=
 +
|image=
 +
|structuredtext=If the tracking snippet does not work properly when you load your web pages, check the following things:
  
 
*Is the snippet on the correct page?
 
*Is the snippet on the correct page?
Line 164: Line 218:
  
 
For more suggestions, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeploymentNotes|display text=Deployment notes}}.<br />
 
For more suggestions, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=DeploymentNotes|display text=Deployment notes}}.<br />
 +
|structuredtextwide=
 
|FAQHeading=How can I troubleshoot the tracking snippet?
 
|FAQHeading=How can I troubleshoot the tracking snippet?
 
|Status=No
 
|Status=No
Line 170: Line 225:
 
|anchor=ErrorSnippet
 
|anchor=ErrorSnippet
 
|alignment=Vertical
 
|alignment=Vertical
 +
|Media=
 +
|image=
 
|structuredtext={{{!}} class="wikitable" style="height: 266px;" width="865" data-mce-style="height: 266px;"
 
|structuredtext={{{!}} class="wikitable" style="height: 266px;" width="865" data-mce-style="height: 266px;"
 
{{!}}-
 
{{!}}-
Line 195: Line 252:
 
*Dashes and quotes in URLs replaced with printable equivalents<br />
 
*Dashes and quotes in URLs replaced with printable equivalents<br />
 
{{!}}}
 
{{!}}}
 +
|structuredtextwide=
 +
|FAQHeading=
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 12:53, June 9, 2020

This topic is part of the manual Genesys Predictive Engagement Administrator's Guide for version Current of Genesys Predictive Engagement.

Learn how to enable visitor tracking on your website.

Prerequisites

Overview

  1. Review Before you begin.
  2. Copy the snippet.
  3. Optionally customize the snippet.
  4. Deploy the snippet.
  5. Verify that the snippet works.
  6. Configure web tracking.
Tip
See a solutions article that includes the tracking snippet: Genesys Predictive Engagement with advanced chat routing

Before you begin

Before you deploy the Genesys Predictive Engagement tracking snippet be sure you understand:

Ad blockers

Ad blockers are plug-ins or browser extensions that improve page load times and minimize questionable tracking. The majority of ad blockers tested with out-of-the-box settings do not interfere with Genesys Predictive Engagement's tracking capabilities. However, there are a couple considerations if you use uBlock Origin:

  • uBlock Origin disables Genesys Predictive Engagement's tracking web beacons; this effectively prevents Genesys Predictive Engagement's tracking capabilities.
  • uBlock Origin and uBlock Plus Adblocker block popular tag managers such as Adobe Tag Manager, Google Tag Manager, and more.
Important
If you use a tag manager to manage JavaScript and tracking on your website, consider adding ad blocker detection to your site in order to notify your users with detected ad blockers that they may be missing some important functionality. Also, instead of using tag a manager to deploy the Genesys Predictive Engagement tracking snippet, consider manually placing the tracking snippet directly in the body or header of your website.

Copy the snippet

Genesys Predictive Engagement provides a tracking snippet that you can copy and paste. Since you are logged in to PureCloud, the tracking snippet already contains your organization ID and region.

  1. Click Admin.
  2. Under Altocloud, click Tracking Snippet.
  3. To determine which snippet to use:
  4. Click Copy Snippet.
  5. For information on where to paste the snippet, read Deploy the snippet.

Types of tracking snippets

Website snippet

The Website snippet provides tracking support to traditional webpages that contain little or no dynamic content. Traditional websites load a new HTML page whenever the user navigates to a different URL. To provide tracking support to traditional webpages, the Website snippet calls ac('pageview') each time the a new page is loaded by the web browser.

SPA snippet

The SPA snippet can track activity on Single Page Applications (SPAs). SPAs load dynamic content on demand without requiring a hard reload of the HTML page. The SPA snippet can also track when users click relative links, which the Website snippet does not. The SPA snippet works on SPAs such as Angular, React, Vue.js, and so on. For more information about the additional tracking options available with the SPA snippet, see [[ATC/Current/SDK/autoTrackURLChange|]].

Snippet recommendations

If you have this type of website... Use this snippet...
Not sure SPA
Mix of traditional and SPA pages SPA
Traditional pages only Website

Customize how the snippet tracks activity (optional)

If needed, you can customize how the snippet tracks activity on your website:

Deploy the snippet

After you copy the snippet, review the deployment notes. Then follow the instructions to deploy the tracking snippet:

Deployment notes

  • Deploy the widgets transport above the location where you deploy the Genesys Predictive Engagement tracking snippet.
  • Deploy the Genesys Predictive Engagement tracking snippet on the main window of the website you want to track.
  • Paste the tracking snippet in the head section of the website template page before the closing tag.
  • Do not deploy the tracking snippet in an iframe.
  • The Genesys Predictive Engagement tracking snippet loads JavaScript asynchronously without slowing down page loading. For more details about how the tracking snippet works, see About the tracking snippet.


Deploy the snippet with a tag manager

To easily deploy the Genesys Predictive Engagement tracking snippet, use your preferred tag manager. For example:

Important
  • Deploy the widgets transport above the location where you deploy the Altocloud tracking snippet.
  • uBlock and other ad blocking software is known to block tag managers, in which case the tracking snippet deployed through the tag manager would also be blocked. For more information, see Ad blockers.

Deploy the snippet manually

  1. Admin > Altocloud > Tracking Snippet.
  2. Next to the type of snippet you need, click Copy snippet.
  3. Before you paste the snippet on your website, review the deployment notes.
Important
Deploy the widgets transport above the location where you deploy the Altocloud tracking snippet.

Verify that the snippet works

When the tracking snippet is properly executed and initialized:

  • Use Live Now to verify that Genesys Predictive Engagement is tracking your website activity.
  • You should see an update every 4-5 seconds.

Troubleshoot the snippet

If the tracking snippet does not work properly when you load your web pages, check the following things:

  • Is the snippet on the correct page?
  • Is the snippet correctly placed in the header?
  • Are all of the parameters specified correctly?
  • Are there any typos, missing characters, or extra white space?
  • Have any characters been replaced by their printable equivalents?
  • Is the domain on the list of allowed domains?

For more suggestions, see Deployment notes.

Error reference

Error code Description
403 error Is your domain in the list of allowed domains?
404 error Is there extra white space in the snippet?

Note: In a URL, white space is encoded as %20.

Bad request Is there extra white space in the snippet?

Note: In a URL, white space is encoded as %20.

Initialization error Are there any of the following in the snippet:
  • Typos
  • Missing characters
  • Dashes and quotes in URLs replaced with printable equivalents
Retrieved from "https://all.docs.genesys.com/ATC/Current/AdminGuide/Tracking_snippet (2025-06-22 10:03:37)"
Comments or questions about this documentation? Contact us for support!