If the request parameters are invalid or the authorisation fails when sending a request to the API an error will be returned. The error will have a code, message and some extra details about the error. Below is a list of all possible errors that can be returned.
Name |
Code |
Message |
Details |
Resolution |
|---|---|---|---|---|
| General | 0 | Sorry, an unknown error occured | Try the request again. If it continues to fail, send the URL used to make the request to us for investigation. | |
| Internal | 1 | An internal error occurred | Try the request again. If it continues to fail, send the URL used to make the request to us for investigation. | |
| Invalid Object | 2 | Invalid API object requested | Object '[object_type]' is an invalid object type. | This error will occur if one of 'documents', 'images' or 'sections' isn't in the right place in the URL or is spelled incorrectly. |
| Invalid Collection | 3 | Invalid API collection requested | Collection '[resource_name]' is an invalid API collection key. | This error will occur if the collection key isn't in the right place in the URL or is spelled incorrectly. |
| Invalid Operation | 4 | Invalid query requested | Details vary | Will usually be returned when the 'query' parameter is invalid. Reading the details returned will allow you to diagnose the error. |
| Invalid Parameters | 5 | Invalid request parameters | Will be returned if the collection key and/or the version number are not present in the URL. | |
| Response Size | 6 | The response size is above the allowed limit | Try to reduce the number of items you are requesting. The limit is 200. | This error will be returned when the take parameter is too high or the response size exceeds the maximum allowed size in bytes. |
| Request Rate | 429 | Too many requests made to server | Please wait for a few minutes before making any more requests | Every user of the API has a request limit of about 180 requests every 15 minutes. If this rate is exceeded this error will be returned. |
| Request Size | 413 | Request size too large | Try lowering the size of the request made to the server | This error will only be returned if the request made to the server is above a maximum limit. |
| Unauthorised | 401 | Unauthorised | If authentication via API Key fails this error will be returned. |