This guide contains all permissions and requirements for connecting your Braze data to Supermetrics.
You can connect to data sources from the Data sources page on the Supermetrics Hub. On the Hub, you can also share an authentication link to connect to a data source you don't have direct access to.
After you connect to the data source on the Hub, you can use the data source connection in all available destinations.
Required permissions
You need a Braze REST API key and your Braze REST endpoint to connect to Braze.
REST API key: Created in Braze under Settings → APIs and Identifiers → REST API Keys. The key must have the following permissions:
campaigns.listcampaigns.detailscampaigns.data_seriesCreating an API key requires the appropriate admin permissions in your Braze account.
REST endpoint: The REST API URL for your Braze instance, for example,
https://rest.iad-03.braze.com. The REST API URL corresponds to your Braze dashboard cluster. You select it from a list when connecting. If you're unsure which endpoint to use, see Braze's REST API endpoints (it matches the dashboard URL you log in to).
Query types
Query types define what sort of metrics and dimensions are available. You need to select one of the following query types when pulling data.
Campaign performance: message delivery and engagement metrics (sent, delivered, opens, clicks, bounces, and more) broken down by channel and message variation, per day.
Campaign analytics: campaign-level outcomes (revenue, conversions, and unique recipients), per day.
Connection instructions
When connecting to Braze, you enter your Braze REST API key and select your REST endpoint when prompted. Braze uses credential-based authentication, so there's no separate login window.
Select the Braze data source on the Supermetrics Hub or in the data destination.
Insert your Braze REST API key and select your REST endpoint.
If prompted, choose to make this connection shared or private.
Click Start.
In your data destination, select the query type to use.
See detailed instructions on how to connect to a data source from the Supermetrics Hub.
You can also connect to Braze from these destinations:
Data Studio: How to connect data sources to Data Studio
The Supermetrics API: How to use the Query Manager
Data warehouse and cloud storage (Hub): How to create a transfer
BigQuery (marketplace): How to create a BigQuery (marketplace) transfer