Events
Read Events
Queries for Events matching the given filter criteria in the given Account. Returns the first page of results, and the URL to request the next page (if there are more results).
POST
/
api
/
events
/
filter
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: 50The 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[]
requiredThe Events matching the query
total
integer
requiredThe total number of matching Events
next_page
string | null
requiredThe URL for the next page of results, if there are more
Minimum length:
1
Was this page helpful?