Read Events - Prefect

API Reference

Overview
Python SDK Overview
Settings reference
REST API
- REST API overview
- Cloud API
- Server API
  - Server API Overview
  - Root
  - Flows
  - Flow Runs
  - Task Runs
  - Flow Run States
  - Task Run States
  - Flow Run Notification Policies
  - Deployments
  - SavedSearches
  - Logs
  - Concurrency Limits
  - Concurrency Limits V2
  - Block types
  - Block documents
  - Work Pools
  - Task Workers
  - Work Queues
  - Artifacts
  - Block schemas
  - Block capabilities
  - Collections
  - Variables
  - GET
    Create Csrf Token
  - Events
    - POST
      Create Events
    - POST
      Read Events
    - GET
      Read Account Events Page
    - POST
      Count Account Events
  - Automations
  - Admin
CLI Reference

POST

api

events

filter

{
  "events": [
    {
      "occurred": "2023-11-07T05:31:56Z",
      "event": "<string>",
      "resource": {},
      "related": [
        {}
      ],
      "payload": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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

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

Successful Response

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

The server-side view of an event that has happened to a Resource after it has been received by the server

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

Was this page helpful?

Create Events Read Account Events Page

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