read_events
Retrieve and filter workflow events from Prefect using type prefixes or time ranges.
Instructions
Read and filter events from the Prefect instance.
Provides a structured view of events with filtering capabilities.
Note: When no time range is specified, events from the last 1 hour are returned by default. Use occurred_after/occurred_before parameters to query a different time range.
Common event type prefixes:
prefect.flow-run: Flow run lifecycle events
prefect.deployment: Deployment-related events
prefect.work-queue: Work queue events
prefect.agent: Agent events
Examples: - Recent flow run events: read_events(event_type_prefix="prefect.flow-run") - Last 24 hours: read_events(occurred_after="") - Specific time range: read_events(occurred_after="2024-01-01T00:00:00Z", occurred_before="2024-01-02T00:00:00Z")
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of events to return | |
| workspace_id | No | ||
| occurred_after | No | ISO 8601 timestamp to filter events after | |
| occurred_before | No | ISO 8601 timestamp to filter events before | |
| event_type_prefix | No | Filter events by type prefix |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | ||
| error | Yes | ||
| total | Yes | ||
| events | Yes | ||
| success | Yes |