-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into bdocs-improvements
- Loading branch information
Showing
1,751 changed files
with
56,346 additions
and
18,620 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ page_type: reference | |
|
|
||
| # Rate limits | ||
|
|
||
| > The Braze API infrastructure is designed to handle high volumes of data across our customer base. To this end, we enforce API rate limits per workspace. | ||
| > The Braze API infrastructure is designed to handle high volumes of data across our customer base. To this end, we enforce API rate limits per workspace. | ||
| A rate limit is the number of requests the API can receive in a given time period. Many load-based denial-of-service incidents in large systems are unintentional—caused by errors in software or configurations—not malicious attacks. Rate limits check that such errors don't deprive our customers of Braze API resources. If too many requests are sent in a given time frame, you may see error responses with a status code of `429`, which indicates the rate limit has been hit. | ||
|
|
||
|
|
@@ -27,8 +27,8 @@ Requests not listed in this table share a total default rate limit of 250,000 re | |
|
|
||
| | Request Type | Default API Rate Limit | | ||
| | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | [`/users/track`][10] | **Requests:** 50,000 requests per minute.<br><br>**Batching:** 75 events, 75 purchases, and 75 attributes per API request. See [Batching User Track requests](#batch-user-track) for more.<br><br>**Limits for Monthly Active Users CY 24-25:** see [Monthly Active Users CY 24-25 limits]({{site.baseurl}}/api/endpoints/user_data/post_user_track/#monthly-active-users-cy-24-25) | | ||
| | [`/users/export/ids`][11] | 250 requests per minute. | | ||
| | [`/users/track`][10] | **Requests:** 3,000 requests per three seconds.<br><br>**Batching:** 75 events, 75 purchases, and 75 attributes per API request. See [Batching User Track requests](#batch-user-track) for more.<br><br>**Limits for Monthly Active Users CY 24-25:** see [Monthly Active Users CY 24-25 limits]({{site.baseurl}}/api/endpoints/user_data/post_user_track/#monthly-active-users-cy-24-25) | | ||
| | [`/users/export/ids`][11] | **If you onboarded on or after August 22, 2024:** 250 requests per minute. <br><br> **If you onboarded before August 22, 2024:** 2,500 requests per minute. | | ||
| | [`/users/delete`][12]<br>[`/users/alias/new`][13]<br>[`/users/alias/update`][45]<br>[`/users/identify`][14]<br>[`/users/merge`][44] | 20,000 requests per minute, shared between the endpoints. | | ||
| | [`/users/external_id/rename`][20] | 1,000 requests per minute. | | ||
| | [`/users/external_id/remove`][21] | 1,000 requests per minute. | | ||
|
|
@@ -44,7 +44,7 @@ Requests not listed in this table share a total default rate limit of 250,000 re | |
| | [`/catalogs/{catalog_name}/items`][34]<br>[`/catalogs/{catalog_name}/items`][35]<br>[`/catalogs/{catalog_name}/items`][36] | 16,000 requests per minute shared between the endpoints. | | ||
| | [`/catalogs/{catalog_name}/items/{item_id}`][37]<br>[`/catalogs/{catalog_name}/items/{item_id}`][38]<br>[`/catalogs/{catalog_name}/items`][39]<br>[`/catalogs/{catalog_name}/items/{item_id}`][40]<br>[`/catalogs/{catalog_name}/items/{item_id}`][41] | 50 requests per minute shared between the endpoints. | | ||
| | [`/scim/v2/Users/{id}`][22]<br>[`/scim/v2/Users?filter={[email protected]}`][43]<br>[`/scim/v2/Users/{id}`][25]<br>[`/scim/v2/Users/{id}}`][24]<br>[`/scim/v2/Users/`][23] | 5,000 requests per day, per company, shared between the endpoints. | | ||
| {: .reset-td-br-1 .reset-td-br-2} | ||
| {: .reset-td-br-1 .reset-td-br-2 role="presentation" } | ||
|
|
||
| <!-- Add during CDI endpoints GA | ||
| | [`/cdi/integrations`][46] | 50 requests per minute. | | ||
|
|
@@ -64,7 +64,7 @@ REST API rate limit increases are considered based on need for customers who are | |
|
|
||
| Each `/users/track` request can contain up to 75 event objects, 75 attribute objects, and 75 purchase objects. Each object (event, attribute, and purchase arrays) can update one user each. In total, this means a maximum of 225 users can be updated in a single call. In addition, a single user profile can be updated by multiple objects. | ||
|
|
||
| Requests made to this endpoint will generally begin processing in this order: | ||
| Requests made to this endpoint will generally begin processing in this order: | ||
|
|
||
| 1. Attributes | ||
| 2. Events | ||
|
|
@@ -111,10 +111,14 @@ Every single API request sent to Braze returns the following information in the | |
| | `X-RateLimit-Limit` | The maximum number of requests that you can make in a specified interval (your rate limit). | | ||
| | `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. | | ||
| | `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. | | ||
| {: .reset-td-br-1 .reset-td-br-2} | ||
| {: .reset-td-br-1 .reset-td-br-2 role="presentation" } | ||
|
|
||
| This information is intentionally included in the header of the response to the API request rather than the Braze dashboard. This allows your system to better react in real time as you're interacting with our API. For example, if the `X-RateLimit-Remaining` value drops below a certain threshold, you might want to slow sending to make sure all transactional emails go out. Or, if it reaches zero, you might want to pause all sending until the time specified in `X-RateLimit-Reset` elapses. | ||
|
|
||
| {% alert note %} | ||
| HTTP headers will be returned in all lowercase characters. This behavior aligns with the HTTP/2 protocol that mandates all header field names must be lowercase. This differs from HTTP/1.X where header names were case-insensitive but were commonly written in various capitalizations. | ||
| {% endalert %} | ||
|
|
||
| If you have questions about API limits, contact your customer success manager or open a [support ticket][support]. | ||
|
|
||
| ### Optimal delay between endpoints | ||
|
|
||
Oops, something went wrong.