Error codes

Error codes

Any HTTP response status different to 200 is considered an error.

When this happens, the response payload includes some useful information in order to determine the root cause of the problem:

  • status: The status associated with the response.
  • code: The internal error code to identify the error.
  • message: A brief explanantion about why the error happened.
  • more: A link pointing this documentation, extending the details.

TOO_BIG_PAYLOAD

Why this error occurred

This happens when the number of results is bigger than the quantity of data the service can handle.

The maximum payload size for the response body is 6 MB.

Possible ways to fix it

First, ensure to setup compression.

If the error is still happening, provide a way for filtering the data.

Check recipes to see some examples.