Skip to content

SQL table reference

This page is a reference of tables and columns available to be queried in the Query Builder or when generating SQL Segment Extensions.

Table of contents

Table Description
USERS_BEHAVIORS_CUSTOMEVENT_SHARED When a user performs a custom event
USERS_BEHAVIORS_INSTALLATTRIBUTION_SHARED When a user installs an app and we attribute it to a partner
USERS_BEHAVIORS_LOCATION_SHARED When a user records a location
USERS_BEHAVIORS_PURCHASE_SHARED When a user makes a purchase
USERS_BEHAVIORS_UNINSTALL_SHARED When a user uninstalls an app
USERS_BEHAVIORS_UPGRADEDAPP_SHARED When a user upgrades the app
USERS_BEHAVIORS_APP_FIRSTSESSION_SHARED When a user has their first session
USERS_BEHAVIORS_APP_NEWSFEEDIMPRESSION_SHARED When a user views the News Feed
USERS_BEHAVIORS_APP_SESSIONEND_SHARED When a user ends a session on an app
USERS_BEHAVIORS_APP_SESSIONSTART_SHARED When a user begins a session on an app
USERS_BEHAVIORS_GEOFENCE_DATAEVENT_SHARED When a user triggers a geofenced area (for example, when they enter or exit a geofence). This event was batched with other events and received through the standard events endpoint, and therefore may not have been received by the endpoint in real time.
USERS_BEHAVIORS_GEOFENCE_RECORDEVENT_SHARED When a user triggers a geofenced area (for example, when they enter or exit a geofence). This event was received through the dedicated geofence endpoint and is therefore received in real-time as soon as a user’s device detects that it has triggered a geofence.

