v1
latestOpenAPI 3.0.02026-08-0650184174.6 KBTMS Checks
Returns a status change report for a single transaction check
Get a list of status changes for a specified check and time period. If order is speficied to descending, the list is ordered by newest first. (The default is ordered by oldest first.) It can be used to display a detailed view of a check.
get/tms/check/{check_id}/report/status
Path parameters
check_idinteger required
Specifies the id of the check for which the status change report will be fetched
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
Response
Status change report for a single transaction check
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/'."
}
]
}
}