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
bounces	bounces	The total count of messages that could not be delivered to the recipient’s inbox, often due to invalid addresses or server issues.	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.tags	campaign.tags	A list of tags associated with a campaign, used for organization and filtering.	dimension
canvas_id	canvas_id	A unique identifier for a specific Canvas journey.	dimension
canvas_name	canvas_name	The name of the Canvas journey as configured in Braze.	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
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
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
id	id	A generic unique identifier for an entity.	metric
impressions	impressions	The total number of times a message or content was displayed to users.	metric
messages.amp_body	messages.amp_body	The AMP (Accelerated Mobile Pages) HTML content of a message, providing interactive email experiences.	dimension
messages.body	messages.body	The main content body of a message, typically in HTML or plain text format.	dimension
messages.channel	messages.channel	The specific communication channel for a message within a campaign or Canvas step (e.g., email, push).	dimension
messages.from	messages.from	The sender’s identity for a message, such as the ‘From’ email address.	dimension
messages.headers	messages.headers	Custom headers included with a message, often used for email configuration or tracking.	dimension
messages.message	messages.message	The textual or rich media content of the message itself.	dimension
messages.message_variation_id	messages.message_variation_id	A unique identifier for a specific variation of a message used in a campaign or Canvas.	dimension
messages.preheader	messages.preheader	The preheader text for an email message, displayed after the subject line in an inbox.	dimension
messages.reply_to	messages.reply_to	The email address to which replies to a message should be directed.	dimension
messages.should_inline_css	messages.should_inline_css	A boolean indicating whether CSS styles should be inlined into the HTML of an email message.	dimension
messages.should_whitespace_preheader	messages.should_whitespace_preheader	A boolean indicating whether a preheader should be filled with whitespace to hide subsequent email body content.	dimension
messages.subject	messages.subject	The subject line of an email message.	dimension
messages.title	messages.title	The title of a message, often used for in-app messages or push notifications.	dimension
name	name	The name of an entity (e.g., campaign, Canvas, custom event).	dimension
next_paths	next_paths	A list of potential paths or steps that can be taken after a specific point in a Canvas journey.	dimension
next_paths.name	next_paths.name	The name of a subsequent path or step in a Canvas journey.	dimension
next_paths.next_step_id	next_paths.next_step_id	The identifier of the next step in a Canvas journey following a specific path.	dimension
next_step_ids	next_step_ids	A list of identifiers for the steps that immediately follow a given step in a Canvas.	dimension
opens	opens	The total number of times a message, typically an email, was opened by recipients.	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
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 number of unique users who opened a message, typically an email.	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