Sign in

v1

latestOpenAPI 3.0.02026-08-0650184174.6 KB
TMS Checks

Returns a performance report for a single transaction check

For a given period of time, return a list of time intervals with the given resolution. An interval may be a week, a day or an hour depending on the chosen resolution. It can be used to display a detailed view of a check with information about its steps and generate graphs.

get/tms/check/{check_id}/report/performance

Path parameters

check_idinteger required

Specifies the id of the check for which the performance 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 10 times the resolution (10 hours, 10 day, 10 weeks) earlier than to. The value is extended to the nearest hour, day or week, depending on the 'resolution' parameter and configured time zone of the account.

tostring date-time

End time of period. The format is RFC 3339 (properly URL-encoded!). The default value is the current time. The value is extended to the nearest hour, day or week, depending on the 'resolution' parameter and configured time zone of the account.

order'asc' | 'desc'

Sorting order of outages. Ascending or descending

resolution'hour' | 'day' | 'week'

Size of an interval for which the results are calculated. For the hour resolution, the max allowed period is one week and 1 day. For the day resolution, the max allowed period is 6 months and 1 day.

include_uptimeboolean

Include uptime information. Adds field downtime, uptime, and unmonitored to the interval array objects.

Response

Performance report for a single transaction check

Example response

{
  "report": {
    "check_id": 123,
    "name": "My awesome check",
    "resolution": "day",
    "intervals": [
      {
        "average_response": 123,
        "from": "2020-07-10T10:51:55.000Z",
        "downtime": 10,
        "uptime": 230,
        "unmonitored": 50,
        "steps": [
          {
            "step": {
              "args": {
                "url": "http://www.google.com"
              },
              "fn": "go_to"
            },
            "average_response": 123
          }
        ]
      }
    ]
  }
}