Skip to main content
GET
List alert evaluations

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 evaluations of a single alert rule (format aru-<number>).

alertInstanceID
string

Filter to evaluations 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 evaluations. 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 evaluation ID (format aev-<number>).

alertRuleID
string
required

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

alertInstanceID
string
required

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

status
enum<string>
required

The instance's status as of this evaluation.

Available options:
normal,
pending,
firing,
no_data,
error
windowFromMs
integer<int64>
required

Start of the data window this evaluation read, in milliseconds since epoch.

windowToMs
integer<int64>
required

End of the data window this evaluation read, in milliseconds since epoch.

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.

value
number<double>

The computed value this evaluation produced, absent when there was none - no_data is not zero.

thresholdValue
number<double>

The threshold the value was compared against, absent when no band applied.

message
string
noDataReason
enum<string>

Why this evaluation has no value, absent when it has one or when it was recorded before evaluations carried a reason. Same vocabulary as the instance's noDataReason; outside_evaluation_hours tells an evaluation outside the rule's evaluation hours apart from one whose data was missing.

Available options:
no_data,
division_by_zero,
guard_not_met,
too_many_instances,
rule_changed,
dimension_not_available,
series_not_available,
outside_evaluation_hours
details
object

What the evaluation computed on the way to value: the counts it read and the numbers it derived from them, so the value can be checked. The shape depends on the rule's type, named in type. Absent when nothing was computed, e.g. outside the evaluation hours, and for evaluations recorded before evaluations carried details.