Alerts
Enterprise

List Alert Events

Changed on

Returns a paginated list of alert events. Events are system-generated and read-only via the API.

get/api/v2/alert-events

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/alert-events
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Query parameters

skipinteger

The number of items to skip in a paginated response.

This query parameter is used for determining the number of objects to skip in pagination.

limitinteger

The limit of results requested by the client.

This query parameter is used for setting an upper limit of objects returned in paginated responses.

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are created_at, attempts_queued_at. Default -created_at (most recent first).

typestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Supported operators are eq and neq. Must provide valid alert event types.

created_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by created_at value. See filter schema details for valid predicates.

deliveredstring

Filter results by column boolean value. Valid filter predicates are eq, neq.

When set to false, returns only events with attempts_queued_at IS NULL (events that have not yet had delivery attempts queued).

Response

OK

countinteger

The total number of results.

skipinteger

The number of items to skip in a paginated response.

limitinteger

The limit of results requested by the client.

Changes