Response errors

Indexing Insight API uses standard HTTP response status codes to indicate the success or failure of a request.

Below is a list of common error responses you may encounter, along with example JSON body.

400 Bad Request

The 400 Bad Request HTTP status code is when a request to our API has a malformed or missing required parameters.

The 400 response will also include the following JSON body:

{
  "error": "bad_request",
  "message": "Missing required parameter 'url_id' or 'full_url'.",
  "status": 400
}

The 401 Unathorized HTTP status code is when a request is from an accoun that has authentication credentials are missing, invalid, or expired.

For example, the user has a missing or invalid API key.

The 401 response will also include the following JSON body:

{
  "error": "unauthorized",
  "message": "Invalid or missing access token.",
  "status": 401
}

The 403 Forbidden HTTP status code is when the user does not have permission to access the requested resource.

For example, an API key does not have permission has not been granted access to a specific domain.

The 403 Forbidden response will also include the following JSON body:

{
  "error": "forbidden",
  "message": "You do not have permission to access this resource.",
  "status": 403
}

The 404 Not Found HTTP status code is when the user requested a URL that does not exist in our database.

For example, trying to access indexing data for a URL that does not exist in Indexing Insight for a specific domain.

The 404 Not Found response will also include the following JSON body:

{
  "error": "not_found",
  "message": "The requested resource was not found.",
  "status": 404
}

The 429 Too Many Requests HTTP status code is when the user has sent too many requests in a given amount of time (see rate limiting).

For example, exceeding the 60 requests per minute API limit.

The 429 Too Many Requests response will also include the following JSON body:

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Please try again later.",
  "status": 429
}

The 500 Internal Server Error is when an unexpected error occurred in our database or API.

For example, unexpected service outages.

The 500 Internal Server Error response will also include the following JSON body:

{
  "error": "internal_server_error",
  "message": "An unexpected error occurred. Please try again later.",
  "status": 500
}