This document summarizes the data captured by Whatfix on your application. We provide hooks to access your application data or send it to Analytics (Whatfix or Custom Analytics) for further processing.
We use Whatfix's in-house Analytics platform to ingest data into our pipeline. This acts as a repository from where we periodically display data on the Analytics Dashboard. The following table summarizes all the fields tracked by Whatfix.
Data tracked and sent to Whatfix Analytics
By default, Whatfix captures the engagement data and the widgets loaded event data as listed in the following table:
Data | Identifier in request | Primary Tracker | Comments |
|---|---|---|---|
device_encoding | de | Yes | Encoding configured on the device. |
Page title | dt | Yes | Page title from where the event was triggered. |
Page location | dl | Yes | URL from where the event was triggered. |
editor_user_id | cd1 | Yes | User ID of the user logged in to the Whatfix dashboard. |
editor_user_name | cd6 | Yes* | Username of the person logged in to the Whatfix dashboard. Applicable only in the case of Whatfix dashboard and '-' for end users. |
ent_id | cd4 | Yes | Client UUID |
ent_name | cd12 | Yes | Whatfix enterprise for which the analytics account is being created. |
environment | cd11 | This variable contains multiple fields separated by a colon(:): locale: The locale as configured for Whatfix. parentWindow/iframe: Whether this event is sent from an iframe or parent window (used internally for analysis). prod/dev/export: Deployment method. Here prod = cdn, dev = Whatfix cloud encrypted_rsa_v2/plaintext: Personally Identifiable Information (PII) encryption strategy. true/false: Cookies are enabled or disabled. version: Whatfix software version | |
extra_1 | cd8 | Yes* | This is a reserved variable for customers to send specific information based on their needs. These variables collect encrypted PII data. These fields are encrypted when sent to Whatfix's Analytics platform. |
extra_2 | cd9 | Yes* | |
flow_id | cd2 | Yes | ID of the content (text/link/video), Smart Tip, etc. |
flow_title | cd7 | Yes | Content title of the content that is launched. |
interaction_id | cd10 | Yes | This variable contains multiple fields separated by a colon(:): unique_cookie: This is the value of a cookie that is set on the user's machine to uniquely identify them if the user information is not passed in wfx_settings.user. interaction: This is the interaction ID (see Analytics Glossary ) user_time: This is the current user time in milliseconds. sid_cookie: This is the value of the Whatfix Session Id cookie. |
locale | ul | Yes | Language configured for the browser. |
on_id | cd5 | Yes** | URL of the page on which this event is triggered |
path | dp | Yes | The path is the event type defined by Whatfix. |
screen_resolution | sr, vp | Yes | Screen resolution and viewport size of the device. This information is not available as part of User filters or User breakdowns in Insights. However, it can be exported using an API. For more information on the API, contact support@whatfix.com. |
segment_id | cd13 | Yes | Segment information for the current event |
segment_name | cd14 | Yes | |
src_id | cd3 | Yes | The location from which this event was triggered. |
step_id | cd16 | Yes | The ID of the Flow step, Beacon, or Smart Tip in the event. |
unq_id | cd17 | Yes | Value of unique cookie (wfx_unq). This id is a randomly generated UUID that is used to uniquely identify the user if the user information is not present. |
cd21 to cd32 | Yes | These dimensions are used internally to troubleshoot and improve Whatfix. Note No PII or URL information is captured in these dimensions. | |
user | cd15 | Yes* | Encrypted PII data is collected. User information is not captured by default. However, if you choose to capture this, then the user ID can be configured using _wfx_settings.user. This value is encrypted when it goes to Whatfix Analytics. |
other_apps | cd59 | Yes | Detects third-party JavaScript applications installed on the main application used by Studio. |
your title goes here
The value is encrypted using the encryption method specified in the environment (cd11)
Can be disabled using configuration
Loaded events captured
Widget | Event | Description |
|---|---|---|
Whatfix JS load | /whatfix/loaded | Fired when Whatfix Embed JS is loaded. |
Self Help | /widget/loaded | Fired when Self Help is loaded. |
Task List | /tasker/loaded | Fired when Task List is loaded. |
Smart Tips | /smart_tip/loaded | Fired when Smart Tip is loaded. |
Pop-up (New) | /popup/loaded | Fired when the new Pop-up is loaded. |
GDPR Compliance
As per GDPR (General Data Protection Regulation) compliance, all the PII sent to Whatfix are encrypted in transit (Encryption protocol TLS 1.2) and at rest (Encryption algorithm AES). These fields include user (cd15), extra_1 (cd8), editor_user_name(cd6), and extra_2 (cd9).
Analytics Glossary
Term | Description |
|---|---|
Analytics Extras(extra_1, extra_2) | These are extra dimensions exposed by Whatfix to send information. These dimensions can be used to pass more fields based on the customer's requirement to segment usage. |
Custom Analytics Tracker | API exposed as JS methods for the customer to process analytics events. |
Customer's Id | Customer's Id/EntId/ClientId is an automatically generated 36 character alpha-numeric UUID. |
Primary Tracker | This is a tracker configured to send data to Whatfix's Analytics account. |
RSA | Encryption technique. (See on Wikipedia) |
Cookies captured
your title goes here
Pre-login and Post-login cookies are captured only for content creators on Whatfix.
your title goes here
*Cookies are a set of properties that are padded along with a request, which is then sent to the application's server. The SameSite value decides which request to send the Cookie to. The possible values you can set for this attribute are,
Lax- Restrict cookies to same-site requests. The cookie is sent only if the site for the cookie matches the site currently shown in the browser's URL.
None- Allow cookies to be sent in a third-party context.
Pre-login
Cookie Name | Cookie Duration | Size | HTTP Only | Secure | SameSite* | Description |
wfx_unq | 100 days | 23 | FALSE | TRUE | None | When Whatfix is loaded on a page, we set a cookie to identify the user. This is a random value generated every time we set it. It does not store any PII. The following are things to note about the wfx_unq cookie:
|
Post-login
Cookie Name | Cookie Duration | Size | HttpOnly | Secure | SameSite* | Description |
wfx_unq | 100 days | 23 | FALSE | TRUE | None | When Whatfix is loaded on a page, we set a cookie to identify the user. This is a random value generated every time we set it. It does not store any PII. The following are a few things to note about the wfx_unq cookie:
|
eid | 100 days | 39 | FALSE | TRUE | None | Whatfix sets this cookie. It contains the Enterprise ID of the customer. It does not correspond to any user id in the web application, nor does the cookie store any PII. |
loggedin | 100 days | 10 | FALSE | TRUE | None | Whatfix sets this cookie. It is set only when the user is logged in. It does not correspond to any user id in the web application, nor does the cookie store any PII. |
sid | 100 days | 31 | TRUE | TRUE | None | Whatfix sets this cookie. It is the random session ID set by the platform once the user is logged in. It does not correspond to any user id in the web application, nor does the cookie store any PII. |
uid | 100 days | 39 | FALSE | TRUE | None | Whatfix sets this cookie. It corresponds to the random user ID of the logged-in user. It does not correspond to any user id in the web application, nor does the cookie store any PII. |
__zlcmid | 1 year | 23 | FALSE | FALSE | Lax | Enables live customer service chat via Zendesk. It does not store any PII. |
region | 100 days | 8 | TRUE | TRUE | None | Whatfix sets this cookie. It is set after a user logs in. It stores the name of the region. Example: US, EU. |
End-user cookies
Cookie Name | Cookie Duration | Size | HttpOnly | Secure | SameSite* | Description |
wfx_unq | 100 days | 23 | FALSE | TRUE | FALSE | When Whatfix is loaded on a page, we set a cookie to identify the user. This is a random value generated every time we set it. It does not store any PII. The following are a few things to note about the wfx_unq cookie:
|
Note
Whatfix uses an additional cookie _GWTCookieCheck, set by our Google Web Toolkit (GWT) to check if cookies are enabled in your browser. If browser cookies are disabled, then the _GWTCookieCheck falls back to other options for storing data.
The following are things to note about _GWTCookieCheck are:This is a volatile cookie, which means GWT adds and removes it immediately.
The cookie does not appear in the browser cookie tab.
It does not store any PII.
Whatfix sets the wfx_test cookie to check if the application sub-domain enables setting cookies or not. If the URL does not contain sub-domains, then the cookies are not set.
The following are things to note about wfx_test are:This is a volatile cookie.
After the sub-domain check, the cookie is removed automatically.
It does not store any PII.