Braze: Most-used fields

The table below gives information about most-used fields that you can import from Braze. 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
archived	archived	A boolean indicator specifying whether the campaign or Canvas is in an archived state. Archived items are typically no longer active or visible in default lists but can be retrieved.	dimension
bounces	bounces	Indicates the number of email messages that could not be delivered to recipients due to a permanent error, such as an invalid email address. This typically refers to ‘hard bounces’.	metric
button_clicks	button_clicks	The total number of clicks on buttons within a message or campaign.	metric
campaign.id	campaign.id	A unique identifier for a specific marketing campaign in Braze.	dimension
campaign.name	campaign.name	The name of the marketing campaign as configured in Braze.	dimension
campaign.tag	campaign.tag	A label or keyword used to categorize and organize campaigns, enabling easier search and filtering.	dimension
campaign.tags	campaign.tags	A list of tags associated with a campaign, used for organization and filtering.	dimension
channel	channel	The communication channel through which a message was sent (e.g., email, push, SMS, in-app).	dimension
channels	channels	A list of communication channels used or available within a campaign or Canvas.	dimension
clicks	clicks	The total number of clicks recorded for a campaign or message, often referring to links within the content.	metric
conversion_behaviors.type	conversion_behaviors.type	The type of conversion behavior tracked for a campaign or Canvas, such as a purchase, app install, or custom event.	dimension
conversion_behaviors.window	conversion_behaviors.window	The time period following a user’s interaction with a campaign or Canvas during which a conversion event is attributed to that campaign or Canvas.	metric
conversions	conversions	The total number of conversions attributed to a campaign or message, indicating a desired action taken by the recipient.	metric
created_at	created_at	The date and time when an entity (e.g., campaign, Canvas) was created.	dimension
created_at_timestamp	created_at_timestamp	The Unix timestamp representing when an entity (e.g., campaign, Canvas) was created.	dimension
delivered	delivered	The total number of messages successfully delivered to recipients.	metric
delivery_failed	delivery_failed	Indicates if the delivery of a message failed, often due to temporary issues or invalid recipient data.	metric
description	description	A textual explanation or summary of the campaign, Canvas, custom attribute, or event.	dimension
draft	draft	Indicates if a campaign or Canvas is in a preliminary, unsent state, allowing for edits before it is activated or scheduled.	dimension
enabled	enabled	A boolean indicator representing whether a feature, campaign, or configuration is currently active and operational.	dimension
enrolled	enrolled	The total count of users who have entered a specific Canvas or campaign journey.	metric
errors	errors	A collection of error messages or codes encountered during processing or delivery.	metric
fallback_sms_delivered	fallback_sms_delivered	Indicates when an SMS message, sent as a fallback to an undeliverable RCS message, has been successfully delivered to the recipient’s device.	metric
fallback_sms_rejected	fallback_sms_rejected	Indicates when an SMS message, sent as a fallback to an undeliverable RCS message, has been rejected and could not be delivered to the recipient.	metric
first_sent	first_sent	The date and time (in ISO 8601 format) when the campaign or message was first sent.	dimension
impressions	impressions	The total number of times a message or content was displayed to users.	metric
last_sent	last_sent	The date and time (in ISO 8601 format) when the campaign or message was most recently sent.	dimension
message	message	Refers to the content or structured data of a message within a campaign, such as email body, push notification text, or in-app message content.	dimension
name	name	The name of an entity (e.g., campaign, Canvas, custom event).	dimension
opens	opens	The total count of times a message, such as an email, was opened by recipients. This metric is a key indicator of recipient engagement with messaging campaigns.	metric
opt_in	opt_in	Indicates if a user has opted in to receive communications for a specific channel or subscription group.	metric
opt_out	opt_out	Indicates if a user has opted out of receiving communications for a specific channel or subscription group.	metric
rcs_button_reply_click	rcs_button_reply_click	The number of times a user clicked on a Quick Reply button in an RCS message.	metric
rcs_button_url_click	rcs_button_url_click	The number of times a user clicked on a URL button within an RCS message.	metric
rcs_click	rcs_click	The total number of clicks on any interactive element or link within an RCS message.	metric
rcs_delivered	rcs_delivered	Indicates that an RCS message has been successfully delivered to the recipient’s device.	metric
rcs_read	rcs_read	Indicates that an RCS message has been opened and viewed by the recipient.	metric
rcs_rejected	rcs_rejected	Indicates that an RCS message was not successfully delivered to the recipient, often due to network issues, invalid numbers, or carrier restrictions.	metric
rcs_sent	rcs_sent	The total count of RCS messages that have been successfully sent to reachable recipients.	metric
rcs_suggested_reply_click	rcs_suggested_reply_click	The number of times a user clicked on a suggested reply option in an RCS message.	metric
rcs_suggested_url_click	rcs_suggested_url_click	The number of times a user clicked on a suggested URL option in an RCS message.	metric
rejected	rejected	The total count of messages that were rejected by the recipient’s server or the sending platform.	metric
reported_spam	reported_spam	The total number of recipients who marked a message as spam.	metric
revenue	revenue	The total revenue generated as a result of campaign or message interactions.	metric
schedule_type	schedule_type	The method or pattern by which a campaign or Canvas is scheduled to be sent, such as immediate, at a specific time, or recurring.	dimension
sent	sent	The total number of messages sent as part of a campaign or Canvas.	metric
time	time	The specific timestamp or time period associated with the data point.	dimension
total_clicks	total_clicks	The aggregate sum of all clicks on any interactive element within a message or campaign.	metric
total_dismissals	total_dismissals	The total count of times an in-app message or content card was dismissed by users.	metric
total_impressions	total_impressions	The aggregate sum of all impressions for messages or content across a campaign or Canvas.	metric
total_opens	total_opens	The aggregate sum of all opens for messages within a campaign or Canvas.	metric
type	type	The category or kind of an entity, such as campaign type, Canvas step type, or message type.	dimension
unique_clicks	unique_clicks	The number of unique users who clicked on any interactive element within a message or campaign.	metric
unique_dismissals	unique_dismissals	The number of unique users who dismissed an in-app message or content card.	metric
unique_impressions	unique_impressions	The number of unique users who viewed a message or content, generating an impression.	metric
unique_opens	unique_opens	The total number of delivered messages opened by a single user at least once. This metric provides insight into the distinct reach of a message.	metric
unique_recipients	unique_recipients	The total number of distinct recipients targeted by a campaign or message.	metric
unsubscribes	unsubscribes	The total count of recipients who unsubscribed from communications.	metric
updated_at	updated_at	The date and time when an entity (e.g., campaign, Canvas) was last updated.	dimension
updated_at_timestamp	updated_at_timestamp	The Unix timestamp representing when an entity (e.g., campaign, Canvas) was last updated.	dimension
variation_api_id	variation_api_id	A unique identifier for a specific variation within a campaign or Canvas step.	dimension
variation_name	variation_name	The name of the specific variation used in A/B testing or personalized messaging.	dimension