End-user guides:: Open Data - Data views – Emarsys

Important:

We may change the data structure by adding or removing table columns in Open Data at our own discretion. As these changes may break your exports and queries, we will always notify you in advance of such modifications, to give you time to update your configuration. Please note, however, that Emarsys cannot be held responsible for any losses or damages resulting from such changes.
Please note that when a contact is deleted, all historical data relating to that contact is also deleted, which will be reflected in your Open Data datasets.

To check the contact_id field, you need to export a list of contacts manually, automatically or via the API. This identifier is an internal one for Emarsys. Via the Contacts > Data Export menu in Emarsys, you can gain access to such internal identifiers generated and used internally by Emarsys. Do not rely on these in any way, using our internal variables outside Emarsys as identifiers is considered a risky implementation practice.

The Data platform Big Query tables are raw, not unique tables, which means they may contain duplicates. However, the rate of duplication is extremely low: cca 0.001%.

In case you need exclusively unique data, please perform manual filtering for duplicated events.

Email

Please note that there can be multiple reasons for not seeing contact IDs for example in email_sends_[customer_ID], email_opens_[customer_ID] views:

Test emails are stored with empty contact_id field
Campaigns launched (NOT opened) more than 60 days ago have empty contact_id in the Big Query email_opens table due to the fact that we only keep send data for 60 days
Deleted contacts which were deleted less than 30 days ago as not all the behaviour data may be deleted yet in such cases

Email campaigns

View name: email_campaigns_[customer_ID] (where customer_ID is your Emarsys account ID)

This data view contains all your email campaigns. By running a query, you can get information about all the campaigns that were created or modified in your account.

A campaign may have multiple versions depending on how many times you modified it.

Please use the data view Email campaigns v2, as the Email campaigns data view is going to be deprecated shortly.

This view contains data from August 1st, 2017 onwards.

Data Field	Description	Type
category_id	The category ID.	integer
customer_id	The unique ID of the account.	integer
event_time	Campaign creation/modification time (UTC).	timestamp
id	The ID of the email campaign.	integer
language	The two-character language code.	string
loaded_at	Loading date to Data Platform (UTC).	timestamp
name	The name of the email campaign.	string
parent_campaign_id	The ID of the parent campaign.	integer
program_id	The ID of the Automation Center program, in which the campaign is used.	integer
sub_type	The email campaign sub-type. Possible values are ab, multi_launch, external and unknown.	string
type	The email campaign type. Possible values are test, recurring, onevent, unknown and batch.	string
version_name	The name of the campaign version.	string

Email campaigns v2

View name: email_campaigns_v2_[customer_ID] (where customer_ID is your Emarsys account ID)

This data view contains all your email campaigns with a lot of additional information beyond the basic campaign data. By running a query, you can get information about all the campaigns that were created or modified in your account.

A campaign may have multiple versions depending on how many times you modified it.

This view contains data from August 1st, 2017 onwards.

Data Field	Description	Type
campaign_id	The ID of the campaign.	integer
campaign_type	The campaign type. Possible values are test, batch and transactional.	string
category_name	The category you defined.	string
customer_id	The unique ID of the account.	integer
defined_type	The combination of suite_type, suite_event and campaign_type. The following values are possible: newsletter testmail on_import adhoc recurring event multi_language abtest virtual_contact unknown	string
event_time	Campaign creation/modification time (UTC).	timestamp
is_recurring	If it is a recurring campaign or not.	boolean
language	The two-character language code.	string
loaded_at	Loading date to Data Platform (UTC).	timestamp
name	The name of the campaign.	string
origin_campaign_id	The ID of the parent campaign in case of an email used in a recurring Automation Center program, or the ID of the root campaign in case of AB testing.	integer
program_id	The ID of the Automation Center program, in which the campaign is used.	integer
program_version_id	The version of the Automation Center program, in which the campaign is used.	integer
subject	The non-personalized subject line.	string
suite_event	The sub-type of the campaign.	string
suite_type	The type of the campaign.	string
timezone	The timezone of the campaign.	string
version_name	The name of the campaign version.	string

