Skip to content

Ratelimit Doc: Add Specification to Global Search Ratelimit #39

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.

Sign up for GitHub

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
ihassanein merged 1 commit into from
Dec 10, 2024
Merged

Ratelimit Doc: Add Specification to Global Search Ratelimit #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions docs/concepts/rate-limits-and-quotas.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@ title: 'Rate Limits and Quotas'

## Rate Limits

API usage exceeding 1 request per second is subject to Flare's API rate limit.
API usage is subject to Flare's API rate limit.
Rate Limits are enforced **per organization**.

Calls to certain resources have differing independant limits as follows:
- Basic: 2 requests per second
- Search: 1 request per second

For example, a user may perform a total of 3 requests per second, two basic requests and one search request.

Any endpoint that is not subject to basic limit will be identified as such.

Enforced limits receive a `RATELIMIT_REACHED` error message with the status code 429.

If you receive 429 errors, Flare's recommended course of action is to wait 10 seconds before retrying.
Expand All @@ -28,7 +36,7 @@ If you receive 429 errors, Flare's recommended course of action is to wait 10 se
## Quotas
API users are responsible for monitoring their Global Search API usage and ensuring it remains within their allocated monthly quota.

Users with account administration rights can also view their Global Search API monthly calls by logging into the platform and navigating to [the tenants page](https://app.flare.io/#/tenants).
Users with account administration rights can also view their Global Search API monthly calls by logging into the platform and navigating to [the tenants page](https://app.flare.io/#/tenants).

Moreover, each global search response includes `X-Flare-Global-Searches-Remaining`, indicating the number of API calls remaining in your monthly allocation.

Expand Down
Loading