Top
Data captured by Whatfix Analytics
  • 25 Nov 2021
  • 6 Minutes To Read
  • Dark
    Light
  • PDF

Data captured by Whatfix Analytics

  • Dark
    Light
  • PDF

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 only the engagement data as listed in the following table. But, if you've enabled Send All Events option, then in addition to the engagement data, we also capture widgets loaded event data.

    

Data

Identifier in request

Primary Tracker

Comments
device_encodingdeYesEncoding configured on the device.
Page titledtYesPage title from where the event was triggered.
Page locationdlYesURL from where the event was triggered.
editor_user_idcd1YesUser Id of the user logged in to the Whatfix dashboard.
This is '-' for end-users.
editor_user_namecd6Yes*Username of the person logged in to the Whatfix dashboard. Applicable only in the case of Whatfix dashboard and '-' for end-users.
ent_idcd4YesClient UUID 
ent_namecd12YesWhatfix enterprise for which the analytics account is being created.
environmentcd11

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_1cd8Yes*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.

For example, customers might send user segment information, like a department or role. 
extra_2cd9Yes*
flow_idcd2YesID of the content (text/link/video), Smart Tip, etc.
This is a UUID.
flow_titlecd7YesContent title of the content that is launched.
This is related to cd2 (flow_id)
interaction_idcd10Yes

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 the Whatfix Session Id cookie
localeulYesLanguage configured for the browser.
on_idcd5Yes**URL of the page on which this event is triggered
pathdpYesThe path is the event type defined by Whatfix.
For Example, /flow/live/start for a Flow started, /Whatfix/loaded for Whatfix script loaded on the page
screen_resolutionsr, vpYesScreen resolution and viewport size of the device
segment_idcd13YesSegment information for the current event
segment_namecd14Yes
src_idcd3YesThe 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_idcd16Yes
unq_idcd17YesValue 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 cd32YesThese dimensions are used internally to troubleshoot and improve Whatfix. 
Note
No PII or URL information is captured in these dimensions.
usercd15Yes*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_appscd59YesDetects third-party JavaScript applications installed on the main application used by the Editor.
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

The following events are captured only if you've enabled Send All Events option.

WidgetEventDescription
Whatfix JS load/whatfix/loadedFired when Whatfix embed JS is loaded.
Self Help/widget/loadedFired when Self Help is loaded.
Task List/tasker/loadedFired when Task List is loaded.
Smart Tips/smart_tip/loadedFired when Smart Tip is loaded.
Pop-up (New)/popup/loadedFired when the new Pop-up is loaded.
Guided Pop-up/popup/guided_popup/loadedFired when the Guided Pop-up is loaded.
Smart Pop-up/popup/smart_popup/loadedFired when the Smart Pop-up is loaded.

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

TermDescription
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 TrackerAPI exposed as JS methods for the customer to process analytics events
Customer's IdCustomer's Id / EntId / ClientId is an automatically generated 36 character alpha-numeric UUID
Primary TrackerThis is a tracker configured to send data to Whatfix's Analytics account
RSAEncryption 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 personally identifiable information.

Certain things to note about the wfx_unq cookie:
Cookies automatically expire after 3 months
The name of the cookie is wfx_unq
The value of the cookie is randomly generated

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.

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 personally identifiable information.

Certain things to note about the wfx_unq cookie:

  • Cookies automatically expire after 3 months
  • The name of the cookie is wfx_unq
  • The value of the cookie is randomly generated.

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

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 personally identifiable information.

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 personally identifiable information.

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 personally identifiable information.

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 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 the wfx_unq cookie:

  • Cookies automatically expire after 3 months
  • The name of the cookie is wfx_unq
  • The value of the cookie is randomly generated
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.

    Certain things to note about _GWTCookieCheck are,
    • If _GWTCookieCheck is not whitelisted, then Whatfix will not function properly in your browser.
    • This is a volatile cookie, which means GWT adds and removes it immediately.
    • The cookie does not appear in the browser cookie tab.

  • Whatfix sets the wfx_test cookie to check if the application sub-domain allows setting cookies or not. If the URL does not contain sub-domains, then the cookies is not set.

    Certain things to note about wfx_test are,
    • This is a volatile cookie.
    • After the sub-domain check, the cookie is removed automatically.


Was This Article Helpful?

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.