Read Events - Prefect

Headers

x-prefect-api-version

string

Body

application/json

filter

object | null

Additional optional filter criteria to narrow down the set of Events

filter.occurred

object

Filter criteria for when the events occurred

filter.event

object | null

Filter criteria for the event name

filter.any_resource

object | null

Filter criteria for any resource involved in the event

filter.resource

object | null

Filter criteria for the resource of the event

Filter criteria for the related resources of the event

filter.id

object

Filter criteria for the events' ID

filter.order

enum<string>

The order to return filtered events

Available options:

ASC,

DESC

limit

integer

default: 50

The number of events to return with each page

Required range: 0 < x < 50

Response

200 - application/json

A single page of events returned from the API, with an optional link to the next page of results

events

object[]

required

The Events matching the query

total

integer

required

The total number of matching Events

next_page

string | null

required

The URL for the next page of results, if there are more

Minimum length: 1

APIs & SDK

Headers

Body

Response