Skip to main content

Rate Limits

Learn about Proactis API's rate limits and their usage

The Proactis API applies rate limits to the requests that it receives as a safeguards against bursts of incoming traffic to help maximize its stability. There might also be other additional resource-based rate limits. Your integration should be prepared to handle this resource throttling.

A basic technique for integrations to gracefully handle limiting is to watch for 429 status codes and build in a retry mechanism. The retry mechanism should follow an exponential backoff schedule to reduce request volume when necessary.

info

Rate limits only apply to traffic initiated by your applications. Traffic initiated by Proactis will not count toward set rate limits.

Why do we have rate limits?​

Rate limits are a common practice for APIs, and they're put in place for a few different reasons:

  • They help protect against abuse or misuse of the API. For example, a malicious actor could flood the API with requests in an attempt to overload it or cause disruptions in service. By setting rate limits, Proactis can prevent this kind of activity.
  • Rate limits help ensure that everyone has fair access to the API. If one person or organization makes an excessive number of requests, it could result in performance loss for everyone else. By throttling the number of requests that a single customer can make, Proactis ensures that everyone has an opportunity to use the API without experiencing slowdowns.
  • Rate limits can help Proactis manage the aggregate load on its infrastructure. If requests to the API increase dramatically, it could tax the servers and cause performance issues. By setting rate limits, Proactis can help maintain a smooth and consistent experience for all customers.

What are the rate limits for our API?​

We enforce rate limits at the organization level, across all endpoints. Rate limits are measured in two ways: requests per minute and requests per day. The daily counter will be reset at midnight UTC. The table below highlights the default rate limits for our API.

 UAT EnvironmentProduction Environment
requests per day40008000
requests per minute5050

It is important to note that the rate limit can be hit by either option depending on what occurs first.

What happens if I hit a rate limit error?​

Proactis will return a 429 status code for all requests to the API that are received while rate limiting is active. The body of the response will look like:

{
  "message": "Limit Exceeded"
}

If you hit a rate limit, it means you've made too many requests in a short period of time, and the API is refusing to fulfill further requests until a specified amount of time has passed. Proactis will not store and process these requests at a later time.

Contents