Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:1000

Maximum number of alerts to return.

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of alerts to skip before returning results.

Required range: x >= 0
tag
string[]

Only return alerts that have any of the given tags. Repeat the parameter to pass several tags. Matches the tags stored on the alert, not tags inherited from the linked dashboard or saved search.

Maximum array length: 50
Maximum string length: 32

Only return alerts whose display name contains this text (case-insensitive). Matches the display name stored on the alert, not a name derived from the linked dashboard or saved search.

Maximum string length: 512
source
enum<string>[]

Only return alerts of any of the given sources. Repeat the parameter to pass several sources.

Alert source type. "saved_search" alerts monitor a saved search, "tile" alerts monitor a dashboard tile, and "inline" alerts carry their own chart configuration (see AlertChartConfig) without requiring a saved search or dashboard.

Available options:
saved_search,
tile,
inline
state
enum<string>[]

Only return alerts in any of the given states. Repeat the parameter to pass several states.

Current alert state.

Available options:
ALERT,
OK,
INSUFFICIENT_DATA,
DISABLED,
PENDING

Response

Successfully retrieved alerts

data
object[]
required

List of alert objects.

meta
object
required

Pagination metadata for this result page.