Top
What are the Custom Dimensions to be added?
  • 03 Aug 2023
  • 1 Minute To Read
  • Dark
    Light
  • PDF

What are the Custom Dimensions to be added?

  • Dark
    Light
  • PDF

Article Summary

Whatfix requires custom dimensions - user_id, flow_id, src_id, ent_id, on_id, user_name, flow_title, etc., to be present in your Google Analytics account to create Whatfix reports in GA4.

Your title goes here
The data that is collected may vary between Whatfix Analytics and Google Analytics. This is because Whatfix Analytics uses the India Standard Time (IST) GMT +5:30 timezone and your analytics must be configured to a different timezone. To see the same numbers, update the timezone in your Google Analytics account under Admin > View Settings > Time zone country or territory.

What do the dimensions mean? 

DimensionDescription
It is mandatory to add the following dimensions when creating a Custom Dimension:
user_idUnique id of the Whatfix content creator using the application.
flow_idUnique id of the Flow being played
src_id

Source of the event. Possible values are "widget" implying Self Help widget, "guided_popup", "smart_popup", "beacon", "url", "js" implying Live Tour, "deck" implying Slideshow Embed.

ent_idUnique ID of the Whatfix enterprise for which the analytics account is being created
on_idThe URL from where the event got triggered
user_nameName of the Whatfix content creator using the application.
flow_title

Title of the Flow being run

extra_1By default, this is empty until set manually. Reserved to send the first additional data in _wfx_settings.analytics_js_extra
extra_2By default, this is empty until set manually. Reserved to send the second additional data in _wfx_settings.analytics_js_extra
interaction_idAuto-generated unique ID for each user interaction with a Whatfix widget
environmentLocale of the flow being played
ent_nameWhatfix enterprise for which the analytics account is being created
segment_idUnique ID of the segment configured through UI segmentation. This information is not sent for segments created through integration script.
segment_nameName of the segment. If the segment is configured through integration, then segment_name will be the flow_title for guided popup. For tasklist/self-help, it will be the title.
userUser configured in _wfx_settings.user
step_id

Step description

unq_id

A unique user ID generated by Whatfix to identify users, saved on the end user browser as a cookie.

The following custom dimensions are not mandatory:
device_encodingEncoding configured on the device
localeLanguage configured for the browser
locationThe URL of the page on which this event is triggered
pathpath is the event type defined by Whatfix.
Example: /flow/live/start for a flow started, /whatfix/loaded for Whatfix script loaded on the page
screen_resolutionScreen resolution and view port size of the device

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.