Skip to main content
GET
Get Alerts

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Query Parameters

source_scope
enum<string> | null

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

Available options:
all,
observability,
simulation

Response

Successful Response

id
string
required

Unique identifier for the alert

name
string
required

Name of the alert

is_enabled
boolean
required

Whether the alert is enabled

organization_id
string
required

Organization ID

entity_type
enum<string>
required

Type of entity being monitored

Available options:
standard_metric,
custom_goal,
custom_metric,
metadata_field,
system_failure
entity_field
string
required

The specific field/metric being monitored

operator
enum<string>
required

Comparison operator

Available options:
equals,
not_equals,
greater_than,
less_than,
greater_than_or_equal,
less_than_or_equal,
contains,
not_contains
comparison_value
string
required

Value to compare against

notification_channels
any[]
required

Notification channels configuration

trigger_count
integer
required

Number of times triggered

applies_to_all_agents
boolean
required

Whether the alert applies to all agents

created_at
string<date-time>
required

When the alert was created

threshold_time_interval
integer | null
required

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

min_events
integer | null
required

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

in_alert
boolean
required

Whether the alert is in alert

description
string | null

Description of the alert

last_triggered_at
string<date-time> | null

When the alert was last triggered

created_by
string | null

User who created the alert

agents
integer[] | null

Associated agent IDs

simulation_id
integer | null

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

evaluation_scope
string | null

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

aggregation
string | null

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

updated_at
string<date-time> | null

When the alert was last updated

updated_by
string | null

User who last updated the alert

min_events_type
string
default:events

Whether min_events is an absolute count or a percentage

source_scope
string
default:all

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

simulation_name
string | null

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

sample_size
integer | null

Most recent N conversations the alert is evaluated over; NULL = time window