Alerts API

AlertMetric

Alert metric enum

Allowed values:turn_latency_p50turn_latency_p95api_errorsfunction_errorscall_crashescall_volume

AlertOperator

Alert operator enum

Allowed values:><>=<=

AlertRuleCreateRequest

object

Fields for creating a new alert rule: which metric to watch, the
threshold condition, and how long it must hold to fire.

namestringrequired

Alert rule name

project_idstring

Project ID (optional)

metricrequired

Metric to monitor

Allowed values:turn_latency_p50turn_latency_p95api_errorsfunction_errorscall_crashescall_volume

operatorrequired

Comparison operator

Allowed values:><>=<=

threshold_valueintegerrequired

Threshold value

>= 0

window_durationrequired

Window duration (5m, 10m, or 60m)

Allowed values:5m10m60m

enabledboolean

Whether the alert is enabled

Default:true

Example

AlertRuleListResponse

object

Every alert rule in scope, each with its current state.

dataarray[object]required

An alert rule: its trigger condition, evaluation window, and current state.

Show Child Parameters
Example

AlertRuleResponse

object

An alert rule: its trigger condition, evaluation window, and current state.

idstringrequired

Alert rule ID

namestringrequired

Alert rule name

project_idstring

Project ID

metricstringrequired

Metric being monitored

operatorstringrequired

Comparison operator

threshold_valueintegerrequired

Threshold value

window_durationstringrequired

Window duration (5m, 10m, or 60m)

enabledbooleanrequired

Whether the alert is enabled

current_statestring

Current alert state

sincestring(date-time)

When the current state started

last_evaluated_atstring(date-time)

Last evaluation timestamp

current_valueinteger

Current metric value

created_atstring(date-time)required

Creation timestamp

updated_atstring(date-time)required

Last update timestamp

Example