GET checks/aggregated?fromUtc={fromUtc}&toUtc={toUtc}&detail_level={detail_level}&scope={scope}&forceEmptyRecords={forceEmptyRecords}&include_tag_op={include_tag_op}
Gets aggregated data and SLA between two dates. Note: Only data for checks visible to the user will be retrieved.
URL Parameters
| Name | Description |
|---|---|
| fromUtc | Timestamp in UTC format. Example: 2013-08-20T13:32:08. |
| toUtc | Timestamp in UTC format. Example: 2013-08-20T13:32:08. |
| include_tag | (Optional) The 'include_tag' parameter defines which checks to include in the response, by filtering on the check 'tags' (see the Filtering by Tags section in Remarks for details). |
| exclude_tag | (Optional) The 'exclude_tag' parameter defines which checks to exclude from the response, by filtering on the check 'tags' (see the Filtering by Tags section in Remarks for details). |
| detail_level | Result detalization level. Allowed values: 0, 1. Default value: 0. |
| 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. |
| include_tag_op | AND/OR mode for including tags. Allowed values: 'or', 'and'. Default value: 'or'. |
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.Filtering by Tags
Checks can be filtered on the check 'tags', using tag 'key' and/or 'value'. Tilde '~' is used to indicate values. Multiple values are separated with semicolon ';'. Example: Environment~Dev;Prod (Key: 'Environment', Values: 'Dev' and 'Prod').You can provide the tag key only (all checks with that key) or only the value (all checks with that value in any key). Examples: Environment (key); ~Dev (value).
You can use the tag or key ID, by adding a '.' (period) before the ID. Examples: .4568~Prod (Tag key ID:'4568', value 'Prod'); Environment~.6985 (Tag key: 'Environment', value ID:'6985').
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
curl --request GET "https://api-asm1.apica.io/v3/checks/aggregated?fromUtc=2021-08-20T13:32:08&toUtc=2013-08-21T13:32:08&detail_level=0&scope=h&forceEmptyRecords=true&include_tag_op={include_tag_op}&auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"
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
},
{
"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
},
{
"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
}
],
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59"
},
{
"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
},
{
"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
},
{
"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
}
],
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59"
},
{
"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
},
{
"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
},
{
"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
}
],
"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. |
| 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": "f1e6bb19-d6a6-4eca-acb8-4051e02d2255",
"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
},
{
"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
},
{
"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
}
],
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59"
},
{
"check_guid": "afa74b23-6cf8-484d-880d-a729b9b73c0d",
"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
},
{
"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
},
{
"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
}
],
"from_utc": "2013-09-26T15:00:00",
"to_utc": "2013-09-26T15:59:59"
},
{
"check_guid": "3059e9d2-efd3-41c3-9f0f-f550dd4c9df9",
"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
},
{
"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
},
{
"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
}
],
"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. |
| from_utc | DateTime |
Timestamp of period start in UTC. |
| to_utc | DateTime |
Timestamp of period end in UTC. |