Skip to main content
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

​
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

​
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 length: 1