Data captured by Whatfix Analytics
- 7 Minutes To Read
-
Print
-
DarkLight
This document summarizes the data captured by Whatfix on your application. We provide hooks to access your application data or to send it to Analytics (Whatfix, Google, or Custom Analytics) for further processing.
We use Google Analytics (GA) to ingest data into our pipeline. GA acts as a repository from where we periodically pull data into our system to process and analyze. You can configure the account to publish data to your GA account. The following table summarizes all the fields that are tracked by Whatfix and those fields that can be sent to your GA (if configured).
Data tracked and sent to Google Analytics
By default, Whatfix captures only the engagement data as listed in the below table. But, if you've enabled Send All Events option then widgets loaded event data are also captured in addition to the engagement data. See the list of loaded events captured.
| Data | Identifier in request | Primary Tracker (Whatfix's GA account) | Secondary Tracker (Customer's GA account) | Comments |
|---|---|---|---|---|
| device_encoding | de | Yes | Yes | Encoding configured on the device |
| Page title | dt | Yes | Yes | Page title from where the event was triggered |
| Page location | dl | Yes | Yes | URL from where the event was triggered |
| editor_user_id | cd1 | Yes | Yes | User Id of the user logged in to the Whatfix dashboard. This is '-' for end users. |
| editor_user_name | cd6 | Yes* | Yes | Username of the person logged in to the Whatfix dashboard. Applicable only in case of Whatfix dashboard and '-' for end users. |
| ent_id | cd4 | Yes | Yes | Client UUID |
| ent_name | cd4 | Yes | 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 - PII encryption strategy true/false - cookies are enabled or disabled version - Whatfix software version | ||
| extra_1 | cd8 | Yes* | 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 GA but go as plain text to the customer's account. For example, customers might send user segment information - like a department or role. To know how to pass application specific data to Google Analytics, contact support@whatfix.com. |
| extra_2 | cd9 | Yes* | Yes | |
| flow_id | cd2 | Yes | Yes | ID of the content (text/link/video), smart tip, etc launch. This is a UUID. |
| flow_title | cd7 | Yes | Yes | Content title of the content that is launched. This is related to cd2 (flow_id) |
| interaction_id | cd10 | Yes | Yes | This variable contains multiple fields separated by a colon(:): unique_cookie - Is the value of a cookie is set on the user's machine to uniquely identify them if the user information is not passed in wfx_settings.user interaction - Is the interaction id (see Analytics Glossary) user_time - Is the current user time in milliseconds sid_cookie - Is the value of Whatfix Session Id cookie |
| locale | ul | Yes | Yes | Language configured for the browser |
| on_id | cd5 | Yes** | Yes** | URL of the page on which this event is triggered |
| path | dp | Yes | Yes | path 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_resolution | sr, vp | Yes | Yes | Screen resolution and viewport size of the device |
| segment_id | cd13 | Yes | Yes | Segment information for the current event |
| segment_name | cd14 | Yes | Yes | |
| src_id | cd3 | Yes | Yes | The location from which this event was triggered. Example: 'widget' if the event is triggered from Self Help, 'tasker' if the event is triggered from Task List |
| step_id | cd16 | Yes | Yes | |
| unq_id | cd17 | Yes | Yes | Value of unique cookie (wfx_unq). This id is a randomly generated UUID is used to uniquely identify the user if the user information is not present. |
| cd21 to cd32 | Yes | No | These dimensions are used internally to troubleshoot and improve Whatfix. Note: No PII or URL information is captured in these dimensions. | |
| user | cd15 | Yes* | Yes | Encrypted PLL 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 and is in plain text for the customer's GA. |
*The value is encrypted using the encryption method specified in the environment (cd11)
** Can be disabled using configuration
Loaded events captured
The following events are captured only if you've enabled Send All Events option.
| 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. |
| Guided Pop-up | /popup/guided_popup/loaded | Fired when the Guided Pop-up is loaded. |
| Smart Pop-up | /popup/smart_popup/loaded | Fired when the Smart Pop-up is loaded. |
_wfx_settings.disableURLTracking = true;
GDPR Compliance
As per GDPR (General Data Protection Regulation) compliance, all the PII (Personally identifiable information) 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 to GA. 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 GA tracker configured to send data to Whatfix's GA account |
| Secondary Tracker | Optional configuration of the GA tracker to send data to customer's GA account |
| RSA | Encryption technique. (See on Wikipedia) |
| TID | Tracker ID. This is the Google Analytics Tracker Id that is provided by Google. It distinguishes one event from another for Google to understand. |
Cookies captured
- 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 |
__cfduid | 30 days | 51 | TRUE | TRUE | Lax | The '__cfduid' cookie is set by our Web Application Firewall (WAF) CloudFlare service to identify trusted web traffic. It does not correspond to any user ID in the web application nor it stores any personal information. |
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 personally identifiable information. Certain things to note about wfx_unq cookie: |
amplitude_id_xxxxxwhatfix.com | 10 years | 300 | FALSE | FALSE | FALSE | These cookies are used by Amplitude for session tracking for analytics purposes. It does not store any personally identifiable information. |
__cflb | 24 hours | 49 | TRUE | TRUE | None | This cookie is used by Cloudflare for load balancing. It does not store any personally identifiable information. |
Post login
Cookie Name | Cookie Duration | Size | HttpOnly | Secure | SameSite* | Description |
__cfduid | 30 days | 51 | TRUE | TRUE | Lax | The '__cfduid' cookie is set by our Web Application Firewall (WAF) CloudFlare service to identify trusted web traffic. It does not correspond to any user id in the web application, nor does the cookie store any personally identifiable information. |
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 personally identifiable information. Certain things to note about wfx_unq cookie: |
amplitude_id_xxxwhatfix.com | 10 years | 348 | FALSE | TRUE | None | These cookies are used by Amplitude for session tracking for analytics purposes. It does not store any personally identifiable information. |
eid | 100 days | 39 | FALSE | TRUE | None | This cookie is set by Whatfix. 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 personally identifiable information. |
loggedin | 100 days | 10 | FALSE | TRUE | None | This cookie is set by Whatfix. 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 personally identifiable information. |
sid | 100 days | 31 | TRUE | TRUE | None | This cookie is set by Whatfix. 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 personally identifiable information. |
uid | 100 days | 39 | FALSE | TRUE | None | This cookie is set by Whatfix. 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 personally identifiable information. |
__cflb | 24 hours | 51 | TRUE | TRUE | None | This cookie is used by Cloudflare for load balancing. It does not store any personally identifiable information. |
__zlcmid | 1 year | 23 | FALSE | FALSE | Lax | Enables live customer service chat via Zendesk. It does not store any personally identifiable information. |
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 personally identifiable information. Certain things to note about wfx_unq cookie: |
__cfduid | 30 days | 51 | TRUE | TRUE | Lax | The '__cfduid' cookie is set by our Web Application Firewall (WAF) CloudFlare service to identify trusted web traffic. It does not correspond to any user id in the web application, nor does the cookie store any personally identifiable information. |