Emarsys: Most-used fields#
The table below gives information about most-used fields that you can import from Emarsys. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
blockBounced |
blockBounced |
The number of emails returned to sender due to being blocked by spam filters. |
metric |
block_bounces |
block_bounces |
The number of emails returned to sender due to being blocked by spam filters. |
metric |
bounced_block |
bounced_block |
The number of emails returned to the sender because they were blocked by spam filters or email servers. |
metric |
bounced_hard |
bounced_hard |
The number of emails that resulted in a hard bounce, indicating a permanent delivery failure due to reasons like an invalid or non-existent email address. |
metric |
bounced_soft |
bounced_soft |
The number of emails that resulted in a soft bounce, indicating a temporary delivery issue, such as a full mailbox or a temporary server problem. |
metric |
campaign |
campaign |
The identifier of the email campaign. |
metric |
campaignId |
campaignId |
The identifier of the email campaign. |
metric |
campaignName |
campaignName |
The name of the email campaign. |
dimension |
campaign_id |
campaign_id |
A unique numerical identifier assigned to the email campaign. |
dimension |
campaign_name |
campaign_name |
The user-defined name of the email campaign. |
dimension |
complained |
complained |
The number of recipients who marked the email as spam in their email client. |
metric |
contacts |
contacts |
The total number of contacts, which can refer to the count of contacts within a segment or contact list. |
metric |
date |
date |
The specific date associated with a campaign event, such as the creation date of an email campaign or a launch date. |
dimension |
email_subject |
email_subject |
The subject line of the email campaign. |
dimension |
endDate |
endDate |
The end date for a reporting period or campaign duration. |
dimension |
hardBounced |
hardBounced |
The number of emails returned to sender due to permanent problems. |
metric |
hard_bounces |
hard_bounces |
The number of emails returned to sender due to permanent problems. |
metric |
id |
id |
A unique identifier for an entity such as a campaign, launch, or tracked link. |
dimension |
launch |
launch |
Indicates the status or details related to the initiation and sending process of the email campaign. |
metric |
launchId |
launchId |
The identifier of a specific campaign launch. |
metric |
launch_date |
launch_date |
The scheduled or actual date and time when an email campaign was launched. |
dimension |
launch_done |
launch_done |
Indicates whether the email campaign launch process has been completed. |
dimension |
launch_id |
launch_id |
The identifier of a specific campaign launch. |
dimension |
launches |
launches |
The number of launches within a given time range or a collection of launch details. |
metric |
linkId |
linkId |
The identifier of a specific tracked link within an email campaign. |
metric |
name |
name |
The name of an entity, such as an email campaign. |
dimension |
opened |
opened |
The number of times emails were opened by recipients. |
metric |
planned |
planned |
The total number of contacts assigned to the launch. |
metric |
sent |
sent |
The number of emails successfully sent from Emarsys servers. |
metric |
softBounced |
softBounced |
The number of emails returned to sender due to temporary problems. |
metric |
soft_bounces |
soft_bounces |
The number of emails returned to sender due to temporary problems. |
metric |
start |
start |
The date when the email campaign was created or when its active period began. |
dimension |
startDate |
startDate |
The start date for a reporting period or campaign duration. |
dimension |
timestamp |
timestamp |
A point in time, often indicating when an event occurred or when data was recorded. |
dimension |
totalClicked |
totalClicked |
The total number of clicks on links tracked within an email campaign, counting multiple clicks per contact. |
metric |
total_clicks |
total_clicks |
The total number of clicks on links tracked within an email campaign, counting multiple clicks per contact. |
metric |
tracked_url |
tracked_url |
The URL of a tracked link within an email campaign. |
dimension |
type |
type |
The type of the email campaign, such as batch_email or transactional_email. |
dimension |
uniqueClicked |
uniqueClicked |
The number of unique clicks on links tracked within an email campaign, counting only a single click per contact. |
metric |
unique_clicks |
unique_clicks |
The number of unique clicks on links tracked within an email campaign, counting only a single click per contact. |
metric |
unsubscribe |
unsubscribe |
The number of clicks on the unsubscribe link within an email campaign. |
metric |
unsubscribed |
unsubscribed |
The number of clicks on the unsubscribe link within an email campaign. |
metric |
url |
url |
The URL of a tracked link within an email campaign. |
dimension |