All Collections
Settings
Integrations
Google Analytics Integration
Google Analytics Integration

Track the onboarding material usage & NPS responses via Google Analytics.

Alican avatar
Written by Alican
Updated over a week ago

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.

Installation Method Specific Requirements

To learn more about Google Analytics installation methods visit Google's documentation.

gtag.js

If you have installed Google Analytics within your web application using the gtag.js method, there are no additional steps required.

Google Tag Manager

​If you have installed Google Analytics using Google Tag Manager, you must complete the following steps before enabling the Integration.

1- Create Data Layer Variables

You need to create 11 new Data Layer Variables with the following names;

userguiding_material_id
userguiding_material_name
userguiding_material_type
userguiding_interacted_item_id
userguiding_interacted_item_name
userguiding_survey_id
userguiding_survey_name
userguiding_question_id
userguiding_question_type
userguiding_survey_score
userguiding_survey_answer

Each variable should look something like the below:
​

2- Create a Tag for Material Events

3- Add Trigger to Material Events Tag

  • Trigger Type: Custom Event

  • Event name: userguiding_(?!survey)\w+\b

  • Use regex matching

4- Create a Tag for Survey Events

Add a new GA4 Event tag with the below configurations

5- Add Trigger to Survey Events Tag

  • Trigger Type: Custom Event

  • Event name: userguiding_survey.+

  • Use regex matching

Publish changes to your GTM workspace

As long as your UserGuiding > Google Analytics integration is enabled, all UserGuiding events that get sent to GTM should now also be forwarded to your Google Analytics account.

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:

userguiding_guide_started

Indicates that a Guide is shown to the user. Following parameters sent within this event;

userguiding_material_id: Guide ID

userguiding_material_name: Guide Name


userguiding_guide_completed

Indicates that user has completed a Guide. Following parameters sent within this event;

userguiding_material_id: Guide ID

userguiding_material_name: Guide Name


userguiding_hotspot_interacted

Indicates that user has interacted with a Hotspot. Following parameters sent within this event;

userguiding_material_id: Hotspot Group ID

userguiding_material_name: Hotspot Group Name

userguiding_interacted_item_id: Hotspot Step Id

userguiding_interacted_item_name: Hotspot Step Title


userguiding_checklist_completed

Indicates that user has completed all items of a Checklist. Following parameters sent within this event;

userguiding_material_id: Checklist ID

userguiding_material_name: Checklist Name


userguiding_checklist_item_trigger

Indicates that user triggers a Guide from a Checklist. Following parameters sent within this event;

userguiding_material_id: Checklist ID

userguiding_material_name: Checklist Name

userguiding_interacted_item_id: Triggered Guide's ID userguiding_interacted_item_name: Triggered Guide's name


userguiding_checklist_item_url_click

It means that a user interacts with an External Url module inside a Checklist. Following parameters sent with this event;

userguiding_material_id: Checklist ID

userguiding_material_name: Checklist Name

userguiding_interacted_item_id: Triggered item's URL


userguiding_rc_guide_trigger

It means that a user triggers a Guide from a Resource Center. Following parameters sent with this event;

userguiding_material_id: Resource Center ID

userguiding_material_name: Resource Center Name

userguiding_interacted_item_id: Triggered Guide's ID

userguiding_interacted_item_name: Triggered Guide's name


userguiding_rc_survey_trigger

It means that a Survey in a Resource Center as a module is triggered by a user. Following parameters sent with this event;

userguiding_material_id: Resource Center ID

userguiding_material_name: Resource Center Name

userguiding_interacted_item_id: Triggered Survey's ID

userguiding_interacted_item_name: Triggered Survey's name


userguiding_rc_checklist_guide_trigger

Indicates that a guide is triggered from a checklist that is put in a Resource Center as a module. Following parameters sent with this event;

userguiding_material_id: Resource Center ID

userguiding_material_name: Resource Center Name

userguiding_interacted_item_id: Triggered Guide's ID

userguiding_interacted_item_name: Triggered Guide's name


userguiding_rc_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. Following parameters sent with this event;

userguiding_material_id: Resource Center ID

userguiding_material_name: Resource Center Name

userguiding_interacted_item_id: Triggered item's URL


userguiding_rc_external_url_click

It means that a user interacts with an external url module in a Resource Center. Following parameters sent with this event;

userguiding_material_id: Resource Center ID

userguiding_material_name: Resource Center Name

userguiding_interacted_item_id: Triggered item's URL


userguiding_rc_article_link_click

It means that a user interacts with a Knowledge Base Article in a Resource Center. Following parameters sent with this event;

userguiding_material_id: Resource Center ID

userguiding_material_name: Resource Center Name

userguiding_interacted_item_id: Interacted Article's URL


userguiding_survey_shown

Indicates that a survey is shown to the user. Following parameters sent with this event;

userguiding_survey_id: Survey's ID

userguiding_survey_name: Survey's Name


userguiding_survey_answer

It means that a user has given you a certain score or selected an emoji, option, or written feedback. Following parameters sent with this event;

userguiding_survey_id: Survey's ID

userguiding_survey_name: Survey's Name

userguiding_question_id: Survey Question's ID

userguiding_question_type: Survey Question Type (nps, starRating etc..)

userguiding_survey_score: Score given to Survey (number values)

userguiding_survey_answer: Answer given to Survey (text values: feedback, choices..)

πŸ’‘

Please note that the existing events associated with the now-deprecated Promoter Surveys will remain unchanged; however, they will be emitted in their new format.

Did this answer your question?