Please note that this table does not only contain entries related to modifications made by you, but other events as well. Also, note that campaigns are not deduplicated in this table, they are listed based on their modification date.

The suite_type parameter component of defined_type can take up the following values:

The campaign_type parameter component of defined_type can take up the following values:

The suite_event parameter component of defined_type can take up the following values:

none
registration
birthday
tell-a-friend
change profile
contact us
import
date
abandoned (shopping cart)
program (AC)
external
multilanguage
external RTI

The parameter defined_type has a calculated value. This means that it can give a more detailed result compared to campaign_type or suite_type.

For example, A/B test emails will have child email campaigns whose version_name will show if they are the parent campaign (version A) or only a following test (rest of the versions). (Parent campaigns will have the same root_campaign as their own ID.)

If we looked only at the value of suite_type, we would see 3 ad-hoc campaigns.

The same is true for recurring campaigns. suite_type would be able to show only recurring, but defined_type differentiates between parent and child campaigns with the parent_campaign ID (parent campaigns have their own ID as a parent_campaign ID).

The parameter defined_type remains unknown if the campaign is not yet launched, namely it is still being edited.

Email campaign category

View name: email_campaign_categories_[customer_ID] (where customer_ID is your Emarsys account ID)

This data view contains all your campaign categories.

It contains data from January 1st, 2016 onwards.

Data Field	Description	Type
customer_id	The unique ID of the account.	integer
event_time	Category creation time (UTC).	timestamp
id	The ID of the campaign category.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp
name	The name of the campaign category.	string

Email sends

View name: email_sends_[customer_ID] (where customer_ID is your Emarsys account ID)

This data view contains all your sent emails. By running a query, you can get data on which emails were sent in which campaign to which customers.

This view contains data from January 1st, 2016 onwards.

Test campaigns are not listed in the Email sends table. Bounced testmails can be found in the Email bounces table.

Data field	Description	Type
campaign_id	Unique campaign ID.	integer
campaign_type	Whether it is batch or transactional.	string_enum
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 account.	integer
domain	The recipient's domain.	string
event_time	Send time (UTC).	timestamp
launch_id	The unique ID of a launch.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp
message_id	The unique ID of the message in a given campaign. This is the launch list id that identifies an individual email sent to a contact. For example, when emails are sent out to multiple contacts during a launch, all emails sent by Emarsys have an individual identifier called message ID.	integer

Email opens

View name: email_opens_[customer_ID] (where customer_ID is your Emarsys account ID)

This data view contains data collected when your customers opened your emails. By running a query, you can get data on which email has been opened, how many times, by whom, in which campaign, where, and on what device type.

This view contains data from January 1st, 2016 onwards.

Data field	Description	Type
campaign_id	Unique campaign ID.	integer
campaign_type	Batch or transactional.	string_enum
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 account.	integer
domain	The recipient's domain.	string
email_sent_at	Send time (UTC).	timestamp
event_time	Open time (UTC).	timestamp
generated_from	No info available on opens as the tracking pixel was not allowed to download.	string
geo	This record contains all geo-related information.	record
geo_country_iso_code	The country or region associated with the IP address.	string
geo.accuracy_radius	The approximate accuracy radius in kilometres around the latitude and the longitude for the geographical entity.	integer
geo.city_name	The city associated with the IP address.	string
geo.continent_code	The code of the continent associated with the IP address.	string
geo.latitude	Approximate latitude of the postal code / city / country or region associated with the IP address.	float
geo.longitude	Approximate longitude of the postal code / city / country or region associated with the IP address.	float
geo.postal_code	The postal code associated with the IP address.	string
geo.time_zone	The time zone associated with the location.	string
ip	The IP address of the device on which the email was opened.	string
is_anonymized	True if the user_agent was anonymized.	bool
is_mobile	True if the email was opened on a mobile device.	bool
launch_id	The unique ID of a launch.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp
md5	User_agent string md5 hash.	string
message_id	The unique ID of the message in a given campaign. This is the launch list id that identifies an individual email sent to a contact. For example, when emails are sent out to multiple contacts during a launch, all emails sent by Emarsys have an individual identifier called message ID.	integer
platform	Identifies the platform (e.g. Iphone, Windows, etc.).	string
uid	A random hash, generated for the contact as a unique identifier.	string
user_agent	Device and browser info.	string

