v1

latestOpenAPI 3.0.12026-07-233010767.7 KB
Reports

List alert metrics for the requested resources

get/reports/alerts

Query parameters

sourcesnumber

alert source ids to filter metrics for

policiesnumber

escalation policy ids to filter metrics for

numbersstring

phone numbers of call routing numbers to filter metrics for

fromstring required

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

untilstring required

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

timezonestring

Time zone in which the results will be rendered, defaults to tenant's configured default timezone

metricstring

Describes the metric that should be fetched choose one of: COUNT, MTTA or MTTR - defaults to COUNT

group-bystring

Defines the grouping of metrics, choose one of: DAY, WEEK or MONTH - defaults to WEEK

prioritystring

Sets the priority filter that should be applied, choose one of: LOW, HIGH or ALL - defaults to ALL

Response

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