Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Events

Get a list of events

The event stream can be queried and filtered by time, priority, sources and tags.

Notes:

  • If the event you’re querying contains markdown formatting of any kind, you may see characters such as %,\,n in your output.

  • This endpoint returns a maximum of 1000 most recent results. To return additional results, identify the last timestamp of the last result and set that as the end query time to paginate the results. You can also use the page parameter to specify which set of 1000 results to return.

get/api/v1/events

Query parameters

startinteger required

POSIX timestamp.

endinteger required

POSIX timestamp.

priority'normal' | 'low' nullable

The priority of the event. For example, normal or low.

Example:normal

Priority of your events, either low or normal.

sourcesstring

A comma separated string of sources.

tagsstring

A comma separated list indicating what tags, if any, should be used to filter the list of events.

unaggregatedboolean

Set unaggregated to true to return all events within the specified [start,end] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with is_aggregate=true in the response will still be returned unless exclude_aggregate is set to true.

exclude_aggregateboolean

Set exclude_aggregate to true to only return unaggregated events where is_aggregate=false in the response. If the exclude_aggregate parameter is set to true, then the unaggregated parameter is ignored and will be true by default.

pageinteger

By default 1000 results are returned per request. Set page to the number of the page to return with 0 being the first page. The page parameter can only be used when either unaggregated or exclude_aggregate is set to true.

Response

OK

statusstring

A status.

Example response

{
  "events": [
    {
      "alert_type": "info",
      "payload": "{}",
      "priority": "normal",
      "tags": [
        "environment:test"
      ],
      "text": "Oh boy!",
      "title": "Did you hear the news today?"
    }
  ]
}