Skip to main content
GET
Get alert rule 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

alertRuleID
string
required

The alert rule to describe (format aru-<number>).

interval
enum<string>
required

Bucket size, one day or one calendar month in the project's timezone.

Available options:
daily,
monthly
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 500 days.

Response

Statistics for the alert rule over the window.

One alert rule's evaluations over a requested window, counted per status and bucketed by day or month. dataFromMs and dataToMs span every day with statistics, regardless of the window, so a client knows how far it can navigate. Both are absent when the rule has no statistics yet.

buckets
object[]
required
Maximum array length: 500
dataFromMs
integer<int64>

Start of the first day with statistics, in milliseconds since epoch.

dataToMs
integer<int64>

Start of the last day with statistics, in milliseconds since epoch.