Get Performance Report
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.
Parameters
Parameter | Description |
---|---|
Check ID | Specifies the id of the check for which the performance report will be fetched. |
From | 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. |
Include Uptime | Include uptime information. Adds field downtime, uptime, and unmonitored to the interval array objects. |
Order | Sorting order of outages. Ascending or descending. |
Resolution | 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. |
To | 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. |
Example Output
{
"report": {
"check_id": 123,
"intervals": [
{
"average_response": 123,
"downtime": 10,
"from": "2020-07-10T10:51:55.000Z",
"steps": [
{
"average_response": 123,
"step": {
"args": {
"checkbox": "string",
"element": "string",
"form": "string",
"input": "string",
"option": "string",
"password": "string",
"radio": "string",
"seconds": "string",
"select": "string",
"url": "http://www.google.com",
"username": "string",
"value": "string"
},
"fn": "go_to"
}
}
],
"unmonitored": 50,
"uptime": 230
}
],
"name": "My awesome check",
"resolution": "day"
}
}
Workflow Library Example
Get Performance Report with Pingdom and Send Results Via Email
Preview this Workflow on desktop