Braze

Braze Endpoints

Braze API Overview Braze provides a high performance REST API to allow you to track users, send messages, export data, and more. A REST API is a way to…

Other#openapi#marketing

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Braze API Overview

Braze provides a high performance REST API to allow you to track users, send messages, export data, and more.

A REST API is a way to programmatically transfer information over the web using a predefined schema. Braze has created many different endpoints with specific requirements that will perform various actions and/or return various data. API access is done using HTTPS web requests to your company's REST API endpoint (this will correspond to your Dashboard URL as shown in the table below).

Customers using Braze's EU database should use https://rest.fra-01.braze.eu/. For more information on REST API endpoints for customers using Braze's EU database see our EU/US Implementation Differences documentation.

Braze Instances

Instance | Dashboard URL | REST Endpoint
----------- |---------------- | --------------------
US-01 | https://dashboard.braze.com or https://dashboard-01.braze.com | https://rest.iad-01.braze.com
US-02 | https://dashboard-02.braze.com | https://rest.iad-02.braze.com
US-03 | https://dashboard-03.braze.com | https://rest.iad-03.braze.com
US-04 | https://dashboard-04.braze.com | https://rest.iad-04.braze.com
US-06 | https://dashboard-06.braze.com | https://rest.iad-06.braze.com
EU-01 | https://dashboard.braze.eu or https://dashboard-01.braze.eu | https://rest.fra-01.braze.eu

Using Braze's Postman Collection

If you have a Postman account (MacOS, Windows, and Linux versions can be downloaded from their website located here), you can go to our Postman documentation and click the orange Run in Postman button in the top, right corner. This will allow you to create an environment, as well as edit the available POST and GET requests to suit your own needs.

Setting Up Your Postman Environment

The Braze Postman Collection uses a templating variable, {{instance_url}}, to substitute the REST API URL of your Braze instance into the pre-built requests. Rather than having to manually edit all requests in the Collection, you can set up this variable in your Postman environment. To do so, please follow the steps below:

  1. Click on the gear icon in the top right corner of the Postman app.
  2. Select "Manage Environments" to open a modal window which displays your active environments.
  3. In the bottom right corner of the modal window, click "Add" to create a new environment.
  4. Give this environment a name (e.g. "Braze API Requests") and add keys for instance_url and api_key with values corresponding to your Braze instance and Braze REST API Key, as pictured below.

As of April, 2020 Braze has changed how we read App Group API keys. Instead of passing them in the request body or through url parameters, we now read the App Group Restapi_key through the HTTP Authorization header. API keys not passed through the HTTP Authorization Header will coninue to work until they have been sunset.

Using the Pre-Built Requests from the Collection

Once you have configured your environment. You can use any of the pre-built requests in the collection as a template for building new API requests. To start using one of the pre-built requests, simply click on it within the 'Collections' menu on the left side of Postman. This will open the request as a new tab in the main window of the Postman app.

In general, there are two types of requests that Braze's API endpoints accept - GET and POST. Depending on which HTTP method the endpoint uses, you'll need to edit the pre-built request differently.

Edit a POST Request

When editing a POST request, you'll need to open the request and navigate to the Body section in the request editor. For readability, select the raw radio button to format the JSON request body.

Edit a GET Request

When editing a GET request, you will need to edit the parameters passed in the request URL. To edit these easily, select the Params button next to the URL bar and edit the key-value pairs in the fields that will appear below the URL bar.

Send Your Request

Once your API request is ready to send, click on the 'Send' button next to the URL bar. The request will be sent and the response data will be populated in a section underneath the request editor. From here, you can view the raw data returned from Braze's API, see the HTTP response code, see how long the request took to process, and view header information.

Endpoints 31

Email Lists & Addresses

  • GETQuery Hard Bounced Emails/email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1&email=example@braze.comThis endpoint allows you to pull a list of email addresses that have “hard bounced” your email messages within a certain time frame. > You must provide an…
  • GETQuery List of Unsubscribed Email Addresses/email/unsubscribes?start_date=2020-01-01&end_date=2020-02-01&limit=1&offset=1&sort_direction=desc&email=example@braze.comUse the /email/unsubscribes endpoint to return emails that have unsubscribed during the time period from start_date to end_date. You can use this endpoint to…

