Read Task Runs
Query for task runs.
Headers
Body
Defines task run sorting options.
ID_DESC
, EXPECTED_START_TIME_ASC
, EXPECTED_START_TIME_DESC
, NAME_ASC
, NAME_DESC
, NEXT_SCHEDULED_START_TIME_ASC
, END_TIME_DESC
x > 0
Filter for flows. Only flows matching all criteria will be returned.
Filter flow runs. Only flow runs matching all criteria will be returned
Filter task runs. Only task runs matching all criteria will be returned
Filter for deployments. Only deployments matching all criteria will be returned.
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
The flow run id of the task run.
A unique identifier for the task being run.
A dynamic key used to differentiate between multiple runs of the same task within the same flow run.
An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run.
Specifies when the cached state should expire.
The version of the task being run.
Defines of how a task run should retry.
A list of tags for the task run.
A dictionary of key-value labels. Values can be strings, numbers, or booleans.
The id of the current task run state.
Tracks the source of inputs to a task run. Used for internal bookkeeping.
The type of the current task run state.
SCHEDULED
, PENDING
, RUNNING
, COMPLETED
, FAILED
, CANCELLED
, CRASHED
, PAUSED
, CANCELLING
The name of the current task run state.
The number of times the task run has been executed.
If the parent flow has retried, this indicates the flow retry this run is associated with.
The task run's expected start time.
The next time the task run is scheduled to start.
The actual start time.
The actual end time.
Total run time. If the task run was executed multiple times, the time of each run will be summed.
A real-time estimate of total run time.
The difference between actual and expected start time.
The current task run state.
Was this page helpful?