POST
/
api
/
task_runs
/
history
[
  {
    "interval_start": "2023-11-07T05:31:56Z",
    "interval_end": "2023-11-07T05:31:56Z",
    "states": [
      {
        "state_type": "SCHEDULED",
        "state_name": "<string>",
        "count_runs": 123,
        "sum_estimated_run_time": 123,
        "sum_estimated_lateness": 123
      }
    ]
  }
]

Headers

​
x-prefect-api-version
string

Body

application/json
​
history_start
string<date-time>
required

The history's start time.

​
history_end
string<date-time>
required

The history's end time.

​
history_interval
number
required

The size of each history interval, in seconds. Must be at least 1 second.

​
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.

Response

Successful Response

​
interval_start
string<date-time>
required

The start date of the interval.

​
interval_end
string<date-time>
required

The end date of the interval.

​
states
HistoryResponseState · object[]
required

A list of state histories during the interval.