Difference between revisions of "ATC/Current/AdminGuide/Web tracking"

From Genesys Documentation
Jump to: navigation, search
(Published)
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX")
 
(11 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
|DisplayName=Web tracking
 
|DisplayName=Web tracking
 
|TocName=Web tracking
 
|TocName=Web tracking
|Context=Configure how {{MINTYDOCSPRODUCT}} tracks your visitors as they move through your website.
+
|Context=Configure how {{MINTYDOCSPRODUCT}} tracks visitors as they move through your website.
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Prereq='''Prerequisites'''
 
|Prereq='''Prerequisites'''
  
*[https://help.mypurecloud.com/articles/altocloud-permissions-overview Configure the following permissions in Genesys Cloud:]
+
*[https://help.mypurecloud.com/articles/?p=195191 Configure the following permissions in Genesys Cloud CX:]
 
**'''Journey '''>''' Settings''' > '''Edit''', or '''View'''
 
**'''Journey '''>''' Settings''' > '''Edit''', or '''View'''
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|display text=Deploy the tracking snippet.}}
+
*Deploy one of the following:
 +
**For Genesys Cloud CX customers using web messaging, {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Messenger_configuration|display text=configure and deploy Genesys Messenger}}.
 +
**For all other customers, {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|display text=deploy the tracking snippet}}.
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Configure web tracking
 
|sectionHeading=Configure web tracking
Line 17: Line 19:
 
|Media=Image
 
|Media=Image
 
|image=WebTracking.png
 
|image=WebTracking.png
|structuredtext=#In Admin in Genesys Cloud, open the '''Web Tracking''' page.
+
|structuredtext=#In Admin in Genesys Cloud CX, open the '''Global Settings''' page and then click the '''Tracking Settings''' tab.
 
#Specify the [[#AllowedDomains|allowed domains]].{{NoteFormat|Initially, configure only the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|anchor=AllowedDomains|display text=allowed domains}}. Then use {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=Live_Now}} to verify that {{MINTYDOCSPRODUCT}} is tracking events.  After basic tracking works, configure the rest of the web tracking settings.|2}}
 
#Specify the [[#AllowedDomains|allowed domains]].{{NoteFormat|Initially, configure only the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|anchor=AllowedDomains|display text=allowed domains}}. Then use {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=Live_Now}} to verify that {{MINTYDOCSPRODUCT}} is tracking events.  After basic tracking works, configure the rest of the web tracking settings.|2}}
 
#Specify any {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|anchor=ExcludeIPAddressesses|display text=excluded IP addresses}}.
 
#Specify any {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|anchor=ExcludeIPAddressesses|display text=excluded IP addresses}}.
 
#Specify the [[#ShortIDLength|short ID length]].
 
#Specify the [[#ShortIDLength|short ID length]].
#Specify any [[#ExcludeURLQueryParameters|URL query parameters]] that {{MINTYDOCSPRODUCT}} should ignore.
+
#Specify any [[#ExcludeURLQueryParameters|URL query parameters]] for {{MINTYDOCSPRODUCT}} to ignore.
 
#Indicate whether {{MINTYDOCSPRODUCT}} should [[#KeepURLFrag|keep URL fragments]].
 
#Indicate whether {{MINTYDOCSPRODUCT}} should [[#KeepURLFrag|keep URL fragments]].
 
#Specify any [[#SiteSearchSettings|site search settings]].
 
#Specify any [[#SiteSearchSettings|site search settings]].
Line 32: Line 34:
 
|Media=Image
 
|Media=Image
 
|image=AllowedDomains.png
 
