Google Analytics is an analytics tool that helps you understand and analyze your web traffic. The Web Widget 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 widget event reporting for Google Analytics
By default, the Web Widget detects if Google Analytics is present on your web page. When Google Analytics is on your web page, the widget automatically starts reporting events to Google Analytics.
To set up Google Analytics on your web page
Viewing widget 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 widget event reporting for Google Analytics
The analytics setting API is used to disable the automatic widget 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.
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.
|Widget channel||Category||Action||Event label||Description|
|General||Zendesk Web Widget||Web Widget Opened||When the end user opens the widget|
|Zendesk Web Widget||Web Widget Minimised (||When the end user minimises the widget|
|Chat||Zendesk Web Widget||Chat Opened||When Chat is initiated|
|Zendesk Web Widget||Chat Shown - same as Chat Opened||When Chat is initiated|
|Chat Served by Operator||
Agent Display Name
|When an operator joins an initiated chat|
|Zendesk Web Widget||Chat Rating Bad||When the end user submits a bad rating post-chat|
|Zendesk Web Widget||Chat Rating Good||When the end user submits a good rating post-chat|
|Zendesk Web Widget||Chat Comment Submitted||When the end user submits a comment along with their rating|
|Zendesk Web Widget||Chat Request Form Submitted||Department Name||When the end user submits a chat request form|
|Zendesk Web Widget||Chat Offline Message Sent||When the end user submits a chat message when the agent is offline|
|Contact and Ticket Forms||Zendesk Web Widget||Contact Form Shown||
If ticket forms are also enabled, the label includes
Ticket Form ID and Ticket Form name
|When the contact form is shown to the end user|
|Zendesk Web Widget||Contact Form Submitted||Ticket Form ID, Ticket Form name||When the end user submits the contact form|
|Help Center||Zendesk Web Widget||Help Center Shown||When the end user is presented with the Help Center|
|Zendesk Web Widget||Help Center Search||Search term||When the end user searches the Help Center in the widget|
|Zendesk Web Widget||Help Center Article Clicked||Article ID, Article name||When the end user clicks on a Help Center article link|
|Zendesk Web Widget||Help Center View Original Article Clicked||Article ID, Article name||When the end user views the Help Center article|
|Talk||Zendesk Web Widget||Talk Shown||Talk contact option||When the end user is presented with Talk|
|Zendesk Web Widget||Talk Callback Request Submitted||When the end user submits a callback request|