Join us at inaugural PyAI Conf in San Francisco on March 10th! Learn more
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
}
]
}
]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
}
]
}
]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
Filter flow runs. Only flow runs matching all criteria will be returned
Show child attributes
Filter task runs. Only task runs matching all criteria will be returned
Show child attributes
Filter for deployments. Only deployments matching all criteria will be returned.
Show child attributes
Filter work pools. Only work pools matching all criteria will be returned
Show child attributes
Filter work queues. Only work queues matching all criteria will be returned
Show child attributes
Was this page helpful?