Count Flows
Count flows.
Headers
Body
Filter for deployments. Only deployments matching all criteria will be returned.
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
If true, only include deployments without a concurrency limit
Only include deployments with a concurrency limit less than or equal to this value
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.id
A list of deployment ids to include
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter criteria for Deployment.paused
Only returns where deployment is/is not paused
Filter criteria for Deployment.tags
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
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter flow runs. Only flow runs matching all criteria will be returned
Filter criteria for FlowRun.deployment_id
A list of flow run deployment ids to include
If true, only include flow runs without deployment ids
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter criteria for FlowRun.end_time
Filter criteria for FlowRun.flow_version
A list of flow run flow_versions to include
Filter criteria for FlowRun.next_scheduled_start_time
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter criteria for FlowRun.parent_task_run_id
A list of flow run parent_task_run_ids to include
If true, only include flow runs without parent_task_run_id
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter criteria for FlowRun.start_time
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.tags
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
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter criteria for `FlowRun.work_queue_name
A list of work queue names to include
If true, only include flow runs without work queue names
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter for flows. Only flows matching all criteria will be returned.
Filter criteria for Flow.id
A list of flow ids to include
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter criteria for Flow.tags
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
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter task runs. Only task runs matching all criteria will be returned
Filter criteria for TaskRun.flow_run_id
A list of task run flow run ids to include
Filter for task runs with None as their flow run id
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter criteria for TaskRun.id
A list of task run ids to include
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter criteria for TaskRun.start_time
Filter criteria for TaskRun.state
Filter criteria for TaskRun.state_name
A list of task run state names to include
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
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.tags
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
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Filter work pools. Only work pools matching all criteria will be returned
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
Operator for combining filter criteria. Defaults to 'and_'.
and_
, or_
Response
The response is of type integer
.
Was this page helpful?