Skip to main content
GET
Get alerting summary

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.

Response

Alerting summary for the project.

Project-wide alerting totals, unaffected by any filter the caller has applied elsewhere.

ruleTotals
object
required

How many of the project's alert rules sit in each status. Every field is present, zero included, so a client can render the set without checking which keys exist.

instanceTotals
object
required

How many of a rule's alert instances sit in each status, counted over all of them rather than over a page of them. This is what lets a rule row say "2 of 12 firing" without the client reading a single instance - and what keeps that number from quietly becoming "2 of however many were fetched" once a rule groups into more instances than one page holds. Every field is present, zero included, so a client can render the set without checking which keys exist. Counts include every instance the rule currently has.

lastEvaluatedMs
integer<int64>

The most recent evaluation attempt across the project's rules. Absent when no rule has ever been attempted - which is the one thing the counts alone cannot say, because zero alerts because nothing is wrong looks exactly like zero alerts because nothing is running.