Export

  • GETCampaign Analytics/campaigns/data_series?campaign_id={{campaign_identifier}}&length=7&ending_at=2020-06-28T23:59:59-5:00This endpoint allows you to retrieve a daily series of various stats for a campaign over time. Data returned includes how many messages were sent, opened,…
  • GETCampaign Details/campaigns/details?campaign_id={{campaign_identifier}}This endpoint allows you to retrieve relevant information on a specified campaign, which can be identified by the campaign_id. > The campaign_id for API…
  • GETCampaign List/campaigns/list?page=0&include_archived=false&sort_direction=desc&last_edit.time[gt]=2020-06-28T23:59:59-5:00This endpoint allows you to export a list of campaigns, each of which will include its name, Campaign API Identifier, whether it is an API Campaign, and Tags…
  • GETCanvas Data Series Analytics/canvas/data_series?canvas_id={{canvas_id}}&ending_at=2018-05-30T23:59:59-5:00&starting_at=2018-05-28T23:59:59-5:00&length=10&include_variant_breakdown=true&include_step_breakdown=true&include_deleted_step_data=trueThis endpoint allows you to export time series data for a Canvas. Components Used Canvas Identifier Response Content-Type: application/json Authorization:…
  • GETCanvas Data Analytics Summary/canvas/data_summary?canvas_id={{canvas_id}}&ending_at=2018-05-30T23:59:59-5:00&starting_at=2018-05-28T23:59:59-5:00&length=5&include_variant_breakdown=true&include_step_breakdown=true&include_deleted_step_data=trueThis endpoint allows you to export rollups of time series data for a Canvas, providing a concise summary of a Canvas' results. Components Used Canvas…
  • GETCanvas Details/canvas/details?canvas_id={{canvas_identifier}}This endpoint allows you to export metadata about a Canvas, such as its name, when it was created, its current status, and more. Components Used Canvas…
  • GETCanvas List/canvas/list?page=1&include_archived=false&sort_direction=desc&last_edit.time[gt]=2020-06-28T23:59:59-5:00This endpoint allows you to export a list of Canvases, including the name, Canvas API Identifier and associated Tags. The Canvases are returned in groups of…
  • GETCustom Events Analytics/events/data_series?event=event_name&length=24&unit=hour&ending_at=2014-12-10T23:59:59-05:00&app_id={{app_identifier}}&segment_id={{segment_identifier}}This endpoint allows you to retrieve a series of the number of occurrences of a custom event in your app over a designated time period. Components Used…
  • GETCustom Events List/events/list?page=3This endpoint allows you to export a list of custom events that have been recorded for your app. The event names are returned in groups of 250, sorted…
  • GETNews Feed Card Analytics/feed/data_series?card_id={{card_identifier}}&length=14&unit=day&ending_at=2018-06-28T23:59:59-5:00This endpoint allows you to retrieve a daily series of engagement stats for a card over time. Components Used Card ID News Feed List Response Content-Type:…
  • GETNews Feed Cards Details/feed/details?card_id={{card_identifier}}This endpoint allows you to retrieve relevant information on the card, which can be identified by the card_id. Components Used Card ID News Feed List Response…
  • GETNews Feed Cards List/feed/list?page=1&include_archived=true&sort_direction=descThis endpoint allows you to export a list of News Feed cards, each of which will include its name and Card API Identifier. The cards are returned in groups of…
  • GETDaily Active Users by Date/kpi/dau/data_series?length=10&ending_at=2018-06-28T23:59:59-5:00&app_id={{app_identifier}}This endpoint allows you to retrieve a daily series of the total number of unique active users on each date. Response Content-Type: application/json…
  • GETMonthly Active Users for Last 30 Days/kpi/mau/data_series?length=7&ending_at=2018-06-28T23:59:59-05:00&app_id={{app_identifier}}This endpoint allows you to retrieve a daily series of the total number of unique active users over a 30-day rolling window. Response Content-Type:…
  • GETDaily New Users by Date/kpi/new_users/data_series?length=14&ending_at=2018-06-28T23:59:59-5:00&app_id={{app_identifier}}This endpoint allows you to retrieve a daily series of the total number of new users on each date. Response Content-Type: application/json Authorization:…
  • GETKPIs for Daily App Uninstalls by Date/kpi/uninstalls/data_series?length=14&ending_at=2018-06-28T23:59:59-5:00&app_id={{app_identifier}}This endpoint allows you to retrieve a daily series of the total number of uninstalls on each date. Response Content-Type: application/json Authorization:…
  • GETSegment Analytics/segments/data_series?segment_id={{segment_identifier}}&length=14&ending_at=2018-06-27T23:59:59-5:00This endpoint allows you to retrieve a daily series of the size of a segment over time for a segment. Request Components Segment Identifier Response…
  • GETSegment Details/segments/details?segment_id={{segment_identifier}}This endpoint allows you to retrieve relevant information on the segment, which can be identified by the segment_id. Request Components Segment Identifier…
  • GETSegment List/segments/list?page=1&sort_direction=descThis endpoint allows you to export a list of segments, each of which will include its name, Segment API Identifier, and whether it has analytics tracking…
  • GETSend Analytics/sends/data_series?campaign_id={{campaign_identifier}}&send_id={{send_identifier}}&length=30&ending_at=2014-12-10T23:59:59-05:00This endpoint allows you to retrieve a daily series of various stats for a tracked send_id. Braze stores send analytics for 14 days after the send. Campaign…
  • GETApp Sessions by Time/sessions/data_series?length=14&unit=day&ending_at=2018-06-28T23:59:59-5:00&app_id={{app_identifier}}&segment_id={{segment_identifier}}This endpoint allows you to retrieve a series of the number of sessions for your app over a designated time period. Components Used Segment Identifier…

