Sign in

v3

OpenAPI 3.1.02026-07-31350397683.8 KB
Alerts

Get Alerts

Get all alerts for the organization, optionally filtered by source_scope

get/v1/alerts

Query parameters

source_scope'all' | 'observability' | 'simulation'

Allowed data source scope for when an alert fires: all, observability only, or simulation only.

Filter alerts by source scope

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

idstring required

Unique identifier for the alert

namestring required

Name of the alert

descriptionstring nullable

Description of the alert

is_enabledboolean required

Whether the alert is enabled

organization_idstring required

Organization ID

entity_type'standard_metric' | 'custom_goal' | 'custom_metric' | 'metadata_field' | 'system_failure' required

Enum representing the entity types for alerts.

entity_fieldstring required

The specific field/metric being monitored

operator'equals' | 'not_equals' | 'greater_than' | 'less_than' | 'greater_than_or_equal' | 'less_than_or_equal' | 'contains' | 'not_contains' required

Enum representing the comparison operators for alerts.

comparison_valuestring required

Value to compare against

last_triggered_atstring date-time nullable

When the alert was last triggered

trigger_countinteger required

Number of times triggered

created_bystring nullable

User who created the alert

applies_to_all_agentsboolean required

Whether the alert applies to all agents

agentsinteger[] nullable

Associated agent IDs

simulation_idinteger nullable

Optional experiments.id (simulation) this alert is scoped to

evaluation_scopestring nullable

How this alert is evaluated. Only 'per_simulation_run' is supported.

aggregationstring nullable

Aggregation mode used to compute the per-run metric value from test results within the run.

created_atstring date-time required

When the alert was created

updated_atstring date-time nullable

When the alert was last updated

updated_bystring nullable

User who last updated the alert

threshold_time_intervalinteger nullable required

For observability source_scope: time window in seconds. For simulation source_scope: K = number of recent completed runs.

min_eventsinteger nullable required

The minimum number of events for the alert. NULL for simulation alerts.

min_events_typestring

Whether min_events is an absolute count or a percentage

in_alertboolean required

Whether the alert is in alert

source_scopestring

Which data source fires this alert: 'all', 'observability', or 'simulation'

simulation_namestring nullable

Name of the simulation (experiment) this alert is scoped to, if any