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	Indicates whether a campaign or Canvas is archived, meaning it is no longer active but its data is retained.	dimension
bounces	bounces	The number of messages that were undeliverable to a recipient’s inbox, often categorized as soft or hard bounces.	metric
button_clicks	button_clicks	The count of clicks on interactive buttons within messages, such as those in in-app messages or push notifications.	metric
campaign.id	campaign.id	The unique identifier for a specific campaign.	dimension
campaign.name	campaign.name	The name of the campaign.	dimension
campaign.tag	campaign.tag	A single tag associated with a campaign for organization.	dimension
campaign.tags	campaign.tags	A list of tags associated with the campaign, used for categorization and filtering.	dimension
canvas_id	canvas_id	The unique identifier for a specific Canvas (customer journey).	dimension
canvas_name	canvas_name	The name of the Canvas.	dimension
channel	channel	The communication channel used for the campaign or message (e.g., email, push, in-app).	dimension
channels	channels	A list of communication channels through which a campaign or message can be delivered.	dimension
clicks	clicks	The total number of clicks on messages or elements within a campaign.	metric
conversion_behaviors.type	conversion_behaviors.type	The type of conversion behavior defined for a campaign.	dimension
conversion_behaviors.window	conversion_behaviors.window	The time window during which a user’s action is considered a conversion for a campaign.	metric
conversions	conversions	The total number of conversions attributed to a campaign.	metric
created_at	created_at	The date and time when the campaign or Canvas was created.	dimension
created_at_timestamp	created_at_timestamp	The Unix timestamp when the campaign or Canvas was created.	dimension
delivered	delivered	The number of messages successfully delivered to the recipient.	metric
delivery_failed	delivery_failed	The number of messages that failed to be delivered to recipients.	metric
description	description	A descriptive text providing details about the campaign or Canvas.	dimension
draft	draft	Indicates whether the campaign or Canvas is currently in a draft state.	dimension
enabled	enabled	Indicates whether the campaign or Canvas is currently active and running.	dimension
enrolled	enrolled	The number of unique users enrolled in a campaign or variant.	metric
errors	errors	Information regarding any errors encountered during the processing or delivery of messages or campaigns.	metric
first_entry	first_entry	The date and time when the first user entered the Canvas flow.	dimension
first_sent	first_sent	The date and time when the first message of a campaign or Canvas was sent to a user. This is derived from the ‘time’ and ‘sent’ metrics available in campaign analytics data.	dimension
first_step_id	first_step_id	The unique identifier for the initial step a user enters in a Braze Canvas journey.	dimension
first_step_ids	first_step_ids	Identifiers for the initial steps within a Braze Canvas, representing the starting points or entry conditions for users engaging with the Canvas flow.	dimension
has_post_launch_draft	has_post_launch_draft	A boolean indicating whether a campaign or Canvas has a draft version that was created after its initial launch.	dimension
id	id	A general unique identifier for an object or entity.	dimension
impressions	impressions	The total number of times a message or ad creative was displayed to users.	metric
last_entry	last_entry	The date and time when the most recent user entered the Canvas flow.	dimension
last_sent	last_sent	The date and time when the last message of a campaign or Canvas was sent to a user. This is derived from the ‘time’ and ‘sent’ metrics available in campaign analytics data.	dimension
message	message	The content or identifier of the message sent within a campaign or Canvas.	dimension
messages.action	messages.action	The action associated with a message, such as opening a URL, deep linking, or performing a specific function.	dimension
messages.alert	messages.alert	The primary text content or body of a push notification message, displayed to the recipient.	dimension
messages.amp_body	messages.amp_body	The AMP (Accelerated Mobile Pages) HTML content for an email message.	dimension
messages.body	messages.body	The main content or body text of a message.	dimension
messages.channel	messages.channel	The specific communication channel for a message (e.g., email, push, in-app, SMS).	dimension
messages.from	messages.from	The sender’s address or name for an email message.	dimension
messages.headers	messages.headers	Custom headers defined for an email message.	dimension
messages.message	messages.message	The main content or body of a message.	dimension
messages.message_variation_id	messages.message_variation_id	The unique identifier for a specific variation of a message used in A/B testing.	dimension
messages.method	messages.method	The HTTP method (e.g., POST, GET) used for a webhook message.	dimension
messages.preheader	messages.preheader	The preview text displayed after the subject line in an email client.	dimension
messages.reply_to	messages.reply_to	The email address to which replies to a message should be sent.	dimension
messages.should_inline_css	messages.should_inline_css	A boolean indicating whether CSS styles in an email message should be inlined.	dimension
messages.should_whitespace_preheader	messages.should_whitespace_preheader	A boolean indicating whether to add whitespace to the preheader of an email message to hide subsequent content.	dimension
messages.subject	messages.subject	The subject line of an email message.	dimension
messages.title	messages.title	The title of a message, commonly used for push notifications or in-app messages.	dimension
messages.type	messages.type	The type of message (e.g., email, push, in-app, webhook).	dimension
messages.url	messages.url	A URL embedded within a message, often for tracking clicks or deep linking.	dimension
name	name	The name of an entity such as a campaign, Canvas, or Canvas step.	dimension
next_paths	next_paths	An array containing details about the possible paths a user can take from a given step within a Canvas.	dimension
next_paths.name	next_paths.name	The name of a specific path leading from one step to another in a Canvas.	dimension
next_paths.next_step_id	next_paths.next_step_id	The unique identifier of the next step in a Canvas path.	dimension
next_step_ids	next_step_ids	A list of unique identifiers for the subsequent steps directly following a message step in a Canvas.	dimension
opens	opens	The number of times a message, such as an email or in-app message, was opened by recipients.	metric
opt_in	opt_in	Indicates a user’s explicit consent to receive messages, especially for SMS or email.	metric
opt_out	opt_out	The action of a user withdrawing consent to receive marketing communications.	metric
rejected	rejected	The count of messages that were rejected by the messaging service or recipient server.	metric
reported_spam	reported_spam	The count of instances where a message was marked as spam by recipients.	metric
revenue	revenue	The total revenue generated as a result of campaign activities or purchases.	metric
schedule_type	schedule_type	The type of scheduling action defined for a Canvas, indicating how and when it is set to run.	dimension
sent	sent	The total number of messages sent in a campaign.	metric
tag	tag	A tag used for categorization and filtering of various entities like campaigns, Canvases, or custom attributes.	dimension
time	time	The specific timestamp or date for a given data point in a time-series dataset, often used in Campaign or Canvas analytics to track metrics over time.	dimension
total_clicks	total_clicks	The aggregate sum of all clicks on messages or elements, including multiple clicks by the same user.	metric
total_dismissals	total_dismissals	The total number of times Content Cards from a campaign have been dismissed by users. If a user dismisses multiple Content Cards from the same campaign, each dismissal is counted.	metric
total_impressions	total_impressions	The aggregate sum of all message or ad displays, including multiple impressions for the same user.	metric
total_opens	total_opens	The aggregate sum of all message opens, including multiple opens by the same user.	metric
type	type	The category or type of an event or message within the Braze platform.	dimension
unique_clicks	unique_clicks	The number of distinct users who clicked on a message or element within a campaign.	metric
unique_dismissals	unique_dismissals	The number of unique users who dismissed a Content Card from a campaign. If a single user dismisses Content Cards from a campaign multiple times, it is counted as one unique dismissal.	metric
unique_impressions	unique_impressions	The number of distinct users who received an impression of a message or ad creative.	metric
unique_opens	unique_opens	The number of distinct users who opened a message.	metric
unique_recipients	unique_recipients	The total number of unique users who were targeted to receive messages within a campaign or variant.	metric
unsubscribes	unsubscribes	The total number of users who unsubscribed from messages or a subscription group.	metric
updated_at	updated_at	The date and time when the campaign or Canvas was last updated.	dimension
updated_at_timestamp	updated_at_timestamp	The Unix timestamp when the campaign or Canvas was last updated.	dimension
variation_api_id	variation_api_id	The unique identifier for a specific A/B test variation within a campaign or Canvas.	dimension
variation_name	variation_name	The name given to a specific A/B test variation within a campaign or Canvas.	dimension