Email clicks

View name: email_clicks_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows all clicks related to your sent emails, including multiple clicks on the same link. If you are interested in campaign statistics by platform, this view also tells you on which platform your customers click the most.

It contains data from August 1st, 2018 onwards.

Data field	Description	Type
campaign_id	Unique campaign ID.	integer
campaign_type	Batch or transactional.	string_enum
category_id	The ID of the link category.	integer
category_name	The category of the link given in the email editor.	string
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 account.	integer
domain	The recipient's domain.	string
email_sent_at	Send time (UTC).	timestamp
event_time	Click time (UTC).	timestamp
geo	This record contains all geo-related information.	record
geo_country_iso_code	The country or region associated with the IP address.	string
geo.accuracy_radius	The approximate accuracy radius in kilometers around the latitude and the longitude for the geographical entity.	integer
geo.city_name	The city associated with the IP address.	string
geo.continent_code	The code of the continent associated with the IP address.	string
geo.latitude	Approximate latitude of the postal code / city / country or region associated with the IP address.	float
geo.longitude	Approximate longitude of the postal code / city / country or region associated with the IP address.	float
geo.postal_code	The postal code associated with the IP address.	string
geo.time_zone	The time zone associated with the location.	string
ip	The IP address of the device on which the user clicked a link.	string
is_anonymized	True if the user agent was anonymized.	bool
is_img	True if the user clicked an image. Note: This field has valid (true) data only for campaigns created in the old VCMS editor. False for all campaigns created in HTML or VCE.	bool
is_mobile	True if the email was opened on a mobile device.	bool
launch_id	The unique ID of a launch.	integer
link_id	The ID of the link.	integer
link_name	The name of the link given in the email editor.	string
loaded_at	Loading date to Data Platform (UTC).	timestamp
md5	User agent string md5 hash.	string
message_id	The unique ID of the message in a given campaign. This is the launch list id that identifies an individual email sent to a contact. For example, when emails are sent out to multiple contacts during a launch, all emails sent by Emarsys have an individual identifier called message ID.	integer
platform	Identifies the platform (e.g. Iphone, Windows, etc.)	string
section_id	The ID of the section in the email. It refers to the different sections of emails sent using the old VCMS template.	integer
uid	A random hash, generated for the contact as a unique identifier.	string
user_agent	Device and browser info.	string

Email bounces

View name: email_bounces_[customer_ID] (where customer_ID is your Emarsys account ID)

If you find that your open rate is below your expectations, your contact list is probably outdated and our mail sending system cannot deliver all your messages. In this view, you can run queries in order to have a look at the bounces, those messages which could not be delivered for various reasons.

This view contains data from January 1st, 2016 onwards.

Data field	Description	Type
bounce_type	Bounce type. Possible values are block, soft and hard.	string
campaign_id	Unique campaign ID.	integer
campaign_type	Batch or transactional.	string_enum
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 account.	integer
domain	The recipient's domain.	string
email_sent_at	Send time (UTC).	timestamp
event_time	Bounce time (UTC).	timestamp
launch_id	The unique ID of a launch.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp
message_id	The unique ID of the message in a given campaign. This is the launch list id that identifies an individual email sent to a contact. For example, when emails are sent out to multiple contacts during a launch, all emails sent by Emarsys have an individual identifier called message ID.	integer
dsn_reason	The original bounce response code from the SMTP server. This is translated into the `bounce_type`.	string

Email cancels

View name: email_cancels_[customer_ID] (where customer_ID is your Emarsys account ID)

This data view contains all your cancelled email sends. By running a query you can get data on those messages which could not be sent and they were cancelled. An email send can be cancelled by various reasons, for example the contact filed a spam complaint or the contact doesn't have a valid email address. Possible cancel reasons listed below.

This view contains data from November 20th, 2017 onwards.

