Google Analytics is an analytics tool that helps you understand and analyze your web traffic. The Web Widget (Classic) supports reporting of widget events and channel events including Chat, help center, Talk, Contact, and Ticket Forms in Google Analytics. This provides insights into how your users are interacting with the widget.
This article describes the events tracked in the widget, setting up event reporting, and viewing event reports in Google Analytics.
- Enabling Web Widget (Classic) event reporting for Google Analytics
- Viewing Web Widget (Classic) event data on Google Analytics
- Disabling Web Widget (Classic) event reporting for Google Analytics
- Reported widget events
Related information:
- Analytics API setting
- Customizing Web Widget (Classic) events tracking to third-party analytics services
- Adding the Web Widget (Classic) to your website or help center
- Quickstart Web Widget (Classic) JavaScript APIs
Enabling Web Widget (Classic) event reporting for Google Analytics
By default, the Web Widget (Classic) detects if Google Analytics is present on your web page. When the Google Analytics tag is on your web page, the widget automatically starts reporting events to Google Analytics.
To set up Google Analytics on your web page
- Set up a web property in your Google Analytics account.
- Paste the analytics tag to each web page with the embedded widget.
Viewing Web Widget (Classic) event data on Google Analytics
You can view and filter widget event data in your Google Analytics account.
To access the event data on Google Analytics
- Sign in to your Google Analytics account.
- On the left sidebar, select Behavior > Events > Top Events.
- Under Event Category, select Zendesk Web Widget.
Disabling Web Widget (Classic) event reporting for Google Analytics
The analytics setting API is used to disable the automatic Web Widget (Classic) event tracking for Google Analytics.
- To each webpage with the widget, add the analytics setting script set to false. Make sure it is before the widget code snippet in the body element.<script type="text/javascript"> window.zESettings = { analytics: false }; </script> <!-- Start of your_subdomain Zendesk Widget script --> <script id="ze-snippet" src="//static.zdassets.com/ekr/{YOUR_SNIPPET_KEY}"> </script> <!-- End of Zendesk Widget script -->
Reported widget events
An event is a description of an activity that has occurred. The following table lists and describes the events reported in the Web Widget (Classic).
Agent display name
When an operator joins an initiated chatZendesk Web Widget (Classic)Chat Rating BadWhen the end user submits a bad rating post-chatZendesk Web Widget (Classic)Chat Rating GoodWhen the end user submits a good rating post-chatZendesk Web Widget (Classic)Chat Comment SubmittedWhen the end user submits a comment along with their ratingZendesk Web Widget (Classic)Chat Request Form SubmittedDepartment nameWhen the end user submits a chat request formZendesk Web Widget (Classic)Chat Offline Message SentWhen the end user submits a chat message when the agent is offlineContact and Ticket FormsZendesk Web Widget (Classic)Contact Form ShownIf ticket forms are also enabled, the label includes
the ticket form ID and ticket form name
When the contact form is shown to the end userZendesk Web Widget (Classic)Contact Form SubmittedTicket form ID, ticket form nameWhen the end user submits the contact formHelp CenterZendesk Web Widget (Classic)Help Center ShownWhen the end user is presented with the help centerZendesk Web Widget (Classic)Help Center SearchSearch termWhen the end user searches the Help Center in the widgetZendesk Web Widget (Classic)Help Center Article ViewedArticle ID, article nameWhen the end user views a help center article linkZendesk Web Widget (Classic)Help Center View Original Article ClickedArticle ID, article nameWhen the end user views the help center articleTalkZendesk Web Widget (Classic)Talk ShownTalk contact optionWhen the end user is presented with TalkZendesk Web Widget (Classic)Talk Callback Request SubmittedWhen the end user submits a callback requestAnswer BotZendesk Web Widget (Classic)Answer Bot Article ViewedArticle ID, article nameWhen the end user views an article from the list of suggested articles