Appearance
What to expect from us
Doppio uses standard HTTP response codes so our API responses stay easy to understand. The table below explains what each status code means:
| Status code | Meaning | Description |
|---|---|---|
| 200 | OK | The request succeeded. |
| 400 | Bad Request | The server cannot or will not process the request because of an apparent client error, such as malformed request syntax or a payload that is too large. |
| 401 | Unauthorized | No valid API key provided. |
| 403 | Forbidden | Your subscription is inactive, or it does not include the requested functionality. |
| 404 | Not Found | The requested resource does not exist. |
| 413 | Payload Too Large | The request body is too large. Contact support if you need help. |
| 422 | Unprocessable Entity | The total number of requests exceeds your subscription limits. |
| 429 | Too Many Requests | Too many requests were sent to the server in a short period of time. |
| 5xx | Server Error | An error occurred on Doppio's server. |
Error Response
If a request is not successful, our API returns a JSON payload with three fields: statusCode, message, and error, as shown below:
json
{
"statusCode": 400,
"message": [
"page.goto.url must be an URL address"
],
"error": "Bad Request"
}statusCode and error match the values shown in the table above. When available, message provides more details about the error. A single statusCode can include several validation messages. Here are a few examples of messages you might receive for a Bad Request error:
page.goto.url must be an URL addresspage.setContent.html must be base64 encodedUnexpected token } in JSON at position 96