Data field	Description	Type
campaign_id	Unique campaign ID.	integer
campaign_type	Batch or transactional.	String
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 account.	integer
event_time	Cancel time (UTC).	timestamp
launch_id	The unique ID of a launch.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp
message_id	The unique ID of the message in a given campaign. This is the launch list id that identifies an individual email sent to a contact. For example, when emails are sent out to multiple contacts during a launch, all emails sent by Emarsys have an individual identifier called message ID.	Integer
reason	See Possible cancel reasons.	string
suite_event	The sub-type of the campaign.	string
suite_type	The type of the campaign.	string

Possible cancel reasons

Cancel reason	Description
alternative_text_error	Generation of alternative text failed.
attachment_missing	Attachment cannot be found.
email_duplication	This email is a duplicate, it was already sent to the contact.
empty_address_error	Empty email address.
empty_mail	No content.
encoding_conversion_error	Converting from one charset to another failed.
frequency_cap_blocked	Sending blocked by frequency cap.
html_error	Cannot generate html version of the email.
invalid_email_address_error	Email address doesn't contain “@".
invalid_email_address_rejected_by_pmta	SMTP server found the email address invalid.
invalid_fax_number	Invalid fax number.
missing_or_outdated_data_error	No data or outdated data available for Incentive Recommendation.
opted_out	Contact opted-out before mail launch.
pers_error	Personalization error occured.
program_interrupted	Already scheduled emails canceled because AC program was interrupted.
spamcomplaint_blocked	Contact is on the customer's spamcomplaint list.
system_blocked	Contacts address is on a global blocklist. (e.g. robinson list)
text_error	Cannot generate text version of the email.
too_many_retries	Personalization failed because of too many failed personalization attempts.
triggered_email_blocked	Contact is on triggered email blocklist.
user_blocked	Contacts address is on a customer level blocklist. (e.g: Contact asked not to be disturbed by emails.)

Email complaints

View name: email_complaints_[customer_ID] (where customer_ID is your Emarsys account ID)

This data view contains all complaint events. When a contact complains about a campaign by reporting it as a spam, a new row will be added to this data view.

This view contains data from November 20th, 2017 onwards.

Data field	Description	Type
campaign_id	Unique campaign ID.	integer
campaign_type	Batch or transactional.	string
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 account.	integer
domain	The recipient's domain.	string
email_sent_at	Send time (UTC).	timestamp
event_time	Complaint time (UTC).	timestamp
launch_id	The unique ID of a launch.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp
message_id	The unique ID of the message in a given campaign. This is the launch list id that identifies an individual email sent to a contact. For example, when emails are sent out to multiple contacts during a launch, all emails sent by Emarsys have an individual identifier called message ID.	integer

Email unsubscribes

View name: email_unsubscribes_[customer_ID] (where customer_ID is your Emarsys account ID)

This data view contains all unsubscribe events, except the ones that happened through import or on the UI.

This view contains data from January 1st, 2017 onwards.

Data field	Description	Type
campaign_id	Unique campaign ID.	integer
campaign_type	Batch or transactional.	string
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 account.	integer
domain	The recipient's domain.	string
email_sent_at	Send time (UTC).	timestamp
event_time	Unsubscribe time (UTC).	timestamp
launch_id	The unique ID of a launch.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp
message_id	The unique ID of the message in a given campaign. This is the launch list id that identifies an individual email sent to a contact. For example, when emails are sent out to multiple contacts during a launch, all emails sent by Emarsys have an individual identifier called message ID.	integer
Source	See Possible sources.	string

Possible sources

Source	Description
unsubscribe	Contact used the unsubscribe link in the email to unsubscribe from all marketing email communication.
list_unsubscribe	Contact used the unsubscribe button in their email client to unsubscribe from all marketing email communication.
unsubscribe_from_campaign	Unsubscribe event registered through the API to unsubscribe contact from a specific campaign. Please note that unsubscribe events from custom unsubscribe procedures only appear in Open Data if they used the /v2/email/unsubscribe API call. The API call /v2/email/unsubscribe only registers the unsubscribe event, the actual unsubscribe must be done with v2/contacts/update-contacts.

