DocsGet startedErrors
Errors
One error envelope, stable codes.
Every error has the same shape. Branch on code, not on the message text.
Error body
{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded; retry in 12s",
"request_id": "req_4e1c0b9a7f2d4c6b8a10"
}
}| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | Missing or malformed parameter |
| 401 | missing_api_key | No Authorization header |
| 401 | invalid_api_key | Unknown key |
| 401 | credential_revoked | The key was revoked |
| 401 | credential_not_found | The key's workspace no longer exists |
| 402 | quota_exhausted | Plan limit of boards, saved ads or trackers reached |
| 403 | workspace_public_api_disabled | The plan has no API access (Pro or Business needed) |
| 404 | not_found | No ad, advertiser, shop, product, email, board or tracker with that id |
| 429 | rate_limited | Wait Retry-After seconds |
| 500 | internal_error | Unexpected failure; retry, then contact us with the request id |