This article explains how UserGuiding integrates with Google Analytics, a web analytics service offered by Google that tracks & reports website traffic and events.
When it is activated, UserGuiding can be used as a Source that sends UserGuiding content-related event data to your Google Analytics account.
Important Note: To successfully initiate this integration, you must have installed Google Analytics within your web application. If not, this integration will not take place.
How To Enable Google Analytics Integration
You can enable this integration using the toggle within the Integrations Tab under the Settings Section.
When you turn the toggle on, this integration will be activated for the pages where UserGuiding Container Code and the Google Analytics Tracking Code are present at the same time.
If you have installed Google Analytics within your web application using the gtag.js method, there are no additional steps required.
If you have installed Google Analytics using Google Tag Manager, you must complete the following steps before enabling the Integration.
1- Create UserGuiding Tracking Trigger
Trigger type: Custom Event
Event name:
userGuidingTracking
2- Create User-Defined Variables
Go to the "Variables" tab from the sidebar
Scroll down to the User-Defined Variables section
Click on New Button
You need to create 4 variables; all of these variables should have the type "Data Layer Variable":
eventAction
eventCategory
eventLabel
eventValue
3- Add a Universal Analytics tag for event tracking
Tag Type: Google Analytics Universal Analytics
Track Type: Event
Category: {{eventCategory}}
Action: {{eventAction}}
Label: {{eventLabel}}
Value: {{eventValue}}
Trigger: UserGuidingTrackingTrigger
Event Tracking
When enabled, UserGuiding will send content-related event data to your Google Analytics account.
To view the events:
Go to your Google Analytics Dashboard > Realtime > Events.
Or go to Behavior > Events > Top events
You should see the latest UserGuiding events in this section.
These events include:
Guide Preview Start
It means that a user previews the first step of a Guide. The category of this event is "UserGuiding Guide".
The event action is "start" (since Guides start from their first steps), and the Guide's name can be seen under "eventLabel".
Guide Preview Complete
It means that a user has gone through all steps of a Guide and seen its last step. The category of this event is "UserGuiding Guide".
Event action is "complete" and the Guide's name can be seen under "eventLabel".
NPS Open
It means that a user sees your NPS Survey. The category of this event is "UserGuiding NPS". Event action is "shown".
NPS Score Submit
It means that a user has given you a certain NPS score. The category of this event is "UserGuiding NPS". The event action is "score submit".
You'll see the survey question and the value of the submitted score.
NPS Feedback Submit
It means that a user has given a written answer to the question of your NPS Survey. The category of this event is "UserGuiding NPS". The event action is "feedback submit".
Hotspot Interaction
It means that a user interacted with a Hotspot group and saw Hotspot content. Remember, Hotspot groups can have multiple Hotspots as contents.
The category of this event is "UserGuiding Hotspot Group". Event action is "hotspot interact".
The Hotspot group's name (1st part) and the extracted Hotspot name from the interacted Hotspot content can be seen under "eventLabel".
Checklist Item Trigger
It means that a user triggers a Checklist item. The category of this event is "UserGuiding Checklist". Event action is "checklist guide trigger".
The Checklist name (1st part) and the Guide name, triggered from the Checklist, can be seen under "eventLabel".
Checklist Item URL Click
It means that a user clicks a Checklist URL item. The category of this event is "UserGuiding Checklist". The event action is "checklist item url click".
The Checklist name (1st part) and the URL clicked from the checklist can be seen under "eventLabel".
Checklist Complete
It means that a user completes a Checklist. The category of this event is "UserGuiding Checklist". The event action is "checklist complete".
The Checklist name can be seen under "eventLabel".
Resource Center Guide Trigger
It means that a user triggers a Resource Center Guide. The category of this event is "UserGuiding Resource Center". The event action is "resource center guide trigger".
Guide name can be seen under "eventLabel".
Resource Center Checklist Guide Trigger
It means that a Guide in a Checklist that is put in a Resource Center as a module is triggered by a user. The category of this event is "UserGuiding Resource Center". The event action is "checklist guide trigger".
Guide name can be seen under "eventLabel".
Resource Center Checklist Item URL Click
It means that a URL item in a checklist that is put in a Resource Center as a module is clicked by a user. The category of this event is "UserGuiding Resource Center". The event action is "checklist item url click".
Clicked URL can be seen under "eventLabel".
Resource Center External URL Click
It means that a user clicks an external URL in a Resource Center. The category of this event is "UserGuiding Resource Center". The event action is "external url click".
External URL can be seen under "eventLabel".
Resource Center Search Article Link Click
It means that a user clicks an external URL in a Resource Center. The category of this event is "UserGuiding Resource Center". The event action is "article link click".
The article link can be seen under "eventLabel".
