AlertRuleResponse
objectAn 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
AlertRuleUpdateRequest
objectUpdate alert rule request (PATCH - partial updates)
namestring
Alert rule name
project_idstring
Project ID
metric
Metric to monitor
Allowed values:turn_latency_p50turn_latency_p95api_errorsfunction_errorscall_crashescall_volume
operator
Comparison operator
Allowed values:><>=<=
threshold_valueinteger
Threshold value
>= 0
window_duration
Window duration (5m, 10m, or 60m)
Allowed values:5m10m60m
enabledboolean
Whether the alert is enabled
Example
AlertState
Alert state enum
Allowed values:okalertno_dataunknown
HTTPValidationError
objectdetailarray[object]
Show Child Parameters
Example
ValidationError
objectloc
Any Ofarrayrequired
Variant 1string
msgstringrequired
typestringrequired
Example