Skip to main content
GET
List alert transitions

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

Filter to transitions of a single alert rule (format aru-<number>).

alertInstanceID
string

Filter to transitions of a single alert instance (format ain-<number>).

page
integer
default:1

The page number to retrieve for paginated results.

Example:

1

pageSize
integer
default:10

The number of items to return per page. Useful for pagination.

Example:

20

Response

Paginated list of alert transitions. Paging metadata is returned in X-Corbado-Page, X-Corbado-TotalPages, and X-Corbado-TotalItems response headers.

Maximum array length: 1000
id
string
required

Alert transition ID (format atr-<number>).

alertRuleID
string
required

Alert rule ID (format aru-<number>).

alertInstanceID
string
required

Alert instance ID (format ain-<number>).

toStatus
enum<string>
required
Available options:
normal,
pending,
firing,
no_data,
error
reason
enum<string>
required

The machine code for why this transition happened. recovery marks a firing instance going quiet and only that, so a pending instance that stops breaching is breach_cleared rather than a recovery that never fired. A transition into no_data carries the instance's noDataReason here instead, so why there was no value survives from the computation into the history - which is why the last four values below overlap that vocabulary.

Available options:
breach,
breach_cleared,
for_satisfied,
escalation,
de_escalation,
recovery,
no_data,
data_returned,
error,
too_many_instances,
rule_changed,
division_by_zero,
guard_not_met,
dimension_not_available,
series_not_available
notified
boolean
required
evaluatedMs
integer<int64>
required
createdMs
integer<int64>
required
labels
object

The label set of the alert instance this row is about, resolved from alertInstanceID so the history can name the alert the way the alert list does. Absent for the ungrouped alert of a rule with no groupBy, which has no labels.

fromStatus
enum<string>
Available options:
normal,
pending,
firing,
no_data,
error
fromSeverity
enum<string>

The severity band before this transition, absent when none matched.

Available options:
info,
warning,
critical
toSeverity
enum<string>

The severity band after this transition, absent when none matched. A transition that changes only the level and not the status is still recorded, which is what lets the history show band flapping the inbox never saw.

Available options:
info,
warning,
critical
value
number<double>
thresholdValue
number<double>
sampleSize
integer<int64>
message
string