Skip to main content
GET
Get alert instance statistics

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Query Parameters

alertInstanceID
string
required

The alert instance to describe (format ain-<number>).

fromMs
integer<int64>
required

Window start (epoch ms, inclusive).

toMs
integer<int64>
required

Window end (epoch ms, exclusive). Must be after fromMs; the window may span at most 366 days.

Response

Statistics for the alert instance over the window.

One alert instance's history over a requested window, in the two shapes the statistics panel draws: an hourly-bucketed evaluation series for the value chart, and the status timeline as merged phases plus per-status totals. The series carries only the hours that have evaluations; the phases jointly cover the window from the first known status to the earlier of the window's end and now.

series
object[]
required
Maximum array length: 2500
phases
object[]
required
Maximum array length: 10000
totals
object
required

How long the instance spent in each status within the window, and how often it fired. Every field is present, zero included, and the durations add up to the covered part of the window - the stretch before the instance existed, or after now, is in none of them.

thresholdValue
number<double>

The instance's current threshold, for the chart's reference line. Absent when no band applies.