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 |
This field represents email messages that encountered a permanent delivery failure, also known as a hard bounce. This can occur for various reasons, such as an invalid email address. |
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 |
channel |
channel |
The communication channel through which a message was sent (e.g., email, push, SMS, in-app). |
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 |
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 |
failed |
failed |
The number of messages that failed to be delivered to users, providing insight into delivery issues. |
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 |
This field indicates that an SMS or RCS message was rejected by the carrier. This can happen due to factors such as carrier content filtering, the destination device’s availability, or the phone number being out of service. |
metric |
impressions |
impressions |
The total number of times a message or content was displayed to users. |
metric |
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 |
read |
read |
Indicates whether a message has been opened or viewed by the recipient, serving as a key metric for message engagement. |
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 |
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 |
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 |