Skip to content

docs(personalization): add rate limit information for personalization API #4725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions specs/personalization/paths/deleteUserProfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ delete:
responses:
'200':
description: OK
headers:
x-ratelimit-limit:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
x-ratelimit-remaining:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
x-ratelimit-reset:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
content:
application/json:
schema:
Expand Down
7 changes: 7 additions & 0 deletions specs/personalization/paths/getUserTokenProfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ get:
responses:
'200':
description: OK
headers:
x-ratelimit-limit:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
x-ratelimit-remaining:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
x-ratelimit-reset:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
content:
application/json:
schema:
Expand Down
7 changes: 7 additions & 0 deletions specs/personalization/paths/personalizationStrategy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ get:
responses:
'200':
description: OK
headers:
x-ratelimit-limit:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
x-ratelimit-remaining:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
x-ratelimit-reset:
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
content:
application/json:
schema:
Expand Down
12 changes: 12 additions & 0 deletions specs/personalization/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ info:
Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
Error responses have a `message` property with more information.

## Rate limiting

When making requests to the Personalization API, you are limited to 40 API calls per second per application.

The following headers provide information about your current limit:

- `x-ratelimit-limit`: The number of requests allowed every second.
- `x-ratelimit-remaining`: The number of requests remaining in the current
second period.
- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of
the next time period.

## Version

The current version of the Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
Expand Down