API Reference
- Overview
- Settings reference
- REST API overview
- Server API Overview
- 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
- POST
- GETCreate Csrf Token
curl --request POST \
--url https://api.example.com/api/flow_runs/history \
--header 'Content-Type: application/json' \
--data '
{
"history_start": "2023-11-07T05:31:56Z",
"history_end": "2023-11-07T05:31:56Z",
"history_interval_seconds": 123,
"flows": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"deployment": {
"operator": "and_",
"is_null_": true
},
"name": {
"any_": [
"my-flow-1",
"my-flow-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
}
},
"flow_runs": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"not_any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-flow-run-1",
"my-flow-run-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"any_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"deployment_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": true
},
"work_queue_name": {
"operator": "and_",
"any_": [
"work_queue_1",
"work_queue_2"
],
"is_null_": true
},
"state": {
"operator": "and_",
"type": {
"any_": [
"SCHEDULED"
],
"not_any_": [
"SCHEDULED"
]
},
"name": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"flow_version": {
"any_": [
"<string>"
]
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"end_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"next_scheduled_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"parent_flow_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"parent_task_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": true
},
"idempotency_key": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"task_runs": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-task-run-1",
"my-task-run-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"state": {
"operator": "and_",
"type": {
"any_": [
"SCHEDULED"
]
},
"name": {
"any_": [
"<string>"
]
}
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"subflow_runs": {
"exists_": true
},
"flow_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": false
}
},
"deployments": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"not_any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-deployment-1",
"my-deployment-2"
],
"like_": "marvin"
},
"flow_or_deployment_name": {
"like_": "<string>"
},
"paused": {
"eq_": true
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"any_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"work_queue_name": {
"any_": [
"work_queue_1",
"work_queue_2"
]
},
"concurrency_limit": {
"ge_": 123,
"le_": 123,
"is_null_": true
}
},
"work_pools": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"<string>"
]
},
"type": {
"any_": [
"<string>"
]
}
},
"work_queues": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"wq-1",
"wq-2"
],
"startswith_": [
"marvin",
"Marvin-robot"
]
}
}
}
'[
{
"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
}
]
}
]Flow Run History
Query for flow run history data across a given range and interval.
curl --request POST \
--url https://api.example.com/api/flow_runs/history \
--header 'Content-Type: application/json' \
--data '
{
"history_start": "2023-11-07T05:31:56Z",
"history_end": "2023-11-07T05:31:56Z",
"history_interval_seconds": 123,
"flows": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"deployment": {
"operator": "and_",
"is_null_": true
},
"name": {
"any_": [
"my-flow-1",
"my-flow-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
}
},
"flow_runs": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"not_any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-flow-run-1",
"my-flow-run-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"any_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"deployment_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": true
},
"work_queue_name": {
"operator": "and_",
"any_": [
"work_queue_1",
"work_queue_2"
],
"is_null_": true
},
"state": {
"operator": "and_",
"type": {
"any_": [
"SCHEDULED"
],
"not_any_": [
"SCHEDULED"
]
},
"name": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"flow_version": {
"any_": [
"<string>"
]
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"end_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"next_scheduled_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"parent_flow_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"parent_task_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": true
},
"idempotency_key": {
"any_": [
"<string>"
],
"not_any_": [
"<string>"
]
}
},
"task_runs": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-task-run-1",
"my-task-run-2"
],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"state": {
"operator": "and_",
"type": {
"any_": [
"SCHEDULED"
]
},
"name": {
"any_": [
"<string>"
]
}
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": true
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"subflow_runs": {
"exists_": true
},
"flow_run_id": {
"operator": "and_",
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_null_": false
}
},
"deployments": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"not_any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"my-deployment-1",
"my-deployment-2"
],
"like_": "marvin"
},
"flow_or_deployment_name": {
"like_": "<string>"
},
"paused": {
"eq_": true
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"any_": [
"tag-1",
"tag-2"
],
"is_null_": true
},
"work_queue_name": {
"any_": [
"work_queue_1",
"work_queue_2"
]
},
"concurrency_limit": {
"ge_": 123,
"le_": 123,
"is_null_": true
}
},
"work_pools": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"<string>"
]
},
"type": {
"any_": [
"<string>"
]
}
},
"work_queues": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"wq-1",
"wq-2"
],
"startswith_": [
"marvin",
"Marvin-robot"
]
}
}
}
'[
{
"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.
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Flow.name
Filter criteria for Flow.tags
Show child attributes
Show child attributes
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
["tag-1", "tag-2"]If true, only include flows without tags
Filter flow runs. Only flow runs matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for FlowRun.name
Show child attributes
Show child attributes
Filter criteria for FlowRun.tags
Show child attributes
Show child attributes
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
["tag-1", "tag-2"]A list of tags to include
["tag-1", "tag-2"]If true, only include flow runs without tags
Filter criteria for FlowRun.deployment_id
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of work queue names to include
["work_queue_1", "work_queue_2"]If true, only include flow runs without work queue names
Filter criteria for FlowRun.state
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for FlowRun.state_type
Show child attributes
Show child attributes
A list of flow run state types to include
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING A list of flow run state types to exclude
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Filter criteria for FlowRun.start_time
Show child attributes
Show child attributes
Only include flow runs starting at or before this time
Only include flow runs starting at or after this time
If true, only return flow runs without a start time
Filter criteria for FlowRun.end_time
Show child attributes
Show child attributes
Filter criteria for FlowRun.expected_start_time
Filter criteria for FlowRun.next_scheduled_start_time
Show child attributes
Show child attributes
Filter criteria for subflows of the given flow runs
Filter criteria for FlowRun.parent_task_run_id
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for TaskRun.name
Show child attributes
Show child attributes
Filter criteria for TaskRun.tags
Show child attributes
Show child attributes
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
["tag-1", "tag-2"]If true, only include task runs without tags
Filter criteria for TaskRun.state
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for TaskRun.state_type
Show child attributes
Show child attributes
A list of task run state types to include
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Filter criteria for TaskRun.start_time
Show child attributes
Show child attributes
Only include task runs starting at or before this time
Only include task runs starting at or after this time
If true, only return task runs without a start time
Filter criteria for TaskRun.expected_start_time
Filter criteria for TaskRun.flow_run_id
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Deployment.name
Show child attributes
Show child attributes
Filter criteria for Deployment.name or Flow.name
Show child attributes
Show child attributes
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.tags
Show child attributes
Show child attributes
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
["tag-1", "tag-2"]A list of tags to include
["tag-1", "tag-2"]If true, only include deployments without tags
DEPRECATED: Prefer Deployment.concurrency_limit_id over Deployment.concurrency_limit. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter work queues. Only work queues matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for WorkQueue.name
Show child attributes
Show child attributes
A list of work queue names to include
["wq-1", "wq-2"]A list of case-insensitive starts-with matches. For example, passing 'marvin' will match 'marvin', and 'Marvin-robot', but not 'sad-marvin'.
["marvin", "Marvin-robot"]Response
Successful Response
The start date of the interval.
The end date of the interval.
A list of state histories during the interval.
Show child attributes
Show child attributes
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?