Error Handling

Where an error occurs, it will usually be returned in the following format:

{
    "code": 400,
    "error": "BAD_REQUEST",
    "message": "Unable to parse timestamp"
}

Where an error is the result of invalid user input and there is only one parameter to the API call, BAD_REQUEST will usually be returned in the error field. Otherwise, a more specific error may be returned. The possible error values are documented in the documentation for the specific API methods. Only code and error should be used for automatic error handling, and the message field is meant to be displayed to application end users. You should not attempt to parse the message field automatically as its contents for any specific error may change at any time.

Where an unexpected internal error occurs, it will be returned in the following format:

{
    "code": 500,
    "error": "INTERNAL_ERROR",
    "message": "An internal error occured and was automatically reported",
    "error_id": "306845bc7abe489ca094330fb3b36da0"
}

The error ID can be tied to an auto-reported exception internally and can be given to us when reporting a bug for easier debugging. It is simply a random ID and does not contain information that is useful for anyone other than our team.