Messaging

  • POSTSchedule API Triggered Canvases/canvas/trigger/schedule/createUse this endpoint to trigger API Triggered Canvases, which are created on the Dashboard and initiated via the API. You can pass in canvas_entry_properties…
  • GETGet Upcoming Scheduled Campaigns and Canvases/messages/scheduled_broadcasts?end_time=2018-09-01T00:00:00-04:00You can view a JSON list of upcoming and scheduled Campaigns and Canvases using the following information and parameters. The endpoint will return information…

Subscription Groups

  • GETList User's Subscription Group Status - SMS/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id={{external_identifier}}&phone=+11112223333Use the endpoint below to get the subscription state of a user in a subscription group. The response from this endpoint will include the external ID and…
  • GETList User's Subscription Group - SMS/subscription/user/status?external_id={{external_id}}&limit=100&offset=1&phone=+11112223333Use the endpoint below to list and get the subscription groups of a certain user. > If there are multiple users (multiple external ids) who share the same…

Templates

  • GETSee Content Block Information/content_blocks/info?content_block_id={{content_block_id}}&include_inclusion_data=NoThis endpoint will call information for an existing Content Block. Successful Response Properties Content-Type: application/json Authorization: Bearer…
  • GETList Available Content Blocks/content_blocks/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=100&offset=1This endpoint will list existing Content Block information. Successful Response Properties Content-Type: application/json Authorization: Bearer…
  • GETSee Email Template Information/templates/email/info?email_template_id={{email_template_id}}Use to get information on your email templates. Use the Template REST APIs to programmatically manage the email templates that you have stored on the Braze…
  • GETList Available Email Templates/templates/email/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=1&offset=0Use this endpoint to get a list of available templates in your Braze account. Use the Template REST APIs to programmatically manage the email templates that…

API details

Base URL
https://rest.iad-01.braze.com
Authentication
None declared in the description
Operations
31 operations on 31 pathsGET 30POST 1
Main resources
Export 21Campaign 4Canvas 4KPI 4Templates 4News Feed 3Segment 3Content Blocks 2Custom Events 2Email Lists & Addresses 2
Description format
OpenAPI 3.0.3, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Braze Endpoints in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Braze Endpoints collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Query Hard Bounced Emails” (GET /email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1&email=example@braze.com), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Braze Endpoints?

Braze API Overview Braze provides a high performance REST API to allow you to track users, send messages, export data, and more. A REST API is a way to… It is listed under Other and has 31 endpoints.

Who publishes the Braze Endpoints?

It is listed from Braze's public API description (an OpenAPI document), not published by Braze on Swastik Codes. Anyone who controls braze.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Braze Endpoints?

Requests go to https://rest.iad-01.braze.com. Endpoint paths are added to this base URL.

How do I authenticate with the Braze Endpoints?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Braze Endpoints have?

31 operations on 31 paths (30 GET, 1 POST). The largest groups are Export, Campaign, Canvas, KPI.

Is forking the Braze Endpoints free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.