POST
/
api
/
ui
/
flow_runs
/
history
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "state_type": "SCHEDULED",
    "timestamp": "2023-11-07T05:31:56Z",
    "duration": 123,
    "lateness": 123
  }
]

Headers

​
x-prefect-api-version
string

Body

application/json
​
sort
enum<string>
default:EXPECTED_START_TIME_DESC

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:1000
Required range: x <= 1000
​
offset
integer
default:0
Required range: x >= 0
​
flows
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

Successful Response

​
id
string<uuid>
required

The flow run id.

​
state_type
enum<string>
required

The state type. Enumeration of state types.

Available options:
SCHEDULED,
PENDING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
CRASHED,
PAUSED,
CANCELLING
​
timestamp
string<date-time>
required

The start time of the run, or the expected start time if it hasn't run yet.

​
duration
number
required

The total run time of the run.

​
lateness
number
required

The delay between the expected and actual start time.