Flow Runs
Read Flow Run History
POST
/
api
/
ui
/
flow_runs
/
history
Headers
x-prefect-api-version
string
Body
application/json
sort
enum<string>
Defines flow run sorting options.
Available options:
ID_DESC
, START_TIME_ASC
, START_TIME_DESC
, EXPECTED_START_TIME_ASC
, EXPECTED_START_TIME_DESC
, NAME_ASC
, NAME_DESC
, NEXT_SCHEDULED_START_TIME_ASC
, END_TIME_DESC
limit
integer
default: 1000offset
integer
default: 0flows
object
Filter for flows. Only flows matching all criteria will be returned.
flow_runs
object
Filter flow runs. Only flow runs matching all criteria will be returned
task_runs
object
Filter task runs. Only task runs matching all criteria will be returned
deployments
object
Filter for deployments. Only deployments matching all criteria will be returned.
work_pools
object
Filter work pools. Only work pools matching all criteria will be returned
Response
200 - application/json
id
string
requiredThe flow run id.
state_type
enum<string>
requiredThe state type.
Available options:
SCHEDULED
, PENDING
, RUNNING
, COMPLETED
, FAILED
, CANCELLED
, CRASHED
, PAUSED
, CANCELLING
timestamp
string
requiredThe start time of the run, or the expected start time if it hasn't run yet.
duration
number
requiredThe total run time of the run.
lateness
number
requiredThe delay between the expected and actual start time.
Was this page helpful?