Analytics Events
Analytics events cover a range of things related to both the Personal Finance Management widgets and our Mobile Banking app. Not all the analytics files will have data in them depending on whether partners are using Personal Finance Management, Mobile Banking, or both. For example, partners using Personal Finance Management widgets only (whether on desktop or mobile) will have data in analytics events files and analytics pageviews files, but not analytics screenviews nor analytics timed events.
| Resource | Data Source | Description |
|---|---|---|
analytics_events | Personal Finance Management and Mobile Banking | Analytics events occur within a Personal Finance Management widget (desktop or mobile) or a Mobile banking app view. |
analytics_pageviews | Personal Finance Management | Opening various widgets or tabs within the Master Widget. |
analytics_screenviews | Mobile Banking | Opening various views or screens within the Mobile Banking app. |
analytics_timed_events | Mobile Banking | Measures the timing of different events within the Mobile Banking app. |
Analytics Event Fields
Analytics events occur within a Personal Finance Management widget (desktop or mobile) or a Mobile Banking app view.
Analytics Event Fields
| Field | Data Type | Definition |
|---|---|---|
action | String | The action by the end user that triggered the analytics event (e.g. blur, click, etc.). |
app_guid | String | The unique identifier for the app based on the client and operating system (e.g., Epic Bank iOS and Epic Bank Android would have separate identifiers). Defined by MX. If the data_source is web, this field will be null. |
app_version | String | The specific version of the application with which the end user interacted. |
category | String | The category or feature with which the user interacted (e.g., Add Manual Account, Credential Login, etc.). |
client_guid | String | The unique identifier for the client associated with this analytics event. Defined by MX. |
created_at | Long | The date and time this analytics event was created. Represented as a Unix Epoch datetime (e.g. 1489883830). |
data_source | String | The origin of the analytics event (e.g., web for web application or app for mobile application). |
device_guid | String | The unique identifier for the device associated with the analytics event. Defined by MX. If the data_source is web, this field will be null. |
device_id | String | The unique identifier for the device associated with the analytics event; resets on every login. Defined by MX. |
device_uid | String | The unique identifier for the device associated with the analytics event; remains constant across logins. Defined by MX. |
external_user_guid | String | The partner-defined identifier for the user associated with the event. |
guid | String | The unique identifier for the analytics event. Defined by MX. |
is_mobile_webview | Boolean | The widget configuration as it was set at the time of the API request to obtain the widget. |
mdx_session_id | String | The hashed MDX session ID, provided as a custom dimension. |
name | String | The name of the action taken that generated the analytics event (e.g., Account Type - Collapse, Exclude Transaction - Start, etc.). |
screen_resolution | String | The resolution of the device display associated with the analytics event, given in pixels (e.g., 2048x1536). |
session_id | String | The unique identifier of the session, provided as a custom dimension. |
user_agent | String | The end user's browser and operating system. |
user_guid | String | The unique identifier for the user associated with the analytics event. Defined by MX. |
user_id | String | The partner-defined identifier for the user associated with the event. |
user_ip_address | String | The unique IP address for the user associated with the analytics event. |
value | String | The screen object the user interacted with, if applicable (e.g., Button, Menu, Previous Month). |
Analytics Pageviews
Analytics pageviews include pageviews only for the Personal Finance Management widgets.
Analytics Pageview Fields
| Field | Data Type | Definition |
|---|---|---|
app_version | String | The version of the user's application. |
client_guid | String | The unique identifier for the client associated with the analytics pageview. Defined by MX. |
created_at | Long | The date and time at which the analytics pageview was created. |
data_source | String | The origin of the analytics event, e.g. transactions for the transactions widget, master/transactions if the Master Widget is loaded, app for mobile application. |
external_user_guid | String | The partner-defined identifier for the user associated with the pageview. |
guid | String | The unique identifier for the analytics pageview. Defined by MX. |
host | String | The host name of the server. |
is_mobile_webview | Boolean | The widget configuration as it was set at the time of the API request to obtain the widget. |
name | String | The name of the page in the case of a pageview. |
path | String | The relative URL path of the event. |
screen_resolution | String | The resolution of the device display associated with the analytics event; given in pixels (e.g. 2048x1536). |
session_id | String | The unique identifier of the session, provided as a custom dimension. |
user_agent | String | The end user's browser and operating system. |
user_guid | String | The unique identifier for the user associated with the analytics pageview. Defined by MX. |
user_id | String | The partner-defined identifier for the user associated with the pageview. |
user_ip_address | String | The IP address of the user associated with this analytics pageview. |
Analytics Screenviews
Analytics screenviews include screenviews only for the Mobile Banking app.
Analytics Screenview Fields
| Field | Data Type | Definition |
|---|---|---|
app_guid | String | The unique identifier for the app based on the client and operating system (e.g., Epic Bank iOS and Epic Bank Android would have separate identifiers). Defined by MX. If the data_source is web, this field will be null. |
app_version | String | The specific version of the application with which the end user interacted. |
client_guid | String | The unique identifier for the client associated with this analytics screenview. Defined by MX. |
created_at | Long | The date and time the analytics screenview was created, given in Unix epoch time. |
data_source | String | The origin of the analytics screenview (e.g., web for web application or app for mobile application). |
device_guid | String | The unique identifier for the device associated with the analytics screenview. Defined by MX. If the data_source is web, this field will be null. |
device_id | String | The unique identifier for the device associated with the analytics screenview; resets on every login. Defined by MX. |
device_uid | String | The unique identifier for the device associated with the analytics screenview; remains constant across logins. Defined by MX. |
external_user_guid | String | The partner-defined identifier for the user associated with the screenview. |
guid | String | The unique identifier for the analytics screenview. Defined by MX. |
mdx_session_id | String | The hashed MDX session ID, provided as as custom dimension. |
name | String | The name of the action taken in the analytics screenview. |
screen_resolution | String | The resolution of the device display associated with the analytics screenview; given in pixels (e.g., 2048x1536). |
session_id | String | The unique identifier of the session, provided as a custom dimension. |
user_agent | String | The end user's browser and operating system. |
user_guid | String | The unique identifier for the user associated with the analytics screenview. Defined by MX. |
user_id | String | The partner-defined identifier for the user associated with the screenview. |
user_ip_address | String | The IP address of the user associated with this analytics pageview. |
Analytics Timed Events
Analytics timed events measure the timing of different events within the Mobile Banking app.
Analytics Timed Event Fields
| Field | Data Type | Definition |
|---|---|---|
app_guid | String | The unique identifier for the app based on the client and OS (e.g. Epic Bank iOS and Epic Bank Android would have separate identifiers). Defined by MX. If the data_source is web, this field will be null. |
app_version | String | The version of the user's application. |
category | String | The category or feature with which the user interacted (e.g. Add Manual Account, Credential Login, etc.). |
client_guid | String | The unique identifier for the client associated with this analytics event. Defined by MX. |
created_at | Long | The date and time at which the analytics timed event was created. |
data_source | String | The origin of the analytics event (e.g. web for web application or app for mobile application). |
device_guid | String | The unique identifier for the device associated with the analytics event. Defined by MX. If the data_source is web, this field will be null. |
device_id | String | The unique identifier for the device associated with the analytics event; resets on every login. Defined by MX. |
device_uid | String | The unique identifier for the device associated with the analytics event; remains constant across logins. Defined by MX. |
external_user_guid | String | The partner-defined identifier for the user associated with the pageview. |
guid | String | The unique identifier for the analytics timed event. Defined by MX. |
interval | Long | The duration of the analytics timed event from start to finish, given in milliseconds. |
mdx_session_id | String | The hashed MDX session ID, provided as a custom dimension. |
name | String | The name of the action taken which generated the analytics event (e.g. Account Type - Collapse, Exclude Transaction - Start, etc.). |
screen_resolution | String | The resolution of the device display associated with the analytics event; given in pixels (e.g. 2048x1536). |
session_id | String | The unique identifier of the session, provided as a custom dimension. |
user_agent | String | The end user's browser and operating system. |
user_guid | String | The unique identifier for the user associated with the analytics timed event. Defined by MX. |
user_id | String | The partner-defined identifier for the user associated with the pageview. |
user_ip_address | String | The unique IP address for the user associated with the analytics event. |
version | Long | The version of the user's application, given as an integer. |