Usage Guidelines and Error Management
List of errors
All requests with a response status code different than 200 (successful HTTP) are considered as a failure of the particular API call and referred to as “HTTPS errors”. When the response (error) is returned an additional JSON is present in the body containing the error message. Depending on what has gone wrong with the API call, the error message is different.
The errors we use follow the HTTP Error Codes Standard.
All requests with a response status code different than 200 (successful HTTP) are considered as a failure of the particular API call and referred to as “HTTPS errors”. When the response (error) is returned an additional JSON is present in the body containing the error message. Depending on what has gone wrong with the API call, the error message is different.
As best practice we recommend to store all error messages somewhere along with request data for further manual review.
The errors we use follow the HTTP Error Codes Standard.
| HTTP Status Code | Error it represents |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 413 | Request Entity Too Large |
| 429 | Too many requests |
| 500 | Internal Server Error |
Usage Guidelines
The API Metrics plan supports batching requests, with each batch capable of containing up to 10,000 requests.
Under the standard API Metrics Add-on plan, the rate limit is set at 10 requests per minute, which applies to both single requests and batches. Therefore, if requests are batched, you can send up to 100,000 requests per minute.
Additionally, the API Metrics add-on plan includes unlimited log history and up to 2,000 detailed history entries per response code.