The Response Format

All requests using GET, POST or PUT to our API will return a JSON formatted body containing the result. We wrap this data in an envelope of ‘response’ and also contain certain metadata such as record counts or pagination derails.

Single Object Response

{
  "response": {
    "id": 1,
    "name": "My Example Status Page"
  }
}

Multi Object Responses

{
  "response": [{
    "id": 1,
    "name": "My Example Status Page"
  }, {
    "id": 2,
    "name": "Another Status Page"
  }],
  "count": 2
}

Errors

For details on how errors are handled please take a look at our Errors section.