# 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 requireme
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://rest.iad-01.braze.com
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# 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
| method | path | what the vendor says it does |
|---|---|---|
GET | /campaigns/data_series | Campaign Analytics This endpoint allows you to retrieve a daily series of various stats for a campaign over ti |
GET | /campaigns/details | Campaign Details This endpoint allows you to retrieve relevant information on a specified campaign, which can |
GET | /campaigns/list | Campaign List This endpoint allows you to export a list of campaigns, each of which will include its name, Cam |
GET | /canvas/data_series | Canvas Data Series Analytics This endpoint allows you to export time series data for a Canvas. ### Components |
GET | /canvas/data_summary | Canvas Data Analytics Summary This endpoint allows you to export rollups of time series data for a Canvas, pro |
GET | /canvas/details | Canvas Details This endpoint allows you to export metadata about a Canvas, such as its name, when it was creat |
GET | /canvas/list | Canvas List This endpoint allows you to export a list of Canvases, including the name, Canvas API Identifier a |
POST | /canvas/trigger/schedule/create | Schedule API Triggered Canvases Use this endpoint to trigger API Triggered Canvases, which are created on the |
GET | /content_blocks/info | See Content Block Information This endpoint will call information for an existing Content Block. ### Successf |
GET | /content_blocks/list | List Available Content Blocks This endpoint will list existing Content Block information. ### Successful Resp |
GET | /email/hard_bounces | Query Hard Bounced Emails This endpoint allows you to pull a list of email addresses that have “hard bounced” |
GET | /email/unsubscribes | Query List of Unsubscribed Email Addresses Use the /email/unsubscribes endpoint to return emails that have uns |
GET | /events/data_series | Custom Events Analytics This endpoint allows you to retrieve a series of the number of occurrences of a custom |
GET | /events/list | Custom Events List This endpoint allows you to export a list of custom events that have been recorded for your |
GET | /feed/data_series | News Feed Card Analytics This endpoint allows you to retrieve a daily series of engagement stats for a card ov |
GET | /feed/details | News Feed Cards Details This endpoint allows you to retrieve relevant information on the card, which can be id |
GET | /feed/list | News Feed Cards List This endpoint allows you to export a list of News Feed cards, each of which will include |
GET | /kpi/dau/data_series | Daily Active Users by Date This endpoint allows you to retrieve a daily series of the total number of unique a |
GET | /kpi/mau/data_series | Monthly Active Users for Last 30 Days This endpoint allows you to retrieve a daily series of the total number |
GET | /kpi/new_users/data_series | Daily New Users by Date This endpoint allows you to retrieve a daily series of the total number of new users o |
GET | /kpi/uninstalls/data_series | KPIs for Daily App Uninstalls by Date This endpoint allows you to retrieve a daily series of the total number |
GET | /messages/scheduled_broadcasts | Get Upcoming Scheduled Campaigns and Canvases You can view a JSON list of upcoming and scheduled Campaigns and |
GET | /segments/data_series | Segment Analytics This endpoint allows you to retrieve a daily series of the size of a segment over time for a |
GET | /segments/details | Segment Details This endpoint allows you to retrieve relevant information on the segment, which can be identif |
GET | /segments/list | Segment List This endpoint allows you to export a list of segments, each of which will include its name, Segme |
GET | /sends/data_series | Send Analytics This endpoint allows you to retrieve a daily series of various stats for a tracked `send_id`. B |
GET | /sessions/data_series | App Sessions by Time This endpoint allows you to retrieve a series of the number of sessions for your app over |
GET | /subscription/status/get | List User's Subscription Group Status - SMS Use the endpoint below to get the subscription state of a user in |
GET | /subscription/user/status | List User's Subscription Group - SMS Use the endpoint below to list and get the subscription groups of a certa |
GET | /templates/email/info | See Email Template Information Use to get information on your email templates. Use the Template REST APIs to |
GET | /templates/email/list | List Available Email Templates Use this endpoint to get a list of available templates in your Braze account. |
specification origin: https://www.getpostman.com/collections/29baa41d7ba930673ef0
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.