|image=AllowedDomains.png
|structuredtext=Identify the website domains that you want to accept web traffic from.
+
|structuredtext={{NoteFormat|1=To configure the allowed domains if you are a Genesys Cloud CX customer using {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}}, see "Restrict domain access" in the [https://help.mypurecloud.com/articles/?p=239328 Deploy Messenger] article in the Genesys Cloud CX Resource Center.|2=}}
  
{{NoteFormat|
+
Identify the website domains from which to accept web traffic.
* Include only domain and sub-domain labels. Do not include additional /paths after the domain.
+
 
 +
{{NoteFormat| 
 +
* Include only domain and sub-domain labels. Do not include other "/paths" after the domain.
 
* {{MINTYDOCSPRODUCT}} validates your domain entries and, if any are incorrect, displays an error message.   
 
* {{MINTYDOCSPRODUCT}} validates your domain entries and, if any are incorrect, displays an error message.   
* '''NEW:''' This list of allowed domains should match the {{Link-Standalone|topic=ATC/GPEandWidgets|anchor=Genesys CloudNotes|display text=list of allowed domains for the widget}}.|}}<br />
+
* '''NEW:''' This list of allowed domains should match the {{Link-Standalone|topic=ATC/GPEandWidgets|anchor=Genesys Cloud CXNotes|display text=list of allowed domains for the widget}}.|}}<br />
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 45: Line 49:
 
|Media=GIF
 
|Media=GIF
 
|image=ExIP1.gif
 
|image=ExIP1.gif
|structuredtext=You can designate IP addresses for which {{MINTYDOCSPRODUCT}} should not generate web events. For example, when you don't want to track visits from internal users.
+
|structuredtext=You can designate IP addresses for which you don't want {{MINTYDOCSPRODUCT}} to generate web events. For example, when you don't want to track visits from internal users.
  
{{NoteFormat|
+
{{NoteFormat|&nbsp;
* This feature works in addition to whatever blocking your corporate IT department does to block external traffic from competitors, robo-spammers, and so on.
+
* This feature works in addition to whatever blocking your corporate IT department does to block external traffic (for example, from competitors, robo-spammers).
 
*You can add up to 10 IP filters.
 
*You can add up to 10 IP filters.
 
* If you are not sure what IP addresses to exclude, check with your network administrator and watch incoming traffic on your website logs.
 
* If you are not sure what IP addresses to exclude, check with your network administrator and watch incoming traffic on your website logs.
Line 115: Line 119:
 
Choose a short ID length that is long enough to be unique among all visitors that are active on your website currently. The more traffic your site gets, the longer your short ID should be. For example, if you always have less than 10,000 visitors at any time, a short ID length of 4 will suffice. If you could have more than 100,000 visitors at any one time, choose a short ID length of 6.
 
Choose a short ID length that is long enough to be unique among all visitors that are active on your website currently. The more traffic your site gets, the longer your short ID should be. For example, if you always have less than 10,000 visitors at any time, a short ID length of 4 will suffice. If you could have more than 100,000 visitors at any one time, choose a short ID length of 6.
  
{{NoteFormat|You can increase the length of the short ID at any time. Your changes take effect immediately. |1}}
+
{{NoteFormat|You can increase the length of the short ID at any time. Your changes are effective immediately. |1}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 141: Line 145:
 
|Media=Video
 
|Media=Video
 
|image=397266176
 
|image=397266176
|structuredtext=Each time a user searches your site, the URL for your webpage changes. Since {{MintyDocsProduct}} tracks URL changes, the information about each user's specific searches can appear as part of the customer's journey data. You can see this information in {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Live_Now}} under {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Searches_performed|display text=Searches performed}}. Your agents have a similar view.   
+
|structuredtext=Each time a visitor searches your site, the URL for your webpage changes. Since {{MintyDocsProduct}} tracks URL changes, the information about each visitor's specific searches can appear as part of the customer journey data. You can see this information in {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Live_Now}} under {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Searches_performed|display text=Searches performed}}. Your agents have a similar view.   
  
To configure, in the '''Site search settings''' box type the URL parameter for search terms on your website. For example, suppose that when a customer searches for "Sale," the string, “?term=Sale#search” appends to the end of your URL. In this case, type '''term''' in the '''Site search settings''' box.{{NoteFormat|If you do not know your URL parameter for search terms, try searching for something on your website. Then note what appears when the URL changes.|2}}
+
To configure, in the '''Site search settings''' box type the URL parameter for search terms on your website. For example, suppose that when a visitor searches for "Sale," the string, “?term=Sale#search” appends to the end of your URL. In this case, type '''term''' in the '''Site search settings''' box.{{NoteFormat|If you do not know your URL parameter for search terms, try searching for something on your website. Then note what appears when the URL changes.|2}}
  
 
<br />
 
<br />

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

Configure how Genesys Predictive Engagement tracks visitors as they move through your website.

Prerequisites

Configure web tracking

  1. In Admin in Genesys Cloud CX, open the Global Settings page and then click the Tracking Settings tab.
  2. Specify the allowed domains.
    Tip
    Initially, configure only the allowed domains. Then use Live Now to verify that Genesys Predictive Engagement is tracking events. After basic tracking works, configure the rest of the web tracking settings.
  3. Specify any excluded IP addresses.
  4. Specify the short ID length.
  5. Specify any URL query parameters for Genesys Predictive Engagement to ignore.
  6. Indicate whether Genesys Predictive Engagement should keep URL fragments.
  7. Specify any site search settings.
  8. Save your changes.

Allowed domains

Important
To configure the allowed domains if you are a Genesys Cloud CX customer using web messaging, see "Restrict domain access" in the Deploy Messenger article in the Genesys Cloud CX Resource Center.

Identify the website domains from which to accept web traffic.

Important
 
  • Include only domain and sub-domain labels. Do not include other "/paths" after the domain.
  • Genesys Predictive Engagement validates your domain entries and, if any are incorrect, displays an error message.
  • NEW: This list of allowed domains should match the list of allowed domains for the widget.

Exclude IP addresses

You can designate IP addresses for which you don't want Genesys Predictive Engagement to generate web events. For example, when you don't want to track visits from internal users.

Important
 
  • This feature works in addition to whatever blocking your corporate IT department does to block external traffic (for example, from competitors, robo-spammers).
  • You can add up to 10 IP filters.
  • If you are not sure what IP addresses to exclude, check with your network administrator and watch incoming traffic on your website logs.
  • IP filtering works only when Genesys Predictive Engagement processes web beacons. Therefore, you cannot use this setting to block Genesys Predictive Engagement's tracking of custom events.

To block an IP address, add it to the list of IP addresses to exclude.

IP filter: Specify either a single IP address or use CIDR notation to specify a range of IP addresses.

  • Genesys Predictive Engagement supports both IPv4 and IPv6 protocols. For IPv6, Genesys Predictive Engagement supports the shorthand and expanded version.
  • IP examples

Reference name for the IP filter: Specify a recognizable name for the IP address.

Tip
To see the implied CIDR range of the IP address that you provided, rest your mouse on it.

IP examples

Valid IP addresses (IPv4)

Valid IPv4 CIDR input follows the format: <A valid IPv4 address>/<A number from 0-32>.

Good examples Bad examples
  • 10.10.10.10/8
  • 10.10.10.10/16
  • 10.10.10.10/24
  • 10.10.10.10/32
  • 10.10.10.10/33 (the max for IPv4 is /32)
  • 10.10.10.10/-1 (cannot be a negative number)
  • 10.10.10.10/.10 (must be a whole number)
  • 10.10.10.10/& (no special characters allowed)
  • 10.10.10.10/8/16 (only 1 slash allowed)

Valid IP addresses (IPv6)

Valid IPv6 CIDR input follows the format: <A valid IPv6 address>/<A number from 0-128>.

Good examples Bad examples
  •  ::1/32
  •  ::1/64
  •  ::1/128
  •  ::1/129 (the max for IPv6 is /128)
  •  ::1/-1 (cannot be a negative number)
  •  ::1/.10 (must be a whole number)
  •  ::1/& (no special characters allowed)
  •  ::1/128/64 (only 1 slash allowed)

Short ID length

Genesys Predictive Engagement assigns each visit a unique number based on a lengthy, automatically-generated ID. In the Short ID box, specify the number of digits for Genesys Predictive Engagement to use for each visit ID.

Choose a short ID length that is long enough to be unique among all visitors that are active on your website currently. The more traffic your site gets, the longer your short ID should be. For example, if you always have less than 10,000 visitors at any time, a short ID length of 4 will suffice. If you could have more than 100,000 visitors at any one time, choose a short ID length of 6.

Important
You can increase the length of the short ID at any time. Your changes are effective immediately.

Exclude URL query parameters

Specify any URL Query Parameters for Genesys Predictive Engagement to ignore. URL query parameters appear near the end of URLs. They can lead to overly-specific tracking data. They also have the potential to expose personally identifiable information, which violates GDPR.

Keep URL fragments

You can configure whether Genesys Predictive Engagement uses URL fragments to identify web pages.

URL fragments appear after a URL. For example, in "predictive-engagement.com#pagename", #pagename is a URL fragment.

While URL fragments can identify specific webpages, they also have the potential to expose personally identifiable information, which violates GDPR. They can also result in an excess amount of tracking data.

Important
Unless you want to track the URL fragments, do not enable this option.

Site search settings

Each time a visitor searches your site, the URL for your webpage changes. Since Genesys Predictive Engagement tracks URL changes, the information about each visitor's specific searches can appear as part of the customer journey data. You can see this information in Live Now under Searches performed. Your agents have a similar view.

To configure, in the Site search settings box type the URL parameter for search terms on your website. For example, suppose that when a visitor searches for "Sale," the string, “?term=Sale#search” appends to the end of your URL. In this case, type term in the Site search settings box.
Tip
If you do not know your URL parameter for search terms, try searching for something on your website. Then note what appears when the URL changes.

Comments or questions about this documentation? Contact us for support!