Brevo: Most-used fields

The table below gives information about most-used fields that you can import from Brevo. 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
Sent	sent	The total number of emails sent for the campaign.	metric
abTesting	abTesting	Indicates if A/B testing is enabled for the campaign. If ‘true’, ‘subjectA’, ‘subjectB’, ‘splitRule’, ‘winnerCriteria’, and ‘winnerDelay’ will be considered.	dimension
appleMppOpens	appleMppOpens	The number of opens attributed to Apple Mail Privacy Protection (MPP).	metric
attachmentFile	attachmentFile	The absolute URL of an attachment to be included with the email campaign. Supported file types include various document, image, and archive formats.	dimension
browser	browser	The type of browser used by the recipient when viewing the email campaign, e.g., Chrome, Firefox. This is derived from browser statistics.	dimension
clickers	clickers	The total number of individual recipients who clicked a link within the email campaign at least once.	metric
complaints	complaints	The total number of recipients who marked the email campaign as spam or complained.	metric
createdAt	createdAt	The UTC date and time when the email campaign was created.	dimension
date	date	The date and time when the email campaign was created or scheduled. This field supports filtering to retrieve campaigns within a specified date range.	dimension
deferred	deferred	The count of emails that were temporarily delayed and will be retried later by the sending server.	metric
delivered	delivered	The total number of emails successfully delivered to recipients.	metric
device	device	The type of device used by the recipient when viewing the email campaign, e.g., Mobile, Desktop. This is derived from device statistics.	dimension
device_type	device_type	The broad category of device used by the recipient to view the email campaign, such as ‘desktop’ or ‘mobile’.	dimension
domain	domain	The email domain of the recipient, used for aggregating statistics by domain.	dimension
estimatedViews	estimatedViews	The estimated number of times the email campaign was viewed by recipients. This metric is part of the global statistics for an email campaign.	metric
footer	footer	Optional content that appears at the bottom of the email campaign. This field allows for custom text or HTML to be included in the footer section of marketing emails.	dimension
hardBounces	hardBounces	The total number of emails that resulted in a hard bounce, indicating a permanent delivery failure.	metric
header	header	Optional content that appears at the top of the email campaign. This field allows for custom text or HTML to be included in the header section of marketing emails.	dimension
htmlContent	htmlContent	The HTML version of the email campaign’s body content.	dimension
id	id	The unique identifier of the email campaign.	dimension
links_clicks	links_clicks	The total number of clicks on links within the email campaign.	metric
list_folderId	list_folderId	The unique identifier of the folder where the contact list is organized.	metric
list_id	list_id	The unique identifier of the contact list.	dimension
list_name	list_name	The name of the contact list.	dimension
list_totalBlacklisted	list_totalBlacklisted	The total number of contacts within a specific list who have been blacklisted, either for email or SMS communications.	metric
list_totalSubscribers	list_totalSubscribers	The total count of subscribers or contacts associated with a specific mailing list.	metric
mirrorActive	mirrorActive	Indicates if mirror links are activated in the campaign. If ‘true’, recipients can view the email in their browser.	dimension
mirrorClick	mirrorClick	The count of clicks on the mirror link (web version) of the email campaign.	metric
modifiedAt	modifiedAt	The UTC date and time when the email campaign was last modified.	dimension
name	name	The name of the email campaign.	dimension
opensRate	opensRate	The percentage of recipients who opened the email out of the total number of recipients.	metric
previewText	previewText	The preview text or preheader of the email campaign, displayed in the recipient’s inbox before the subject line.	dimension
recipients_exclusionLists	recipients_exclusionLists	A list of IDs for contact lists to be excluded from the campaign recipients.	dimension
recipients_lists	recipients_lists	A list of IDs for contact lists to be included as recipients of the campaign.	metric
replyTo	replyTo	The email address to which campaign recipients can reply.	dimension
returnBounce	returnBounce	The count of emails that bounced back from the recipient’s server.	metric
scheduledAt	scheduledAt	The UTC date and time when the campaign is scheduled to run. If ‘sendAtBestTime’ is true, only the date part is considered.	dimension
sendAtBestTime	sendAtBestTime	If ‘true’, the campaign will be sent at the best time for engagement, based on Brevo’s optimization.	dimension
sender_email	sender_email	The email address of the sender for the campaign.	dimension
sender_id	sender_id	The unique identifier of the sender.	dimension
sender_name	sender_name	The name of the sender for the campaign.	dimension
sentDate	sentDate	The date when the email campaign was sent.	dimension
shareLink	shareLink	The URL to share the email campaign online.	dimension
softBounces	softBounces	The total number of emails that resulted in a soft bounce, indicating a temporary delivery failure.	metric
splitRule	splitRule	The size of the test groups for an A/B test campaign, expressed as a percentage. Mandatory if A/B testing is enabled.	metric
status	status	The current status of the email campaign (e.g., sent, draft, scheduled).	dimension
subject	subject	The subject line of the email campaign.	dimension
subjectA	subjectA	The subject line for version A of an A/B test campaign. Mandatory if A/B testing is enabled.	dimension
subjectB	subjectB	The subject line for version B of an A/B test campaign. Mandatory if A/B testing is enabled.	dimension
tag	tag	A tag associated with the email campaign for categorization or filtering.	dimension
testSent	testSent	Indicates if the campaign was sent as a test.	dimension
toField	toField	Customization for the ‘To’ field of the email, allowing for personalization using contact attributes like first name and last name.	dimension
trackableViews	trackableViews	The total number of times the email campaigns have been opened, including multiple opens by the same recipient.	metric
trackableViewsRate	trackableViewsRate	The percentage of trackable views for the email campaign, indicating the rate at which recipients opened or viewed the campaign.	metric
type	type	The type of email campaign (e.g., classic, trigger).	dimension
uniqueClicks	uniqueClicks	The total number of individual recipients who clicked a link in the email campaign at least once.	metric
uniqueViews	uniqueViews	The total number of individual recipients who opened the email at least once. It is counted as 1 even when opened multiple times by the same recipient.	metric
unsubscriptions	unsubscriptions	The total number of recipients who unsubscribed from the email campaign.	metric
utmCampaignValue	utmCampaignValue	The customized value for the ‘utm_campaign’ UTM parameter. If empty, the campaign name is used.	dimension
utmID	utmID	The unique campaign ID used for UTM tracking, allowing for specific campaign identification in analytics.	metric
utmMedium	utmMedium	The UTM parameter identifying the marketing medium, such as ‘email’ or ‘cpc’.	dimension
utmSource	utmSource	The UTM parameter identifying the source of the traffic, such as ‘newsletter’ or ‘google’.	dimension
viewed	viewed	The total number of times the email campaign was viewed.	metric
winnerCriteria	winnerCriteria	The metric used to determine the winning version in an A/B test (e.g., ‘open’ for open rate, ‘click’ for click rate). Mandatory if ‘splitRule’ is between 1% and 49%.	dimension
winnerDelay	winnerDelay	The duration of the A/B test in hours, after which the winning version is sent. Mandatory if ‘splitRule’ is between 1% and 49%.	metric