What are the Custom Dimensions to be added?
- 25 Feb 2025
- 1 Minute To Read
-
Print
-
DarkLight
-
PDF
What are the Custom Dimensions to be added?
- Updated On 25 Feb 2025
- 1 Minute To Read
-
Print
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Whatfix requires custom dimensions, such as user_id and flow_id, to exist in the Google Analytics account to create Whatfix reports in Google Analytics 4 (GA4).
Note:
The data collected may vary between Whatfix Analytics and Google Analytics. Whatfix Analytics uses India Standard Time (IST) GMT +5:30, and Google Analytics must be configured to a different timezone. To see the same numbers, update the timezone in the Google Analytics account under Admin > View Settings > Time zone country or territory.
What do the dimensions represent?
The following table outlines all dimensions for creating a Custom Dimension:
| Dimension | Description | Mandatory |
|---|---|---|
| device_encoding | Encoding configured on the device. | No |
| ent_id | Unique ID of the Whatfix enterprise for which the analytics account is created. | Yes |
| ent_name | Whatfix enterprise for which the analytics account is created. | Yes |
| environment | Locale of the Flow being played. | Yes |
| extra_1 | By default, this field is empty until set manually. It reserves space to send the first additional data in _wfx_settings.analytics_js_extra. | Yes |
| extra_2 | By default, this field is empty until set manually. It reserves space to send the second additional data in _wfx_settings.analytics_js_extra. | Yes |
| flow_id | Unique ID of the Flow being played. | Yes |
| flow_title | Title of the Flow being run. | Yes |
| interaction_id | Auto-generated unique ID for each user interaction with a Whatfix widget. | Yes |
| locale | Language configured for the browser. | No |
| location | The URL of the page on which this event is triggered. | No |
| on_id | The URL from where the event is triggered. | Yes |
| path | Path of the event being recorded. | No |
| segment_id | Unique ID of the segment configured through UI segmentation. This information is not sent for segments created through the integration script. | Yes |
| segment_name | Name of the segment. If the segment is configured through integration, then segment_name is the flow_title for the guided popup. For tasklist and self-help, the name is the title. | Yes |
| 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. | Yes |
| step_id | Description of the step. | Yes |
| unq_id | Unique user ID generated by Whatfix to identify users saved on the end-user browser as a cookie. | Yes |
| user | User configured in _wfx_settings.user. | Yes |
| user_id | Unique ID of the Whatfix content creator using the application. | Yes |
| user_name | The name of the Whatfix content creator using the application. | Yes |
Was this article helpful?