Usage limits

Previously we have seen performance degradation due to overloading the API. To safeguard stability of our platform usage limits apply to the API. These limits are designed to prevent undesired loads on our systems from misconfigured API integrations or abuse.

The rate limit defaults 30 calls per minute. This applies to both read and write operations.

Requests that hit the rate limit will have a status code of 429 Too many requests.

All responses include the following headers with explicit numbers on the limits and remaining calls.

X-RateLimit-Limit  
X-RateLimit-Remaining  
X-RateLimit-Retry-After

To debug problems in your integration scenarios that are or can be caused by rate limits, please go through this checklist:

  • Consult your integration specialist to inspect the API calls and return headers
  • Open your AlisQI integration hub to learn about the concrete rate limit applied to your installation
  • Inspect the API log in the AlisQI integration hub, to determine the number of requests per minute.
  • Inspect the API request return headers, to see if they contain the 429 Too many requests status code
  • Inspect individual API request return headers to assess the X-RateLimit-* headers
  • Assess whether you can improve the integration by reducing duplicate requests, or by combining multiple results in a single storeResults call. Feel free to reach out to AlisQI support to discuss the capabilities of our API regarding caching and processing multiple results.
  • If your integration scenario is optimized but legitimately requires more calls per minutes, please reach out to AlisQI support to discuss possibilities to raise the limit.