Cordial: Most-used fields#
The table below gives information about most-used fields that you can import from Cordial. 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 |
|---|---|---|---|
_id |
_id |
Unique identifier for the message. |
dimension |
action |
Represents a specific interaction performed by a contact, such as opening a message, clicking a link, opting out, or a custom event. |
dimension |
|
aov |
aov |
The average order value generated from the message. |
metric |
bounceRate |
bounceRate |
The rate at which messages bounced, calculated as total bounced messages divided by total sent messages. |
metric |
bouncedHard |
bouncedHard |
The total number of hard bounced messages, indicating a permanent delivery failure. |
metric |
bouncedSoft |
bouncedSoft |
The total number of soft bounced messages, indicating a temporary delivery issue. |
metric |
cID |
A unique identifier assigned to a contact within the Cordial platform. This ID is used to retrieve, update, and manage contact records and their associated activities. In the API response, this field is referred to as ‘_id’. |
dimension |
|
clicksTotal |
clicksTotal |
The total number of clicks on links within the message. |
metric |
clicksUnique |
clicksUnique |
The total number of unique contacts who clicked on links within the message. |
metric |
complaintRate |
complaintRate |
The rate at which recipients marked the message as spam or complained. |
metric |
complaintsTotal |
complaintsTotal |
The total number of times recipients marked the message as spam or complained. |
metric |
datetime.sendTime |
datetime.sendTime |
The date and time when the message was sent. |
dimension |
delivered |
delivered |
The total number of messages successfully delivered to recipients. |
metric |
deliveryRate |
deliveryRate |
The rate at which messages were successfully delivered, calculated as total delivered messages divided by total sent messages. |
metric |
The email address associated with a contact, serving as a primary identifier within the platform. |
dimension |
||
id |
A unique identifier for various entities within the Cordial platform, such as an export job, a contact, a message, or an order. |
dimension |
|
link |
Refers to the URL or identifier of a link within a message, used for tracking clicks and attributing revenue. |
dimension |
|
name |
name |
The name of the message. |
dimension |
openRate |
openRate |
The rate at which unique recipients opened the message. |
metric |
opensTotal |
opensTotal |
The total number of times the message was opened. |
metric |
opensUnique |
opensUnique |
The total number of unique contacts who opened the message. |
metric |
optoutRate |
optoutRate |
The rate at which recipients opted out or unsubscribed from communications after receiving the message. |
metric |
properties |
An object containing additional attributes or metadata associated with an event or other data entities. |
dimension |
|
revenue |
revenue |
The total revenue generated from the message. |
metric |
sendTime |
sendTime |
The date and time when the message was sent. |
dimension |
subject |
subject |
The subject line of the message. |
dimension |
tags |
tags |
Tags associated with the message, used for categorization and filtering. |
dimension |
time |
This field represents the time-related data associated with various marketing activities within the Cordial platform. Depending on the data stream, it can refer to the send time of a message in message analytics or the timestamp of a specific contact activity like an open, click, or opt-out event. |
dimension |
|
totalBounced |
totalBounced |
The total number of messages that bounced (failed to deliver). |
metric |
totalPurchases |
totalPurchases |
The total number of purchases attributed to the message. |
metric |
totalSent |
totalSent |
The total number of messages sent. |
metric |