Calling the /v2/email/unsubscribe API endpont in case of Custom Unsubscribe Solution is crucial for the unsubscribe to show up in Open Data and the Email reporting Screens.

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	Application unique ID.	integer
campaign_id	The unique ID of the campaign.	integer
created_at	Campaign creation date (UTC).	timestamp
customer_id	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
source	Possible source options: ac, broadcast, segment, me_segment.	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

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.

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

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	The campaign source (e.g. automation, segment).	string
title	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
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

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	Device is push enabled.	Boolean

Web Channel

View name: webchannnel_events_enhanced_[customer_ID] (where customer_ID is your Emarsys account ID)

This view contains data from Aug 2018 onwards.

Field name	Description	Type	Example
platform	Identifies the platform (e.g. Iphone, Windows, etc.).	string	Windows
md5	User_agent string md5 hash.	string	ec55d3e698d289f2afd663725127bace
is_mobile	True if the event was registered on a mobile device.	boolean	False
is_anonymized	True if the user_agent was anonymized.	boolean	False
campaign_id	Unique campaign ID.	string	aAaAAa1-Aa
ad_id	Campaign version (Ad) ID.	string	1
customer_id	The unique ID of the account.	integer	1111111111
contact_id	Emarsys internal unique contact ID. Same as the `user_id` values in the contact export files.	integer	1111111111
event_type	The type of event registered. Can be one of `show`, `submit`, `click`	string	Show
user_agent	Device and browser info.	string	Mozilla/5.0 (Android 11; Mobile; rv:96.0) Gecko/96.0 Firefox/96.0
event_time	Event time (UTC).	timestamp	2022-01-18 21:10:10 UTC
loaded_at	Loading date to Data Platform (UTC).	timestamp	2022-01-18 21:19:38.275660 UTC

Web Session

Web session - categories

View name: session_categories_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows the categories the user was browsing in a single session.

It contains data from November 20, 2017 onwards.

Data field	Description	Type
user_id	The Predict user ID (can be an email hash or external ID).	string
user_id_type	The type of the user ID (email hash or external ID).	string
user_id_field_id	Which column contains this information in the Emarsys platform.	integer
contact_id	Emarsys internal unique contact ID. Same as the `user_id` values in the contact export files.	integer
category	The name of the category the user browsed.	string
event_time	The exact time when the user browsed the category.	timestamp
customer_id	The unique ID (account ID) of the customer.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp

Web session - purchase

View name: session_purchases_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows the products purchased by the user in a single session.

It contains data from November 20, 2017 onwards.

Data field	Description	Type
user_id	The Predict user ID (can be an email hash or external ID).	string
user_id_type	The type of user ID (email hash or external ID).	string
user_id_field_id	Which column contains this information in the Emarsys platform.	integer
contact_id	Emarsys internal unique contact ID. Same as the `user_id` values in the contact export files.	integer
items	List of purchased items which include item ID, price, quantity.	record
items.item_id	The unique ID of the purchased item.	string
items.price	The price of the product at the time of purchase.	float
items.quantity	The number of the purchased items.	float
order_id	The unique ID of the order.	string
event_time	The exact time when the user bought the items.	timestamp
customer_id	The unique ID (account ID) of the customer.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp

Web session - tags

View name: session_tags_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows the events that occurred during a single session.

It contains data from November 20, 2017 onwards.

Data field	Description	Type
user_id	The predict user ID (can be an email hash or external ID).	string
user_id_type	The type of user ID (email hash or external ID).	string
user_id_field_id	Which column contains this information in the Emarsys platform.	integer
contact_id	Emarsys internal unique contact ID. Same as the `user_id` values in the contact export files.	integer
tag	The tag sent by the website - It is the type of the event.	string
attributes	This list contains all the attributes related to the event.	record
attributes.name	The name of the attribute.	string
attributes.string_value	String values are stored here.	string
attributes.number_value	Number values are stored here.	float
attributes.boolean_value	Logical values are stored here.	boolean
event_time	The exact time when the event happened.	timestamp
customer_id	The unique ID (account ID) of the customer.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp

Web sessions - views

View name: session_views_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows the products which the user browsed in a single session.

It contains data from November 20, 2017 onwards.

