Sign in

v1

latestOpenAPI 3.0.02026-08-0650184174.6 KB
TMS Checks

Returns a status change report for all transaction checks in the current organization

Get a list of status changes for all transaction check in the current organization from the requested time period. If order is speficied to descending, the list of statuses within each check is ordered by newest first. (The default is ordered by oldest first.) It can be used to display a list view of all checks and their current status.

get/tms/check/report/status

Query parameters

fromstring date-time

Start time of period. The format is RFC 3339 (properly URL-encoded!). The default value is one week earlier than to

tostring date-time

End time of period. The format is RFC 3339 (properly URL-encoded!). The default value is the current time

order'asc' | 'desc'

Sorting order of outages. Ascending or descending

limitstring

Limit of returned checks

offsetstring

Offset of returned checks

omit_emptyboolean

Omits checks without any results within specified time

Response

Status change report for all transaction check in the current organization

Example response

{
  "report": [
    {
      "check_id": 123,
      "name": "My awesome check",
      "states": [
        {
          "status": "down",
          "from": "2020-07-10T10:51:55.000Z",
          "to": "2020-07-14T07:25:15.000Z",
          "error_in_step": 2,
          "message": "URL should be 'http://www.example12345.com/' but is 'http://www.example.com/'."
        }
      ]
    }
  ]
}