Tracking snippet

From Genesys Documentation
Jump to: navigation, search
This topic is part of the manual Altocloud Administrator's Guide for version Current of Altocloud.

Learn how to enable visitor tracking on your website.



Before you begin

Before you deploy the Altocloud 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 Altocloud's tracking capabilities. However, there are a couple considerations if you use uBlock Origin:

  • uBlock Origin disables Altocloud's tracking web beacons; this effectively prevents Altocloud's tracking capabilities.
  • uBlock Origin and uBlock Plus Adblocker block popular tag managers such as Adobe Tag Manager, Google Tag Manager, and more.
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 Altocloud tracking snippet, consider manually placing the tracking snippet directly in the body or header of your website.

Copy the snippet

Altocloud provides a tracking snippet that you can copy and paste. Since you are logged in to Genesys Cloud, 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 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 Altocloud tracking snippet.
  • Deploy the Altocloud 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 Altocloud 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 Altocloud tracking snippet, use your preferred tag manager. For example:

  • 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.
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 Altocloud 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