alerting-v2

List rule executions

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/alerting/v2/execution_history/rules</span></div>

Refer to Spaces for more information.

Get a paginated list of rule execution events.<br/><br/>[Required authorization] Route required privileges: read_alerting-v2-execution-history.

get/api/alerting/v2/execution_history/rules

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/alerting/v2/execution_history/rules
  • Auth
    • API key in header Authorization
    • or HTTP basic

Query parameters

rule_idsstring[]

Rule id filter.

searchstring

Free-text search. Matches rule name, description or rule ID (case-insensitive). Combined with rule_ids using AND.

outcomesstring[]

Outcome filter.

fromstring date-time

Inclusive ISO datetime lower bound on event.start. Defaults to 24 hours before to, or before the request when to is omitted. Set it to see older executions.

tostring date-time

Inclusive ISO datetime upper bound on event.start.

sort_field'started_at' | 'duration_ms' required

Sort field. Defaults to started_at.

sort_order'asc' | 'desc' required

Sort direction.

pageinteger required

Page number.

per_pageinteger required

Number of results per page.

Response

Returns a paginated list of rule execution events.

pageinteger required
per_pageinteger required
totalinteger required

The number of rule executions matching the query. This count is an estimate: results above 10,000 may be reported as 10,000.

Changes