Emarsys#
The table below gives information about all the data fields that you can import from Emarsys.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs. As a result, the fields shown here may not be the same as the fields available in Adverity. If you notice a difference between this documentation and the fields you see in Adverity, please contact your Adverity account manager for more information.
To see the fields you can collect from another data source, go back to the Available fields in Adverity overview.
Field UI name |
Field API name |
Description |
Use in Adverity |
---|---|---|---|
block_bounces |
block_bounces |
The number of emails returned to sender due to being blocked by spam filters. |
metric |
bounced |
bounced |
The total number of bounces. |
metric |
bounced_block |
bounced_block |
The number of emails returned to sender due to being blocked by spam filters. |
metric |
bounced_hard |
bounced_hard |
The number of emails returned to sender due to permanent problems. |
metric |
bounced_soft |
bounced_soft |
The number of emails returned to sender due to temporary problems. |
metric |
campaign |
campaign |
Campaign. |
dimension |
campaignId |
campaignId |
Campaign ID. |
dimension |
campaignName |
campaignName |
Campaign name. |
dimension |
campaign_category |
campaign_category |
The name of the campaign category. |
dimension |
campaign_id |
campaign_id |
The identifier of the campaign. |
metric |
campaign_name |
campaign_name |
The name of the campaign. |
dimension |
canceled |
canceled |
The number of emails that were not sent due to error. |
metric |
clicked |
clicked |
The number of emails clicked by recipients. |
metric |
clicked_anonymous |
clicked_anonymous |
The number of emails anonymously clicked by recipients. |
metric |
complained |
complained |
The number of recipients who marked the email as spam in their email client. |
metric |
customer_id |
customer_id |
The identifier of the customer. |
metric |
date |
date |
Date. |
dimension |
email_subject |
email_subject |
Email subject. |
dimension |
endDate |
endDate |
End date. |
dimension |
hard_bounces |
hard_bounces |
The number of emails returned to sender due to permanent problems. |
metric |
has_multi_launch |
has_multi_launch |
The campaign has multiple launches. |
dimension |
id |
id |
The unique indentifier of the object. |
dimension |
is_ab |
is_ab |
The campaign has A/B versions. |
dimension |
is_final |
is_final |
The launch is not a test. |
dimension |
launch_id |
launch_id |
The identifier of the launch. |
metric |
launch_name |
launch_name |
The name of the launch. |
dimension |
launches |
launches |
The number of launches in the given time range. If launch_id and dates are also provided: Returns the number of launches with the provided identifier (if the table contains identifiers). Returns the number of launches between the provided dates (if the table contains dates). |
metric |
linkId |
linkId |
The identifier of the tracked link. |
dimension |
mobile_clicked |
mobile_clicked |
The number of emails clicked on a mobile device by recipients. |
metric |
mobile_opened |
mobile_opened |
The number of emails opened on a mobile device by recipients. |
metric |
opened |
opened |
The number of emails opened by recipients. Note: Tracks only HTML emails where images were displayed to the recipient. |
metric |
parent_campaign_id |
parent_campaign_id |
The identifier of the parent campaign. |
metric |
parent_campaign_name |
parent_campaign_name |
The name of the parent campaign. |
dimension |
planned |
planned |
The total number of contacts assigned to the launch. |
metric |
privacy_opened |
privacy_opened |
The number of emails opened automatically by recipients. |
metric |
program_id |
program_id |
The identifier of the used program. |
metric |
purchased |
purchased |
The number of purchases attributed to the campaign. |
metric |
revenue |
revenue |
The amount of revenue generated by the campaign. |
metric |
section_id |
section_id |
The identifier of the email campaign section of the URL. |
dimension |
sent |
sent |
The number of emails already sent from our servers. |
metric |
soft_bounces |
soft_bounces |
The number of emails returned to sender due to temporary problems. |
metric |
start |
start |
The Unix timestamp of the launch’s start. |
metric |
startDate |
startDate |
Start date. |
dimension |
timestamp |
timestamp |
Timestamp. |
dimension |
total_clicks |
total_clicks |
The number of total clicks on links tracked by the Emarsys application. Counts multiple clicks per contact. |
metric |
tracked_url |
tracked_url |
Tracked URL. |
dimension |
type |
type |
The type of the campaing’s channel. |
dimension |
unique_clicks |
unique_clicks |
The number of unique clicks on links tracked by the Emarsys application. Counts only a single click per contact. |
metric |
unsubscribe |
unsubscribe |
The number of clicks on the unsubscribe link. |
metric |
unsubscribed |
unsubscribed |
The number of clicks on the unsubscribe link. |
metric |
url |
url |
The URL of the tracked link. |
dimension |
version_name |
version_name |
The name of the campaign’s version. |
dimension |