Reports
alert source ids to filter metrics for
escalation policy ids to filter metrics for
phone numbers of call routing numbers to filter metrics for
date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, start of the time range, may not exceed 1 year in total span
date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, end of the time range, must be after 'from', must not be in the future
Time zone in which the results will be rendered, defaults to tenant's configured default timezone
Describes the metric that should be fetched choose one of: COUNT, MTTA or MTTR - defaults to COUNT
Defines the grouping of metrics, choose one of: DAY, WEEK or MONTH - defaults to WEEK
Sets the priority filter that should be applied, choose one of: LOW, HIGH or ALL - defaults to ALL
GET /api/reports/alerts?from=text&until=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
an array of alert report metrics, each metric is another array containing data in the following order:
[long:alertSourceId, long:escalationPolicyId, string:callRoutingNumberPhoneNumber, string:ISO-8601, long:value]
e.g. [ [202541, 13541, "", "2021-08", 15] ]
Please note: the ISO-8601 (4th column) in this case depends on the chosen 'group-by' parameter. DAY=2021-08-01, WEEK=2021-W12, MONTH=2021-08
[
[
1
]
]alert source ids to filter metrics for
escalation policy ids to filter metrics for
phone numbers of call routing numbers to filter metrics for
date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, start of the time range, may not exceed 1 year in total span
date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, end of the time range, must be after 'from', must not be in the future
Time zone in which the results will be rendered, defaults to tenant's configured default timezone
Describes the metric that should be fetched choose one of: COUNT, MTTA or MTTR - defaults to COUNT
Defines the grouping of metrics, choose one of: DAY, WEEK or MONTH - defaults to WEEK
Sets the priority filter that should be applied, choose one of: LOW, HIGH or ALL - defaults to ALL
GET /api/reports/alerts/summary?from=text&until=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
an array containing summarized alert report metrics for the requested resource
[
{
"alertSourceId": 1,
"escalationPolicyId": 1,
"callRoutingNumberPhoneNumber": "text",
"count": 1,
"mtta": 1,
"mttr": 1
}
]This endpoint requires 'ADMIN' permissions
scopes of our API resources e.g. alert see https://docs.ilert.com/rest-api/developing-ilert-apps/token-lifetimes-error-codes-app-verification-etc.#ilert-oauth2-scopes
date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, start of the time range, may not exceed 1 month (31 days) in total span (use this to paginate)
date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, end of the time range, must be after 'from', must not be in the future (use this to paginate)
Time zone in which the results will be rendered, defaults to tenant's configured default timezone
GET /api/reports/api-keys/usage?from=text&until=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
an array of usage metrics, each metric is another array containing data in the following order:
[long:userId, string:scope, string:ISO-8601, long:value]
e.g. [ [202541, "source", "2023-04-21", 15] ]
Please note: the ISO-8601 (3th column) in this case is always DAY (2021-08-01) usually 24 hours apart, but there is a slight chance that the same userId and scope have multiple entries for the same DAY
[
[
1
]
]Was this helpful?