Read Events

curl --request POST \
  --url https://api.example.com/api/events/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "occurred": {
      "since": "2023-11-07T05:31:56Z",
      "until": "2023-11-07T05:31:56Z"
    },
    "event": {
      "prefix": [
        "<string>"
      ],
      "exclude_prefix": [
        "<string>"
      ],
      "name": [
        "<string>"
      ],
      "exclude_name": [
        "<string>"
      ]
    },
    "resource": {
      "id": [
        "<string>"
      ],
      "id_prefix": [
        "<string>"
      ],
      "labels": {},
      "distinct": false
    },
    "related": {
      "id": [
        "<string>"
      ],
      "role": [
        "<string>"
      ],
      "resources_in_roles": [
        "<array>"
      ],
      "labels": {}
    },
    "any_resource": {
      "id": [
        "<string>"
      ],
      "id_prefix": [
        "<string>"
      ],
      "labels": {}
    },
    "id": {
      "id": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "text": {
      "query": "<string>"
    },
    "order": "DESC"
  },
  "limit": 50
}
'

{
  "events": [
    {
      "occurred": "2023-11-07T05:31:56Z",
      "event": "<string>",
      "resource": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "related": [
        {}
      ],
      "payload": {},
      "follows": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "received": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "next_page": "<string>"
}

POST

api

events

filter

Read Events

curl --request POST \
  --url https://api.example.com/api/events/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "occurred": {
      "since": "2023-11-07T05:31:56Z",
      "until": "2023-11-07T05:31:56Z"
    },
    "event": {
      "prefix": [
        "<string>"
      ],
      "exclude_prefix": [
        "<string>"
      ],
      "name": [
        "<string>"
      ],
      "exclude_name": [
        "<string>"
      ]
    },
    "resource": {
      "id": [
        "<string>"
      ],
      "id_prefix": [
        "<string>"
      ],
      "labels": {},
      "distinct": false
    },
    "related": {
      "id": [
        "<string>"
      ],
      "role": [
        "<string>"
      ],
      "resources_in_roles": [
        "<array>"
      ],
      "labels": {}
    },
    "any_resource": {
      "id": [
        "<string>"
      ],
      "id_prefix": [
        "<string>"
      ],
      "labels": {}
    },
    "id": {
      "id": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "text": {
      "query": "<string>"
    },
    "order": "DESC"
  },
  "limit": 50
}
'

{
  "events": [
    {
      "occurred": "2023-11-07T05:31:56Z",
      "event": "<string>",
      "resource": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "related": [
        {}
      ],
      "payload": {},
      "follows": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "received": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "next_page": "<string>"
}

Headers

x-prefect-api-version

string

Body

application/json

filter

EventFilter · object

Additional optional filter criteria to narrow down the set of Events

Show child attributes

filter.occurred

EventOccurredFilter · object

Filter criteria for when the events occurred

Show child attributes

filter.occurred.since

string<date-time>

Only include events after this time (inclusive)

filter.occurred.until

string<date-time>

Only include events prior to this time (inclusive)

filter.event

EventNameFilter · object

Filter criteria for the event name

Show child attributes

filter.event.prefix

string[] | null

Only include events matching one of these prefixes

filter.event.exclude_prefix

string[] | null

Exclude events matching one of these prefixes

filter.event.name

string[] | null

Only include events matching one of these names exactly

filter.event.exclude_name

string[] | null

Exclude events matching one of these names exactly

filter.resource

EventResourceFilter · object

Filter criteria for the resource of the event

Show child attributes

filter.resource.id

string[] | null

Only include events for resources with these IDs

filter.resource.id_prefix

string[] | null

Only include events for resources with IDs starting with these prefixes.

filter.resource.labels

ResourceSpecification · object

Only include events for resources with these labels

Show child attributes

filter.resource.labels.{key}

filter.resource.distinct

boolean

default:false

Only include events for distinct resources

Filter criteria for the related resources of the event

EventRelatedFilter · object
EventRelatedFilter · object[]

Show child attributes

Only include events for related resources with these IDs

Only include events for related resources in these roles

Only include events with specific related resources in specific roles

Required array length: 2 elements

Only include events for related resources with these labels

Show child attributes

filter.any_resource

EventAnyResourceFilter · object

Filter criteria for any resource involved in the event

EventAnyResourceFilter · object
EventAnyResourceFilter · object[]

Show child attributes

filter.any_resource.id

string[] | null

Only include events for resources with these IDs

filter.any_resource.id_prefix

string[] | null

Only include events for resources with IDs starting with these prefixes

filter.any_resource.labels

ResourceSpecification · object

Only include events for related resources with these labels

Show child attributes

filter.any_resource.labels.{key}

filter.id

EventIDFilter · object

Filter criteria for the events' ID

Show child attributes

filter.id.id

string<uuid>[] | null

Only include events with one of these IDs

filter.text

EventTextFilter · object

Filter criteria for text search across event content

Show child attributes

filter.text.query

string

required

Text search query string

Maximum string length: 200

filter.order

enum<string>

default:DESC

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

Successful Response

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

events

ReceivedEvent · object[]

required

The Events matching the query

Show child attributes

events.occurred

string<date-time>

required

When the event happened from the sender's perspective

events.event

string

required

The name of the event that happened

events.resource

Resource · object

required

The primary Resource this event concerns

Show child attributes

events.resource.{key}

string

events.id

string<uuid>

required

The client-provided identifier of this event

A list of additional Resources involved in this event

Show child attributes

events.payload

Payload · object

An open-ended set of data describing what happened

events.follows

string<uuid> | null

The ID of an event that is known to have occurred prior to this one. If set, this may be used to establish a more precise ordering of causally-related events when they occur close enough together in time that the system may receive them out-of-order.

events.received

string<date-time>

When the event was received by Prefect Cloud

total

integer

required

The total number of matching Events

next_page

string<uri> | null

required

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

Minimum string length: 1

Create Events Read Account Events Page

⌘I

API Reference

Headers

Body

Response