Emarsys: Most-used fields

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

metric

block_bounces

block_bounces

The number of emails returned to sender due to being blocked by spam filters.

metric

campaign

campaign

Campaign.

metric

campaignId

campaignId

Campaign ID.

metric

campaignName

campaignName

Campaign name.

dimension

complained

complained

The number of recipients who marked the email as spam in their email client.

metric

contacts

contacts

metric

date

date

Date.

dimension

email_subject

email_subject

Email subject.

dimension

endDate

endDate

End date.

dimension

hardBounced

hardBounced

metric

hard_bounces

hard_bounces

The number of emails returned to sender due to permanent problems.

metric

id

id

The unique indentifier of the object.

dimension

launch

launch

metric

launchId

launchId

metric

launch_date

launch_date

dimension

launch_done

launch_done

dimension

launch_id

launch_id

The identifier 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.

metric

name

name

dimension

opened

opened

The number of emails opened by recipients. Note: Tracks only HTML emails where images were displayed to the recipient.

metric

planned

planned

The total number of contacts assigned to the launch.

metric

sent

sent

The number of emails already sent from our servers.

metric

softBounced

softBounced

metric

soft_bounces

soft_bounces

The number of emails returned to sender due to temporary problems.

metric

startDate

startDate

Start date.

dimension

timestamp

timestamp

Timestamp.

dimension

totalClicked

totalClicked

metric

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

uniqueClicked

uniqueClicked

metric

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