APIs & SDK
- Overview
- Python SDK Overview
- REST API
- REST API overview
- Cloud API
- Server API
- Server API Overview
- Root
- Flows
- Flow Runs
- POSTCreate Flow Run
- GETRead Flow Run
- DELDelete Flow Run
- PATCHUpdate Flow Run
- POSTCount Flow Runs
- POSTAverage Flow Run Lateness
- POSTFlow Run History
- GETRead Flow Run Graph V1
- GETRead Flow Run Graph V2
- POSTResume Flow Run
- POSTRead Flow Runs
- POSTSet Flow Run State
- POSTCreate Flow Run Input
- POSTFilter Flow Run Input
- GETRead Flow Run Input
- DELDelete Flow Run Input
- POSTRead Flow Runs
- GETDownload Logs
- PATCHUpdate Flow Run Labels
- POSTRead Flow Run History
- POSTCount Task Runs By Flow Run
- POST
- Task Runs
- Flow Run States
- Task Run States
- Flow Run Notification Policies
- Deployments
- SavedSearches
- Logs
- Concurrency Limits
- Concurrency Limits V2
- Block types
- Block documents
- Work Pools
- Task Workers
- Work Queues
- Artifacts
- Block schemas
- Block capabilities
- Collections
- Variables
- GETCreate Csrf Token
- Events
- Automations
- UI
- Admin
- CLI Reference
Flow Run History
Query for flow run history data across a given range and interval.
[
{
"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
Body
The history's start time.
The history's end time.
The size of each history interval, in seconds. Must be at least 1 second.
Filter for flows. Only flows matching all criteria will be returned.
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Flow.id
A list of flow ids to include
Filter criteria for Flow.tags
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Flows will be returned only if their tags are a superset of the list
If true, only include flows without tags
Filter flow runs. Only flow runs matching all criteria will be returned
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for FlowRun.tags
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Flow runs will be returned only if their tags are a superset of the list
A list of tags to include
If true, only include flow runs without tags
Filter criteria for FlowRun.deployment_id
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of flow run deployment ids to include
If true, only include flow runs without deployment ids
Filter criteria for `FlowRun.work_queue_name
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of work queue names to include
If true, only include flow runs without work queue names
Filter criteria for FlowRun.state
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for FlowRun.state_type
A list of flow run state types to include
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING A list of flow run state types to exclude
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Filter criteria for FlowRun.flow_version
A list of flow run flow_versions to include
Filter criteria for FlowRun.start_time
Filter criteria for FlowRun.end_time
Filter criteria for FlowRun.next_scheduled_start_time
Filter criteria for FlowRun.parent_task_run_id
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of flow run parent_task_run_ids to include
If true, only include flow runs without parent_task_run_id
Filter task runs. Only task runs matching all criteria will be returned
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for TaskRun.id
A list of task run ids to include
Filter criteria for TaskRun.tags
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Task runs will be returned only if their tags are a superset of the list
If true, only include task runs without tags
Filter criteria for TaskRun.state
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for TaskRun.state_type
A list of task run state types to include
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Filter criteria for TaskRun.start_time
Filter criteria for TaskRun.subflow_run
If true, only include task runs that are subflow run parents; if false, exclude parent task runs
Filter criteria for TaskRun.flow_run_id
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of task run flow run ids to include
Filter for task runs with None as their flow run id
Filter for deployments. Only deployments matching all criteria will be returned.
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Deployment.id
A list of deployment ids to include
Filter criteria for Deployment.name or Flow.name
A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names.
Filter criteria for Deployment.paused
Only returns where deployment is/is not paused
Filter criteria for Deployment.tags
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Deployments will be returned only if their tags are a superset of the list
A list of tags to include
If true, only include deployments without tags
Filter criteria for Deployment.work_queue_name
A list of work queue names to include
DEPRECATED: Prefer Deployment.concurrency_limit_id over Deployment.concurrency_limit. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.
Only include deployments with a concurrency limit greater than or equal to this value
Only include deployments with a concurrency limit less than or equal to this value
If true, only include deployments without a concurrency limit
Filter work pools. Only work pools matching all criteria will be returned
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for WorkPool.id
A list of work pool ids to include
Filter criteria for WorkPool.name
A list of work pool names to include
Filter work queues. Only work queues matching all criteria will be returned
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for WorkQueue.id
A list of work queue ids to include
Response
The start date of the interval.
The end date of the interval.
A list of state histories during the interval.
The state type.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING The state name.
The number of runs in the specified state during the interval.
The total estimated run time of all runs during the interval.
The sum of differences between actual and expected start time during the interval.
Was this page helpful?
[
{
"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
}
]
}
]