GET checks/{checkId}/aggregated?mostrecent={mostrecent}&detail_level={detail_level}&include_step_metrics={include_step_metrics}&scope={scope}&forceEmptyRecords={forceEmptyRecords}
For a specific check - gets aggregated data and SLA for the most recent periods in a scope.
URL Parameters
| Name | Description |
|---|---|
| checkId | Check identifier. Type: numeric. |
| mostrecent | Number of most recent periods back (ie 3 days back if the scope is day). Type: numeric. Default value: 4. |
| detail_level | Result detalization level. Allowed values: 0, 1. Default value: 0. |
| include_step_metrics | Include aggregated data for check steps. Allowed values: true, false. Default value: false. |
| scope | String representation of scope. Allowed values: y, q, m, w, d, h (where "y" is year, "h" is hour, etc). Default value: h. |
| forceEmptyRecords | Includes/excludes empty records to response. True by default. Pass 'false' to exclude empty values. |
Remarks
The default context for the route is the user context. To enable customer context (if it's allowed for the user) use the request query parameter customer_context=1.Return value "u_count" is deprecated and will always equal to "0".
Results are aggregated on the hour, every hour and made available 5 minutes after the hour. Queries for results that have not yet been aggregated will return “NULL”. To exclude them from response use the request query parameter forceEmptyRecords=false.
Responses
Request example
Response body model examples and descriptions
When result detalization level is 0
{
"check_id": 1,
"check_name": "Check name",
"sla_records": [
{
"unit": "ms",
"avg_attempts": 12.0,
"avg": 583.0,
"mdn": 522.0,
"max": 1187,
"min": 347,
"std": 201.0,
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59",
"sla_percent": 90.0,
"total_count": 10,
"i_count": 7,
"w_count": 2,
"e_count": 0,
"f_count": 1,
"u_count": 0,
"step_metrics": [
{
"step": 3,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 1,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 2,
"step_name": "Step #1",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
}
]
},
{
"unit": "ms",
"avg_attempts": 12.0,
"avg": 583.0,
"mdn": 522.0,
"max": 1187,
"min": 347,
"std": 201.0,
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59",
"sla_percent": 90.0,
"total_count": 10,
"i_count": 7,
"w_count": 2,
"e_count": 0,
"f_count": 1,
"u_count": 0,
"step_metrics": [
{
"step": 1,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 1,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 3,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
}
]
},
{
"unit": "ms",
"avg_attempts": 12.0,
"avg": 583.0,
"mdn": 522.0,
"max": 1187,
"min": 347,
"std": 201.0,
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59",
"sla_percent": 90.0,
"total_count": 10,
"i_count": 7,
"w_count": 2,
"e_count": 0,
"f_count": 1,
"u_count": 0,
"step_metrics": [
{
"step": 1,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 1,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 1,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
}
]
}
],
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59"
}
| Name | Type | Description |
|---|---|---|
| check_id | Integer | The numeric identifier of the check. |
| check_name | String | The name of the check. |
| sla_records | Array | SLA records. |
| unit | String | The unit of the check return value. |
| avg_attempts | Float | The average number of attempts performed per check run during the period. |
| avg | Float | The average check return value during the period. |
| mdn | Float | The statistical median for the returned value during the selected date range. Please note that median values may not be available for long date scopes. |
| max | Integer | The maximum check return value during the period. |
| min | Integer | The minumum check return value during the period. |
| std | Float | The standard deviation for the check return value during the period. |
| from_utc | DateTime | Start of the time period (UTC). |
| to_utc | DateTime | End of the time period (UTC). |
| sla_percent | Float | The ratio of successful (i.e. I and W severity) runs to total runs. |
| total_count | Integer | Total number of check runs during the period. |
| i_count | Integer | The number of check runs with severity=I during the period. |
| w_count | Integer | The number of check runs with severity=W during the period. |
| e_count | Integer | The number of check runs with severity=E during the period. |
| f_count | Integer | The number of check runs with severity=F during the period. |
| u_count | Integer | The number of check runs with unknown severity (U) during the period. |
| step_metrics | Array | The array of step metrics. |
| step | Integer | The number of the step. |
| step_name | String | The name of the step. |
| dom_complete | Object | DOM Complete |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| dom_interactive | Object | DOM Interactive |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| dom_content_loaded | Object | DOM Content Loaded |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| response | Object | Response Time |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| render | Object | Total Browser Render Time |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| duration | Object | Duration Time |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| execution | Object | Execution Time |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| from_utc | DateTime | Timestamp of period start in UTC. |
| to_utc | DateTime | Timestamp of period end in UTC. |
When result detalization level is 1
{
"check_guid": "96f86e78-21e2-47e9-9fb3-ba6e98c989f9",
"check_type": "FprXnet",
"target_sla": "95",
"check_id": 2,
"check_name": "Check name",
"sla_records": [
{
"unit": "ms",
"avg_attempts": 12.0,
"avg": 583.0,
"mdn": 522.0,
"max": 1187,
"min": 347,
"std": 201.0,
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59",
"sla_percent": 90.0,
"total_count": 10,
"i_count": 7,
"w_count": 2,
"e_count": 0,
"f_count": 1,
"u_count": 0,
"step_metrics": [
{
"step": 1,
"step_name": "Step #3",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 2,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 2,
"step_name": "Step #3",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
}
]
},
{
"unit": "ms",
"avg_attempts": 12.0,
"avg": 583.0,
"mdn": 522.0,
"max": 1187,
"min": 347,
"std": 201.0,
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59",
"sla_percent": 90.0,
"total_count": 10,
"i_count": 7,
"w_count": 2,
"e_count": 0,
"f_count": 1,
"u_count": 0,
"step_metrics": [
{
"step": 2,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 1,
"step_name": "Step #3",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 2,
"step_name": "Step #2",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
}
]
},
{
"unit": "ms",
"avg_attempts": 12.0,
"avg": 583.0,
"mdn": 522.0,
"max": 1187,
"min": 347,
"std": 201.0,
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59",
"sla_percent": 90.0,
"total_count": 10,
"i_count": 7,
"w_count": 2,
"e_count": 0,
"f_count": 1,
"u_count": 0,
"step_metrics": [
{
"step": 2,
"step_name": "Step #3",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 2,
"step_name": "Step #3",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
},
{
"step": 1,
"step_name": "Step #3",
"dom_complete": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_interactive": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"dom_content_loaded": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"response": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"render": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"duration": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
},
"execution": {
"std": 0.9,
"min": 1,
"max": 1,
"avg": 0.9
}
}
]
}
],
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59"
}
| Name | Type | Description |
|---|---|---|
| check_guid | Guid | The GUID of the check. |
| check_type | String | The type of the check. |
| target_sla | String | The target SLA of the check. |
| check_id | Integer | The numeric identifier of the check. |
| check_name | String | The name of the check. |
| sla_records | Array | SLA records. |
| unit | String | The unit of the check return value. |
| avg_attempts | Float | The average number of attempts performed per check run during the period. |
| avg | Float | The average check return value during the period. |
| mdn | Float | The statistical median for the returned value during the selected date range. Please note that median values may not be available for long date scopes. |
| max | Integer | The maximum check return value during the period. |
| min | Integer | The minumum check return value during the period. |
| std | Float | The standard deviation for the check return value during the period. |
| from_utc | DateTime | Start of the time period (UTC). |
| to_utc | DateTime | End of the time period (UTC). |
| sla_percent | Float | The ratio of successful (i.e. I and W severity) runs to total runs. |
| total_count | Integer | Total number of check runs during the period. |
| i_count | Integer | The number of check runs with severity=I during the period. |
| w_count | Integer | The number of check runs with severity=W during the period. |
| e_count | Integer | The number of check runs with severity=E during the period. |
| f_count | Integer | The number of check runs with severity=F during the period. |
| u_count | Integer | The number of check runs with unknown severity (U) during the period. |
| step_metrics | Array | The array of step metrics. |
| step | Integer | The number of the step. |
| step_name | String | The name of the step. |
| dom_complete | Object | DOM Complete |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| dom_interactive | Object | DOM Interactive |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| dom_content_loaded | Object | DOM Content Loaded |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| response | Object | Response Time |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| render | Object | Total Browser Render Time |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| duration | Object | Duration Time |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| execution | Object | Execution Time |
| std | Float | The standard deviation for the step metric value. |
| min | Integer | The minimum step metric value. |
| max | Integer | The maximum step metric value. |
| avg | Float | The average step metric value. |
| from_utc | DateTime | Timestamp of period start in UTC. |
| to_utc | DateTime | Timestamp of period end in UTC. |