In addition, due to rate limiting on the geofence endpoint, it is possible that some geofence events are not reflected as a RecordEvent. All geofence events, however, are represented by DataEvent (but potentially with some delay due to batching).
USERS_BEHAVIORS_SUBSCRIPTION_GLOBALSTATECHANGE_SHARED When a user is subscribed or unsubscribed globally from a channel such as email
USERS_BEHAVIORS_SUBSCRIPTIONGROUP_STATECHANGE_SHARED When a user is subscribed or unsubscribed to or from a subscription group
USERS_CAMPAIGNS_CONVERSION_SHARED When a user converts for a campaign
USERS_CAMPAIGNS_ENROLLINCONTROL_SHARED When a user is enrolled in the control group for a campaign
USERS_CAMPAIGNS_FREQUENCYCAP_SHARED When a user gets frequency capped for a campaign
USERS_CAMPAIGNS_REVENUE_SHARED When a user generates revenue within the primary conversion period
USERS_CANVAS_CONVERSION_SHARED When a user converts for a Canvas conversion event
USERS_CANVAS_ENTRY_SHARED When a user enters a Canvas
USERS_CANVAS_EXIT_MATCHEDAUDIENCE_SHARED When a user exits a Canvas because they match audience exit criteria
USERS_CANVAS_EXIT_PERFORMEDEVENT_SHARED When a user exits a Canvas because they performed an exception event
USERS_CANVAS_EXPERIMENTSTEP_CONVERSION_SHARED When a user converts for a Canvas Experiment step
USERS_CANVAS_EXPERIMENTSTEP_SPLITENTRY_SHARED When a user enters an Experiment step path
USERS_CANVAS_FREQUENCYCAP_SHARED When a user gets frequency capped for a Canvas step
USERS_CANVAS_REVENUE_SHARED When a user generates revenue within the primary conversion event period
USERS_MESSAGES_CONTENTCARD_ABORT_SHARED An originally scheduled Content Card message was aborted for some reason.
USERS_MESSAGES_CONTENTCARD_CLICK_SHARED When a user clicks a Content Card
USERS_MESSAGES_CONTENTCARD_DISMISS_SHARED When a user dismisses a Content Card
USERS_MESSAGES_CONTENTCARD_IMPRESSION_SHARED When a user views a Content Card
USERS_MESSAGES_CONTENTCARD_SEND_SHARED When we send a Content Card to a user
USERS_MESSAGES_EMAIL_ABORT_SHARED An originally scheduled email message was aborted for some reason.
USERS_MESSAGES_EMAIL_BOUNCE_SHARED An Email Service Provider returned a hard bounce. A hard bounce signifies a permanent deliverability failure.
USERS_MESSAGES_EMAIL_CLICK_SHARED When a user clicks a link in an email
USERS_MESSAGES_EMAIL_DELIVERY_SHARED When an email is delivered
USERS_MESSAGES_EMAIL_MARKASSPAM_SHARED When an email is marked as spam
USERS_MESSAGES_EMAIL_OPEN_SHARED When a user opens an email
USERS_MESSAGES_EMAIL_SEND_SHARED When we send an email to a user
USERS_MESSAGES_EMAIL_SOFTBOUNCE_SHARED When an email soft bounces
USERS_MESSAGES_EMAIL_UNSUBSCRIBE_SHARED When a user unsubscribes from email
USERS_MESSAGES_INAPPMESSAGE_ABORT_SHARED An originally scheduled in-app message was aborted for some reason.
USERS_MESSAGES_INAPPMESSAGE_CLICK_SHARED When a user clicks an in-app message
USERS_MESSAGES_INAPPMESSAGE_IMPRESSION_SHARED When a user views an in-app message
USERS_MESSAGES_NEWSFEEDCARD_ABORT_SHARED An originally scheduled News Feed card message was aborted for some reason.
USERS_MESSAGES_NEWSFEEDCARD_CLICK_SHARED When a user clicks a News Feed card
USERS_MESSAGES_NEWSFEEDCARD_IMPRESSION_SHARED When a user views a News Feed card
USERS_MESSAGES_PUSHNOTIFICATION_ABORT_SHARED An originally scheduled push notification message was aborted for some reason.
USERS_MESSAGES_PUSHNOTIFICATION_BOUNCE_SHARED When a push notification bounces
USERS_MESSAGES_PUSHNOTIFICATION_INFLUENCEDOPEN_SHARED When a user opens the app after receiving a notification without clicking on the notification
USERS_MESSAGES_PUSHNOTIFICATION_IOSFOREGROUND_SHARED When a user receives a push notification while the app is open
USERS_MESSAGES_PUSHNOTIFICATION_OPEN_SHARED When a user opens a push notification or clicks a push notification button (including a CLOSE button that does NOT open the app).

Push button actions have multiple outcomes. No, Decline, and Cancel actions are “clicks”, and Accept actions are “opens”. Both are represented in this table, but they can be distinguished in the BUTTON_ACTION_TYPE column. For example, a query can be used to group by a BUTTON_ACTION_TYPE that is not No, Decline, or Cancel.
USERS_MESSAGES_PUSHNOTIFICATION_SEND_SHARED When we send a push notification to a user
USERS_MESSAGES_SMS_ABORT_SHARED An originally scheduled SMS message was aborted for some reason.
USERS_MESSAGES_SMS_CARRIERSEND_SHARED When an SMS message is sent to the carrier
USERS_MESSAGES_SMS_DELIVERY_SHARED When an SMS message is delivered
USERS_MESSAGES_SMS_DELIVERYFAILURE_SHARED When Braze is unable to deliver the SMS message to the SMS service provider
USERS_MESSAGES_SMS_INBOUNDRECEIVE_SHARED When an SMS message is received from a user
USERS_MESSAGES_SMS_REJECTION_SHARED When an SMS message is not delivered to a user
USERS_MESSAGES_SMS_SEND_SHARED When an SMS message is sent
USERS_MESSAGES_SMS_SHORTLINKCLICK_SHARED When a user clicks a Braze shortened URL included in an SMS message
USERS_MESSAGES_WEBHOOK_ABORT_SHARED An originally scheduled webhook message was aborted for some reason
USERS_MESSAGES_WEBHOOK_SEND_SHARED When we send a webhook for a user
USERS_MESSAGES_WHATSAPP_ABORT_SHARED An originally scheduled WhatsApp message was aborted for some reason
USERS_MESSAGES_WHATSAPP_DELIVERY_SHARED When a WhatsApp message is delivered
USERS_MESSAGES_WHATSAPP_FAILURE_SHARED When a WhatsApp message is not delivered to a user
USERS_MESSAGES_WHATSAPP_INBOUNDRECEIVE_SHARED When a WhatsApp message is received from a user
USERS_MESSAGES_WHATSAPP_READ_SHARED When a user opens a WhatsApp message
USERS_MESSAGES_WHATSAPP_SEND_SHARED When we send a WhatsApp message for a user
USERS_RANDOMBUCKETNUMBERUPDATE_SHARED When a user’s random bucket number is changed
USERS_USERDELETEREQUEST_SHARED When a user is deleted by a customer request
USERS_USERORPHAN_SHARED When a user is merged with another user’s profile and the original profile is orphaned

