Errors
The complete list of response codes you can get, how the errors object is structured, and all the information about rate limits
Commerce Layer Metrics API uses HTTP response codes to show the success or failure of each API request.
Codes in the
2xx
range indicate success.Codes in the
4xx
range indicate an error that failed given the information provided (e.g. due to a bad request, a failed validation, or an expired authentication).Codes in the
5xx
range indicate an unhandled error (these are rare and should never happen).
This is the complete list of response codes you can receive when making requests to the Metrics API endpoints:
Code | Description | |
---|---|---|
|
| The request was successfully processed and everything worked as expected. |
|
| The request was unacceptable, often due to malformed syntax or sending an unsupported parameter at the first level (see examples). |
|
| The access token was not present in the request, was expired, or didn't have enough permissions (see example). |
|
| The requested resource was not found, often due to a typo on the query type or resurce name in the endpoint. |
|
| The request method is known by the server but has been disabled and cannot be used (Metric API supports |
|
| The Accept header was not correctly set to |
|
| The Content-type header was not correctly set to |
|
| The request body was well-formed but contains semantical errors on a nested level, often due to validation constraints (see examples). |
|
| The request was not accepted because you hit the rate limit. |
|
| Something went wrong on our end and is being investigated by our engineers. |
Correct error handling is important. We recommend writing code that gracefully handles all possible API exceptions.
The error object
All the 4xx
and 5xx
responses include an error
object in the response body. The object contains the list of errors with some extra information.
Key | Type | Description |
---|---|---|
| String | Descriptive information about the type of error. |
| String | The HTTP response code (e.g. |
| Integer | The HTTP response status (e.g. |
| Object | Any additional information about the errors in the request. Returned for |
Errors meta
For some types of error the meta
object is also returned inside the error
object. It contains extra information that can help you understand what went wrong with your call to the Metrics API and why it wasn't successful:
Key | Type | Description |
---|---|---|
| Array of objects | The detailed list of errors in the request (with information messages and reference to the related wrong keys). Returned for |
| String | The ID of the request (feel free to share it with us in case the information provided isn't enough for you to debug the error). Returned for every type of error except for |
Metrics API query validations are subject to a hierarchy — the filter section is validated before the query type one, hence errors in the parameters of the latter won't be thrown unless the ones in the parameters of the former are fixed (see example).
Rate limits
Environment | Limit type | Max number of requests | Time window |
---|---|---|---|
Live | Average | 200 (to all endpoints) | 1 min |
Test | Average | 100 (to all endpoints) | 1 min |
Live | Burst | 50 (per endpoint) | 10 secs |
Test | Burst | 25 (per endpoint) | 10 secs |
IP addresses that exceed the rates above will be blocked until the frequency of the specific call drops below the allowed limit.
Examples
400 Bad request
The following request tries to perform a Metrics API query but both the query type and the filter keys are empty objects:
The following request tries to perform a Metrics API query with some syntax errors on the first level keys:
401 Unauthorized
405 Method not allowed
The following request tries to perform a Metrics API query using the GET
method:
406 Not acceptable
The following request tries to perform a Metrics API query specifying an unsupported or not existing API version in the header:
The following request tries to perform a Metrics API query using a wrong Accept header:
415 Unsupported media type
The following request tries to perform a Metrics API query using a wrong Content-Type header:
422 Unprocessable entity
The following request tries to perform a Metrics API query specifying only the date_from
parameter of the filter:
The following request tries to perform a Metrics API query using an unsupported operator as the query parameter:
The following request tries to perform a Metrics API query using some not valid fields and operators as filter parameters:
Last updated