Data field	Description	Type
user_id	The Predict user ID (can be an email hash or external ID).	string
user_id_type	The type of user ID (email hash or external ID).	string
user_id_field_id	Which column contains this information in the Emarsys platform.	integer
contact_id	Emarsys internal unique contact ID. Same as the `user_id` values in the contact export files.	integer
item_id	The unique ID of the item which was browsed by the user during the session.	string
event_time	The exact time when the user checked the item.	timestamp
customer_id	The unique ID (account ID) of the customer.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp

Web sessions

View name: sessions_[customer_ID] (where customer_ID is your Emarsys account ID)

This view contains all the information we have about a session. This view was divided into several smaller views, as shown above. It is recommended to use the smaller views in the queries as they are more efficient.

This view includes all the data from those views as well as one extra piece of information: the list of the last cart items (Abandoned cart).

This view contains data from November 20, 2017 onwards.

Data field	Description	Type
start_time	The start time of the user's session.	timestamp
end_time	The end time of the user's session.	timestamp
purchases	Record which includes the purchase time, items, price, quantity and order ID.	record
purchases.event_time	The time when the purchase happened.	timestamp
purchases.items	The list of purchased items with item id, price, quantity included.	record
purchases.items.item_id	The unique id of the purchased item.	string
purchases.items.price	The price of the product at the time of purchase.	float
purchases.items.quantity	The number of purchased items.	float
purchases.order_id	The unique order ID of the purchase.	string
views	This record contains those items which were viewed by the user during the session.	record
views.event_time	The exact time when the user viewed the item.	timestamp
views.item_id	The unique ID of the item which was viewed by the user during the session.	string
tags	A list which contains the custom events.	record
tags.event_time	This is the exact time when the event with this tag happened.	timestamp
tags.tag	This is the tag which was sent by the website.	string
tags.attributes	This list contains all the attributes related to the event.	record
tags.attributes.name	This is the name of the attribute.	string
tags.attributes.string_value	String values are stored here.	string
tags.attributes.number_value	Number values are stored here.	float
tags.attributes.boolean_value	Logical values are stored here.	boolean
categories	This involves all the categories which were browsed by the user during the session.	record
categories.event_time	The exact time when the user browsed the category.	timestamp
categories.category	The name of the category which was browsed by the user.	string
last_cart	All items added to the cart but not purchased and were still in the cart at the end of the session.	record
last_cart.event_time	This is the exact time when the last item was added to or removed from the cart.	timestamp
last_cart.items	The list of items that were added to the cart and were still there at the end of the session.	record
last_cart.items.item_id	The unique ID of the product which was in the cart at the end of the session.	string
last_cart.items.price	The price of the product at the end of the session.	float
last_cart.items.quantity	The quantity of the product at the end of the session.	float
user_id	The Predict user ID (can be an email hash or external ID).	string
user_id_type	The type of user ID (email hash or external ID).	string
user_id_field_id	Which column contains this information in the Emarsys platform.	integer
contact_id	Emarsys internal unique contact ID. Same as the `user_id` values in the contact export files.	integer
currency	The currency of the purchase.	string
customer_id	The unique ID (account ID) of the customer.	integer
loaded_at	Loading date to Data Platform (UTC).	timestamp

Web push

Web push campaigns

View name: web_push_campaigns_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows you all your web push campaigns, including all language versions.

Web push sends

View name: web_push_sends_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows you all information about your web push sends.

Web push not sends

View name: web_push_not_sends_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows you which web push messages could not be sent.

Web push clicks

View name: web_push_clicks_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows you the actual user actions.

Web push custom events

View name: web_push_custom_events_[customer_ID] (where customer_ID is your Emarsys account ID)

This view shows you all your web push custom events.

Data field	Description	Type
contact_id	Emarsys internal unique contact ID. Same as the `user_id` values in the contact export files.	integer
client_id	Hardware_id	string
domain_code	The recipient's domain_code.	string
domain	The recipient's domain.	string
platform	Identifies the platform (e.g. Google Chrome, Firefox, etc.).	string
sdk_version	Version of the Emarsys SDK.	string
loaded_at	UTC Time - loading to the data platform.	timestamp
event_attributes	Any custom attribute.	record
event_attributes.k	Attribute key.	string
event_attributes.v	Attribute value.	string
event_time	The send time of the message.	timestamp