Behaviors

USERS_BEHAVIORS_CUSTOMEVENT_SHARED

USERS_BEHAVIORS_INSTALLATTRIBUTION_SHARED

USERS_BEHAVIORS_LOCATION_SHARED

USERS_BEHAVIORS_PURCHASE_SHARED

USERS_BEHAVIORS_UNINSTALL_SHARED

USERS_BEHAVIORS_UPGRADEDAPP_SHARED

USERS_BEHAVIORS_APP_FIRSTSESSION_SHARED

USERS_BEHAVIORS_APP_NEWSFEEDIMPRESSION_SHARED

USERS_BEHAVIORS_APP_SESSIONEND_SHARED

USERS_BEHAVIORS_APP_SESSIONSTART_SHARED

USERS_BEHAVIORS_GEOFENCE_DATAEVENT_SHARED

USERS_BEHAVIORS_GEOFENCE_RECORDEVENT_SHARED

USERS_BEHAVIORS_SUBSCRIPTION_GLOBALSTATECHANGE_SHARED

USERS_BEHAVIORS_SUBSCRIPTIONGROUP_STATECHANGE_SHARED

Campaigns

USERS_CAMPAIGNS_CONVERSION_SHARED

USERS_CAMPAIGNS_ENROLLINCONTROL_SHARED

USERS_CAMPAIGNS_FREQUENCYCAP_SHARED

USERS_CAMPAIGNS_REVENUE_SHARED

Canvas

USERS_CANVAS_CONVERSION_SHARED

USERS_CANVAS_ENTRY_SHARED

USERS_CANVAS_EXIT_MATCHEDAUDIENCE_SHARED

Field Type Description
id stringnull Globally unique ID for this event
user_id stringnull Braze ID of the user that performed this event
external_user_id stringnull [PII] External user ID of the user
device_id stringnull ID of the device that is tied to this user, if the user is anonymous
app_group_id stringnull Braze ID of the workspace this user belongs to
app_group_api_id stringnull API ID of the workspace this user belongs to
time intnull Unix timestamp at which the event happened
canvas_id stringnull (For Braze use only) ID of the Canvas this event belongs to
canvas_api_id stringnull API ID of the Canvas this event belongs to
canvas_variation_api_id stringnull API ID of the Canvas variation this event belongs to
canvas_step_api_id stringnull API ID of the Canvas step this event belongs to
sf_created_at timestampnull When this event was picked up by the Snowpipe

USERS_CANVAS_EXPERIMENTSTEP_CONVERSION_SHARED

USERS_CANVAS_EXPERIMENTSTEP_SPLITENTRY_SHARED

Field Type Description
id stringnull Globally unique ID for this event
user_id stringnull Braze ID of the user that performed this event
external_user_id stringnull [PII] External user ID of the user
device_id stringnull ID of the device that is tied to this user, if the user is anonymous
app_group_id stringnull Braze ID of the workspace this user belongs to
time intnull Unix timestamp at which the event happened
canvas_id stringnull (For Braze use only) ID of the Canvas this event belongs to
canvas_api_id stringnull API ID of the Canvas this event belongs to
canvas_variation_api_id stringnull API ID of the Canvas variation this event belongs to
canvas_step_api_id stringnull API ID of the Canvas step this event belongs to
experiment_step_api_id stringnull API ID of the Experiment step this event belongs to
in_control_group booleannull True if the user was enrolled in the control group
sf_created_at timestampnull When this event was picked up by the Snowpipe

