Mailworx: Most-used fields

The table below gives information about most-used fields that you can import from Mailworx. 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	Description	Use in Adverity
Account	Represents a client or organizational entity within the Mailworx platform. It is used as part of the security context for authentication and for retrieving account-specific data such as campaigns and subscribers.	dimension
Bounces Hard	Represents the number of emails that resulted in a permanent delivery failure to recipients during a campaign. This typically occurs due to invalid email addresses or non-existent domains.	metric
Bounces Soft	Represents the number of emails that resulted in a temporary delivery failure to recipients during a campaign. This can happen if the recipient’s mailbox is full or the email server is temporarily unavailable.	metric
Clicks	The total number of clicks on links within an email campaign.	metric
Clicks Rel	The relative number of clicks, often indicating unique clicks or a calculated value derived from total clicks.	metric
Clicks Rel %	The click-through rate, expressed as a percentage, which indicates the proportion of recipients who clicked on a link in an email.	metric
Created	The date and time when a campaign or a specific record was created in the system.	dimension
Last Sent	The date and time when an email campaign was last sent to recipients.	dimension
Mail Client Application	The number of times an email was opened using a desktop mail client application.	metric
Mail Client Mobile	The number of times an email was opened using a mobile device’s mail client.	metric
Mail Client Unknown	Indicates the count of recipients for whom the email client used to open the campaign email could not be identified or determined.	metric
Mail Client Web	The number of times an email was opened using a web-based email client.	metric
Profile Changes	Refers to modifications or updates made to a subscriber’s profile information. This includes changes to fields associated with a subscriber’s record, which can be retrieved or managed via subscriber-related API calls.	metric
Read Mails	The total number of times emails in a campaign were opened by recipients.	metric
Read Mails Rel	The relative number of opened emails, often indicating unique opens or a calculated value derived from total opens.	metric
Read Mails Rel %	The open rate, expressed as a percentage, indicating the proportion of recipients who opened an email.	metric
Total Bounces	The sum of all hard and soft bounces for emails sent in a campaign.	metric
Total Bounces %	The total bounce rate, expressed as a percentage, representing the proportion of emails that resulted in a bounce.	metric
Total Mails Sent	The total number of emails dispatched in a campaign.	metric
Unsubscribe	The total number of recipients who opted out of receiving further communications from a campaign or list.	metric
Unsubscribe %	The unsubscribe rate, expressed as a percentage, indicating the proportion of recipients who unsubscribed from an email campaign.	metric