This page contains information about your Mobile Engage-related data views. For more information on Open Data - Data views, see Data views overview.
Mobile Engage Push
Push campaigns
View name: push_campaigns_[customer_ID] (where customer_ID is your Emarsys account ID)
This view shows you all your push campaigns, including all language versions.
It contains data from November 29, 2017 onwards.
| Data field | Description | Type |
|---|---|---|
| android_settings | Any Android specific setting. | record |
| android_settings.k | Android setting key. | string |
| android_settings.v | Android setting value | string |
| application_id | The unique ID of the application. | integer |
| campaign_id | The unique ID of the campaign. | integer |
| created_at | Campaign creation date (UTC). | timestamp |
| customer_id | The unique ID of the customer. | integer |
| data | Customer can add any data. | record |
| deleted_at | Time of deletion. | timestamp |
| event_time | The last update of the campaign. | timestamp |
| ios_settings | Any iOS specific setting. | record |
| ios_settings.k | iOS setting key. | string |
| ios_settings.v | iOS setting value. | string |
| launched_at | The launch time of the campaign. | timestamp |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
| message | It contains the message body. | record |
| message.k | Message language code. | string |
| message.v | Message body in the given language. | string |
| name | The name of the push campaign. | string |
| push_internal_campaign_id | Push channel's internal campaign ID. | integer |
| scheduled_at | Scheduled time of sending. | timestamp |
| segment_id | The ID of the segment applied. | integer |
| recipient_source_id | The numeric ID of the selected recipient source (i.e. segment ID, contact list ID). | integer |
| source | Possible source options: ac, broadcast, segment, me_segment. | string |
| recipient_source_type | The type of the selected recipient source (it can be either AC, segment or a contact list). | string |
| status | The status of the campaign. | string |
| target | Possible values are push, deliver and notificationinbox. | string |
| title | It always contains the language code. | record |
| title.k | Language code key. | string |
| title.v | Language key value. | string |
| sending_limit | The amount of messages sent per unit (minute, hour, etc.). | record |
| created_with | Provides information on what was the origin of the campaign creation (API with API version specified or UI). | string |
Push sends
View name: push_sends_[customer_ID] (where customer_ID is your Emarsys account ID)
This view contains all your sent push messages. By running a query, you can get data on which messages were in which campaign to which customers.
This view contains data from May 31, 2017 onwards.
| Data field | Description | Type |
|---|---|---|
| application_code | The unique ID of the application. | string |
| application_id | The unique ID of the application. | integer |
| campaign_id | The unique ID of the campaign. | integer |
| contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
integer |
| customer_id | The unique ID of the customer. | integer |
| event_time | The send time of the message. | timestamp |
| hardware_id | The unique ID of the device on which the message was displayed. | string |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
| platform | The name of the platform (android, ios, etc.). | string |
| program_id | The unique ID of the related Automation Center program. | integer |
| push_token | A device-related token. | string |
| source | Trigger of the event. | record |
| source.id | The unique ID of the source. | string |
| source.type | The type of the source. For example, ac or ui. | string |
| target | Represents the target of the message. The typical value is push. | string |
| treatments.ac.id |
The ID of an Automation Center program. | integer |
| treatments.ac.run_id | The ID of an Automation Center program run instance. | string |
| treatments.rti.id | The ID of an Interactions program. | string |
| treatments.rti.run_id | The ID of an individual Interactions run instance | String |
Push not sends
View name: push_not_sends_[customer_ID] (where customer_ID is your Emarsys account ID)
This view shows which messages could not be sent to the target devices.
It contains data from May 31, 2017 onwards.
| Data field | Description | Type |
|---|---|---|
| application_code | The unique ID of the application. | string |
| application_id | The unique ID of the application. | integer |
| campaign_id | The unique ID of the campaign. | integer |
| contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
integer |
| customer_id | The unique ID of the customer. | integer |
| event_time | The time when the event occurred. | timestamp |
| hardware_id | The unique ID of the device on which the message was displayed. | string |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
| platform | The name of the platform (Android, iOS, etc.). | string |
| program_id | The unique ID of the AC program. | integer |
| push_token | A device related token. | string |
| reason | The reason for the not sent event. | string |
| source | Trigger of the event. | record |
| source.id | The unique ID of the source. | string |
| source.type | The type of the source. For example, ac or ui. | string |
| treatments.ac.id |
The ID of an Automation Center program. |
integer |
| treatments.ac.run_id |
The ID of an Automation Center program run instance. |
string |
| treatments.rti.id |
The ID of an Interactions program. |
string |
| treatments.rti.run_id |
The ID of an individual Interactions run instance. |
string |
Push opens
View name: push_opens_[customer_ID] (where customer_ID is your Emarsys account ID)
This view shows which messages were opened and on what kind device types.
It contains data from May 31, 2017 onwards.
| Data field | Description | Type |
|---|---|---|
| application_code | The unique ID of the application. | string |
| application_id | The unique ID of the application. | integer |
| campaign_id | The unique ID of the campaign. | integer |
| contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
integer |
| customer_id | The unique ID of the customer. | integer |
| event_time | The time when it was opened. | timestamp |
| hardware_id | The unique ID of the device on which the message was displayed. | string |
| loaded_at | Loading date to Data Platform (UTC) | timestamp |
| source | The place where the message was displayed. | string |
| treatments.ac.id |
The ID of an Automation Center program. |
integer |
| treatments.ac.run_id |
The ID of an Automation Center program run instance. |
string |
| treatments.rti.id |
The ID of an Interactions program. |
string |
| treatments.rti.run_id |
The ID of an individual Interactions run instance. |
string |
Push custom events
View name: push_custom_events_[customer_ID] (where customer_ID is your Emarsys account ID)
This view contains all the custom push events.
It contains data from May 31, 2017 onwards.
| Data field | Description | Type |
|---|---|---|
| application_code | The unique ID of the application. | string |
| application_id | The unique ID of the application. | integer |
| contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
integer |
| customer_id | The unique ID of the customer. | integer |
| event_attributes | Any custom attribute. | record |
| event_attributes.k | Attribute key. | string |
| event_attributes.v | Attribute value. | string |
| event_name | The name of the event (this is not unique). | string |
| event_time | The time when the custom event happened. | timestamp |
| hardware_id | The unique ID of the device on which the message was displayed. | string |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
| treatments.ac.id |
The ID of an Automation Center program. |
integer |
| treatments.ac.run_id |
The ID of an Automation Center program run instance. |
string |
| treatments.rti.id |
The ID of an Interactions program. | string |
| treatments.rti.run_id |
The ID of an Interactions run instance. | String |
Push message status checking
The following logic checks the actual status of the push_token.
It enables you to retrieve information from Open Data, if mobile push notifications are enabled or disabled on the customers' device:
Push notifications are enabled
push_token IS NOT NULL
AND push_token_status IS NULL
Click to copy
Push notifications are disabled
push_token IS NULL
OR push_token_status IS NOT NULL
Click to copy
Note that a push_token_staus is disabled, if the push message sending failed,
but the push_token_status can also be disabled, if ithe token is expired or the application is uninstalled.
Mobile Engage In-app
In-app campaigns
View name: inapp_campaigns_[customer_ID] (where customer_ID is your Emarsys account ID)
This view shows you all your In-app campaigns, including all language versions.
| Data field | Description | Type |
|---|---|---|
| campaign_id | The unique ID of the campaign. | integer |
| name | UI name of the campaign. | string |
| status | status | string |
| source | Possible values: broadcast, audience, push. | string |
| application_code | Code of the application. | string |
| event_time | Last update of the campaign. | timestamp |
| loaded_at | UTC Time - loading to the data platform. | timestamp |
In-app views
View name: inapp_views_[customer_ID] (where customer_ID is your Emarsys account ID)
In-app views collect records of In-app impressions on the end devices.
| Data field | Description | Type |
|---|---|---|
| contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
integer |
| application_code | Unique ID of the application. | string |
| campaign_id | Unique ID of the campaign. | integer |
| client_id | hardware_id | string |
| event_time | Time of the In-app impression. | timestamp |
| loaded_at | UTC Time - loading to the data platform. | timestamp |
| audience_change.treatments.rti.program_id | The RTI program that targeted the contact. | string |
| audience_change.treatments.contact_segment.segment_id | The contact segment that had the contact added/removed. | string |
| audience_change.treatments.push_campaign.campaign_id | The push campaign in case of push-to-In-app |
string |
| audience_change.treatments.ac.program_id | The AC program that targeted the contact. |
string |
In-app clicks
View name: inapp_clicks_[customer_ID] (where customer_ID is your Emarsys account ID)
In-app clicks show the actual user actions taken after the In-app impression.
| Data field | Description | Type |
|---|---|---|
|
contact_id |
Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
Integer |
| application_code |
Unique code of the application. |
string |
| campaign_id |
Unique ID of campaign. |
integer |
| client_id | hardware_id | string |
| event_time |
Device time of the event. |
timestamp |
| loaded_at |
Time of the event recorded in the database. |
timestamp |
| button | Record | record |
| button_id | The ID of the button being pressed. | string |
| audience_change.treatments.rti.program_id | The RTI program that targeted the contact. | string |
| audience_change.treatments.contact_segment.segment_id | The contact segment that had the contact added/removed. |
string |
| audience_change.treatments.push_campaign.campaign_id | The push campaign in case of push-to-In-app |
string |
| audience_change.treatments.ac.program_id | The AC program that targeted the contact. |
string |
In-app audience changes
View name: inapp_audience_changes_[customer_ID] (where customer_ID is your Emarsys account ID)
In-app Audience changes collect records of In-app contacts added or removed from an audience.
It contains data from August 21, 2020 onwards.
| Data field | Description | Type |
|---|---|---|
| change_type | Add or removed. |
string |
| customer_id | Customer record in Emarsys. | integer |
| contact_id | Emarsys internal unique contact ID. It cannot be used to personally identify individuals. | integer |
| application_code | Code of the application. | string |
| campaign_id | The unique ID of the campaign. | string |
| client_id |
hardware_id |
string |
| event_time | Last update of the campaign. | timestanp |
| loaded_at | UTC Time - loading to the data platform. | timestamp |
| treatment | Record | record |
Mobile Engage Inbox
Inbox sends
View name: inbox_sends_[customer_ID] (where customer_ID is your Emarsys account ID)
This view contains all your sent inbox messages. By running a query, you can get data on which messages were sent in which campaign to which customers.
| Data field | Description | Type |
|---|---|---|
| campaign_id | The unique ID of the campaign. | integer |
| application_code | The unique ID of the application. | string |
| contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
integer |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
| event_time | The time when the campaign was fetched by the device. | timestamp |
| platform | The name of the platform (Android, iOS, etc.). | string |
| source.id | The unique ID of the source. | string |
| source.type | The type of the source. For example, ac or ui. |
string |
| treatments.rti.id | The ID of an Interactions program. | string |
| treatments.rti.run_id | The ID of an individual Interactions run instance. | string |
| treatments.ac.id | The ID of an Automation Center program. | integer |
| treatments.ac.run_id | The ID of an Automation Center program run instance. | string |
| treatments.ui.id | The session ID of the instance the campaign is launched via the user interface. | integer |
| treatments.ui.run_id | The run ID of the instance the campaign is launched via the user interface. | string |
| treatments.ui_test.id | The session ID of the instance the test campaign is launched via the user interface. | integer |
| treatments.ui_test.run_id | The run ID of the instance the test campaign is launched via the user interface | string |
Inbox not sends
View name: inbox_not_sends_[customer_ID] (where customer_ID is your Emarsys account ID)
This view shows which messages could not be sent to the target users.
| Data field | Description | Type |
|---|---|---|
| campaign_id | The unique ID of the campaign. | integer |
| application_code | The unique ID of the application. | string |
| contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
integer |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
| event_time | The time the inbox campaign failed to send. | timestamp |
| platform | The name of the platform (Android, iOS, etc.). | string |
| reason | The reason for the not sent event. | string |
| source.id | The unique ID of the source. | string |
| source.type | The type of the source. For example, ac or ui. |
string |
| treatments.rti.id | The ID of an Interactions program. | string |
| treatments.rti.run_id | The ID of an individual Interactions run instance. | string |
| treatments.ac.id | The ID of an Automation Center program. | integer |
| treatments.ac.run_id | The ID of an Automation Center program run instance. | string |
| treatments.ui.id | The session ID of the instance the campaign is launched via the user interface. | integer |
| treatments.ui.run_id | The run ID of the instance the campaign is launched via the user interface. | string |
| treatments.ui_test.id | The session ID of the instance the test campaign is launched via the user interface. | integer |
| treatments.ui_test.run_id | The run ID of the instance the test campaign is launched via the user interface. | string |
Inbox tag changes
View name: inbox_tag_changes_[customer_ID] (where customer_ID is your Emarsys account ID)
This view contains all the tag changes made on the inbox campaigns for users.
| Data field | Description | Type |
|---|---|---|
| campaign_id | The unique ID of the campaign. | integer |
| application_code | The unique ID of the application. | string |
| contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. |
integer |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
| event_time | The time the tag was updated. | timestamp |
| tag | The name of the tag (high, cancelled, seen, opened, pinned, deleted). | record |
| tag.operation | Option between adding/removing a tag. | string |
| tag.name | The name of the tag (high, cancelled, seen, opened, pinned, deleted). | string |
| platform | The name of the platform (Android, iOS, etc.). | string |
| treatments.rti.id | The ID of an Interactions program. | string |
| treatments.rti.run_id | The ID of an individual Interactions run instance. | string |
| treatments.ac.id | The ID of an Automation Center program. | integer |
| treatments.ac.run_id | The ID of an Automation Center program run instance. | string |
Inbox campaigns
View name: inbox_campaigns_[customer_ID] (where customer_ID is your Emarsys account ID)
This view contains all the inbox campaigns.
| Data field | Description | Type |
|---|---|---|
| campaign_id | The unique ID of the campaign. | integer |
| application_code | The unique ID of the application. | string |
| name | The name of the campaign. | string |
| status | The status of the campaign. | string |
| source | Possible source options: ac, broadcast, segment, me_segment. | string |
| recipient_source_type | The type of the selected recipient source (it can be either AC, segment or a contact list). | string |
| title | The title of the campaign message. | record |
| title.key | Language code key. | string |
| title.value | Language key value. | string |
| message | It contains the message body. | record |
| message.key | Message language code. | string |
| message.value | Message body in the given language. | string |
| segment_id | The ID of the segment applied. | integer |
| recipient_source_id | The numeric ID of the selected recipient source (segment ID, contact list ID). | integer |
| data.key | The ID of the custom data applied to the campaign. | string |
| data.value | The value of the custom data applied to the campaign. | string |
| target | The inbox campaign target. | string |
| collapse_id | The internal/collapse_id set on the campaign. | string |
| settings.key | The ID of the settings. | string |
| settings.value | The value of the settings. | string |
| action_buttons.key | The ID of the action button. | string |
| action_buttons.value | The value of the action button. | string |
| device_filter.key | The ID of the device filtering. | string |
| device_filter.value | The value of the device filtering. | string |
| is_high_priority | High priority tag if set on the campaign. | boolean |
| triggerable_by_push | The inbox campaign can be triggered by a push campaign. | boolean |
| created_at | Campaign creation date (UTC). | timestamp |
| launched_at | The launch time of the campaign. | timestamp |
| scheduled_at | Scheduled time of sending. | timestamp |
| expires_at | The message expiry time of the campaign. | timestamp |
| deleted_at | The time the campaign was deleted. | timestamp |
| event_time | The time the campaign was updated. | timestamp |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
Mobile Engage Client snapshots
View name: client_snapshots_[customer_ID] (where customer_ID is your Emarsys account ID)
This view represents the current state of your mobile user base.
| Data field | Description | Type |
|---|---|---|
| application_code |
Unique code of the application. |
string |
| client_id | hardware _id | string |
| model | Phone model | string |
| platform | Android/iOS | string |
| language | Application language | string |
| timezone | Device timezone | string |
| application_version | Version of the application | string |
| os_version |
Version of the device operation system. |
string |
| sdk_version |
Version of the Emarsys SDK. |
string |
| push_token | Push token value (if available) | string |
| identified_contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files (in case the contact is identified). |
integer |
| anonymous_contact_id | Emarsys internal unique contact ID. Same as the user_id values in the contact export files. (in case the contact is anonymous). |
integer |
| contact_field_id | Field used to identify your contact | string |
| contact_field_value | Value of the contact field | string |
| push_token_status |
Status of the push token. |
string |
| first_event_time |
First mobile activity of the user. |
timestamp |
| last_event_time |
Last mobile activity of the user. |
timestamp |
| loaded_at |
UTC Time - loading to the data platform. |
timestamp |
Client updates
View name: client_state_client_updates_[customer_ID] (where customer_ID is your Emarsys account ID)
| Field Name |
Description |
Type |
|---|---|---|
|
customer_id |
The unique ID of the account. | integer |
| application_code | The unique ID of the application. | string |
| client_id | Device hardware ID | string |
| model | Phone Model | string |
| platform | iOS / Android / Huawei | string |
| language | Application language | string |
| timezone | Device timezone | string |
| application_version | Version of the application | string |
| os_version | Version of the device operation system. | string |
| sdk_version | Version of the Emarsys SDK. | string |
| event_time | The time the campaign was updated. | timestamp |
| loaded_at | Loading date to Data Platform (UTC). | timestamp |
| push_enabled |
push_enabled field has been decommissioned. If it is desired to confirm if push is enabled, please check: push_token IS NOT NUllAND push_token_status IS NULL
|
boolean |