List organization alerts
Retrieves a list of all alerts in the organization with filtering and pagination options. Shows alert summaries including names, status, folder organization, and basic configuration details for monitoring and management purposes.
Request
- Base URLhttps://api.openobserve.ai (the document declares no server; this is the origin it was published from)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Organization name
Query parameters
Optional folder ID filter parameter.
Restrict the list to the alerts attached to one SLO (Feature 5, B1). Reads the indexed slo_id column, so it is a SQL predicate rather than an app-side scan. An EMPTY value matches nothing — see the field docs on ListAlertsParams::slo_id.
Optional stream type filter parameter.
Optional stream name filter parameter.
This parameter is only used if stream_type is also provided.
Optional case-insensitive name substring filter parameter.
Optional owner user filter parameter.
Optional enabled filter parameter.
The optional number of alerts to retrieve. If not set then all alerts that match the query parameters will be returned.
The optional page index. If not set then defaults to 0.
This parameter is only used if page_size is also set.
Filters the alert list by alert type (scheduled, realtime, anomaly detection, or all).
Optional alert type filter: all (default), scheduled, realtime, or anomaly_detection.
Optional priority filter (PT-3), OR semantics.
Accepts BOTH shapes, because both are natural to type and to generate:
- repeated — ?priority=1&priority=2
- comma-separated — ?priority=1,2
Each value may be 1 or P1. Declared as a Vec so repeated keys deserialize; absent leaves it empty, which means no filter.
Optional tag filter (PT-8). Comma-separated, AND semantics — an alert must carry every listed tag.
Optional sort column: priority or name. Anything else keeps the historical ordering.
Sort direction: desc for descending, anything else ascending.
When true, each list item also carries its notification destinations and any alert-level template override — the fields the notification dependency view cross-references. Only that view opts in; the default (absent / false) keeps them off the hot list path so ordinary consumers neither pay the extra bytes nor receive destination/template names.
Response
Success
Example response
{
"list": [
{
"priority": 3
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.