USERS_CANVAS_REVENUE_SHARED

Messages

USERS_MESSAGES_CONTENTCARD_ABORT_SHARED

USERS_MESSAGES_CONTENTCARD_CLICK_SHARED

USERS_MESSAGES_CONTENTCARD_DISMISS_SHARED

USERS_MESSAGES_CONTENTCARD_IMPRESSION_SHARED

USERS_MESSAGES_CONTENTCARD_SEND_SHARED

USERS_MESSAGES_EMAIL_ABORT_SHARED

USERS_MESSAGES_EMAIL_BOUNCE_SHARED

USERS_MESSAGES_EMAIL_CLICK_SHARED

USERS_MESSAGES_EMAIL_DELIVERY_SHARED

USERS_MESSAGES_EMAIL_MARKASSPAM_SHARED

USERS_MESSAGES_EMAIL_OPEN_SHARED

USERS_MESSAGES_EMAIL_SEND_SHARED

USERS_MESSAGES_EMAIL_SOFTBOUNCE_SHARED

USERS_MESSAGES_EMAIL_UNSUBSCRIBE_SHARED

USERS_MESSAGES_INAPPMESSAGE_ABORT_SHARED

USERS_MESSAGES_INAPPMESSAGE_CLICK_SHARED

USERS_MESSAGES_INAPPMESSAGE_IMPRESSION_SHARED

USERS_MESSAGES_NEWSFEEDCARD_ABORT_SHARED

USERS_MESSAGES_NEWSFEEDCARD_CLICK_SHARED

USERS_MESSAGES_NEWSFEEDCARD_IMPRESSION_SHARED

USERS_MESSAGES_PUSHNOTIFICATION_ABORT_SHARED

USERS_MESSAGES_PUSHNOTIFICATION_BOUNCE_SHARED

USERS_MESSAGES_PUSHNOTIFICATION_INFLUENCEDOPEN_SHARED

USERS_MESSAGES_PUSHNOTIFICATION_IOSFOREGROUND_SHARED

USERS_MESSAGES_PUSHNOTIFICATION_OPEN_SHARED

USERS_MESSAGES_PUSHNOTIFICATION_SEND_SHARED

USERS_MESSAGES_SMS_ABORT_SHARED

USERS_MESSAGES_SMS_CARRIERSEND_SHARED

USERS_MESSAGES_SMS_DELIVERY_SHARED

USERS_MESSAGES_SMS_DELIVERYFAILURE_SHARED

USERS_MESSAGES_SMS_INBOUNDRECEIVE_SHARED

USERS_MESSAGES_SMS_REJECTION_SHARED

USERS_MESSAGES_SMS_SEND_SHARED

USERS_MESSAGES_SMS_SHORTLINKCLICK_SHARED

USERS_MESSAGES_WEBHOOK_ABORT_SHARED

USERS_MESSAGES_WEBHOOK_SEND_SHARED

USERS_MESSAGES_WHATSAPP_ABORT_SHARED

USERS_MESSAGES_WHATSAPP_DELIVERY_SHARED

USERS_MESSAGES_WHATSAPP_FAILURE_SHARED

USERS_MESSAGES_WHATSAPP_INBOUNDRECEIVE_SHARED

USERS_MESSAGES_WHATSAPP_READ_SHARED

USERS_MESSAGES_WHATSAPP_SEND_SHARED

Users

USERS_RANDOMBUCKETNUMBERUPDATE_SHARED

USERS_USERDELETEREQUEST_SHARED

USERS_USERORPHAN_SHARED

HOW HELPFUL WAS THIS PAGE?
New Stuff!