Read Task Runs

Query for task runs.

Headers

x-prefect-api-version

string

Body

application/json

deployments

object | null

Filter for deployments. Only deployments matching all criteria will be returned.

Show child attributes

deployments.concurrency_limit

object | null

deprecated

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

deployments.concurrency_limit.ge_

integer | null

Only include deployments with a concurrency limit greater than or equal to this value

deployments.concurrency_limit.is_null_

boolean | null

If true, only include deployments without a concurrency limit

deployments.concurrency_limit.le_

integer | null

Only include deployments with a concurrency limit less than or equal to this value

deployments.flow_or_deployment_name

object | null

Filter criteria for Deployment.name or Flow.name

Show child attributes

deployments.flow_or_deployment_name.like_

string | null

A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names.

deployments.id

object | null

Filter criteria for Deployment.id

Show child attributes

deployments.id.any_

string[] | null

A list of deployment ids to include

deployments.name

object | null

Filter criteria for Deployment.name

Show child attributes

deployments.name.any_

string[] | null

A list of deployment names to include

deployments.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

deployments.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

deployments.paused

object | null

Filter criteria for Deployment.paused

Show child attributes

deployments.paused.eq_

boolean | null

Only returns where deployment is/is not paused

deployments.tags

object | null

Filter criteria for Deployment.tags

Show child attributes

deployments.tags.all_

string[] | null

A list of tags. Deployments will be returned only if their tags are a superset of the list

deployments.tags.any_

string[] | null

A list of tags to include

deployments.tags.is_null_

boolean | null

If true, only include deployments without tags

deployments.tags.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

deployments.work_queue_name

object | null

Filter criteria for Deployment.work_queue_name

Show child attributes

deployments.work_queue_name.any_

string[] | null

A list of work queue names to include

flow_runs

object | null

Filter flow runs. Only flow runs matching all criteria will be returned

Show child attributes

flow_runs.deployment_id

object | null

Filter criteria for FlowRun.deployment_id

Show child attributes

flow_runs.deployment_id.any_

string[] | null

A list of flow run deployment ids to include

flow_runs.deployment_id.is_null_

boolean | null

If true, only include flow runs without deployment ids

flow_runs.deployment_id.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.end_time

object | null

Filter criteria for FlowRun.end_time

Show child attributes

flow_runs.end_time.after_

string | null

Only include flow runs ending at or after this time

flow_runs.end_time.before_

string | null

Only include flow runs ending at or before this time

flow_runs.end_time.is_null_

boolean | null

If true, only return flow runs without an end time

flow_runs.expected_start_time

object | null

Filter criteria for FlowRun.expected_start_time

Show child attributes

flow_runs.expected_start_time.after_

string | null

Only include flow runs scheduled to start at or after this time

flow_runs.expected_start_time.before_

string | null

Only include flow runs scheduled to start at or before this time

flow_runs.flow_version

object | null

Filter criteria for FlowRun.flow_version

Show child attributes

flow_runs.flow_version.any_

string[] | null

A list of flow run flow_versions to include

flow_runs.id

object | null

Filter criteria for FlowRun.id

Show child attributes

flow_runs.id.any_

string[] | null

A list of flow run ids to include

flow_runs.id.not_any_

string[] | null

A list of flow run ids to exclude

flow_runs.idempotency_key

object | null

Filter criteria for FlowRun.idempotency_key

Show child attributes

flow_runs.idempotency_key.any_

string[] | null

A list of flow run idempotency keys to include

flow_runs.idempotency_key.not_any_

string[] | null

A list of flow run idempotency keys to exclude

flow_runs.name

object | null

Filter criteria for FlowRun.name

Show child attributes

flow_runs.name.any_

string[] | null

A list of flow run names to include

flow_runs.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

flow_runs.next_scheduled_start_time

object | null

Filter criteria for FlowRun.next_scheduled_start_time

Show child attributes

flow_runs.next_scheduled_start_time.after_

string | null

Only include flow runs with a next_scheduled_start_time at or after this time

flow_runs.next_scheduled_start_time.before_

string | null

Only include flow runs with a next_scheduled_start_time or before this time

flow_runs.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.parent_flow_run_id

object | null

Filter criteria for subflows of the given flow runs

Show child attributes

flow_runs.parent_flow_run_id.any_

string[] | null

A list of parent flow run ids to include

flow_runs.parent_flow_run_id.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.parent_task_run_id

object | null

Filter criteria for FlowRun.parent_task_run_id

Show child attributes

flow_runs.parent_task_run_id.any_

string[] | null

A list of flow run parent_task_run_ids to include

flow_runs.parent_task_run_id.is_null_

boolean | null

If true, only include flow runs without parent_task_run_id

flow_runs.parent_task_run_id.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.start_time

object | null

Filter criteria for FlowRun.start_time

Show child attributes

flow_runs.start_time.after_

string | null

Only include flow runs starting at or after this time

flow_runs.start_time.before_

string | null

Only include flow runs starting at or before this time

flow_runs.start_time.is_null_

boolean | null

If true, only return flow runs without a start time

flow_runs.state

object | null

Filter criteria for FlowRun.state

Show child attributes

flow_runs.state.name

object | null

Filter criteria for FlowRun.state_name

Show child attributes

flow_runs.state.name.any_

string[] | null

A list of flow run state names to include

flow_runs.state.name.not_any_

string[] | null

A list of flow run state names to exclude

flow_runs.state.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.state.type

object | null

Filter criteria for FlowRun.state_type

Show child attributes

flow_runs.state.type.any_

enum<string>[] | null

A list of flow run state types to include

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

flow_runs.state.type.not_any_

enum<string>[] | null

A list of flow run state types to exclude

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

flow_runs.tags

object | null

Filter criteria for FlowRun.tags

Show child attributes

flow_runs.tags.all_

string[] | null

A list of tags. Flow runs will be returned only if their tags are a superset of the list

flow_runs.tags.any_

string[] | null

A list of tags to include

flow_runs.tags.is_null_

boolean | null

If true, only include flow runs without tags

flow_runs.tags.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.work_queue_name

object | null

Filter criteria for `FlowRun.work_queue_name

Show child attributes

flow_runs.work_queue_name.any_

string[] | null

A list of work queue names to include

flow_runs.work_queue_name.is_null_

boolean | null

If true, only include flow runs without work queue names

flow_runs.work_queue_name.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows

object | null

Filter for flows. Only flows matching all criteria will be returned.

Show child attributes

flows.deployment

object | null

Filter criteria for Flow deployments

Show child attributes

flows.deployment.is_null_

boolean | null

If true, only include flows without deployments

flows.deployment.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows.id

object | null

Filter criteria for Flow.id

Show child attributes

flows.id.any_

string[] | null

A list of flow ids to include

flows.name

object | null

Filter criteria for Flow.name

Show child attributes

flows.name.any_

string[] | null

A list of flow names to include

flows.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

flows.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows.tags

object | null

Filter criteria for Flow.tags

Show child attributes

flows.tags.all_

string[] | null

A list of tags. Flows will be returned only if their tags are a superset of the list

flows.tags.is_null_

boolean | null

If true, only include flows without tags

flows.tags.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

offset

integer

default:

0

Required range: x > 0

sort

enum<string>

Defines task run sorting options.

Available options:

ID_DESC,

EXPECTED_START_TIME_ASC,

EXPECTED_START_TIME_DESC,

NAME_ASC,

NAME_DESC,

NEXT_SCHEDULED_START_TIME_ASC,

END_TIME_DESC

task_runs

object | null

Filter task runs. Only task runs matching all criteria will be returned

Show child attributes

task_runs.expected_start_time

object | null

Filter criteria for TaskRun.expected_start_time

Show child attributes

task_runs.expected_start_time.after_

string | null

Only include task runs expected to start at or after this time

task_runs.expected_start_time.before_

string | null

Only include task runs expected to start at or before this time

task_runs.flow_run_id

object | null

Filter criteria for TaskRun.flow_run_id

Show child attributes

task_runs.flow_run_id.any_

string[] | null

A list of task run flow run ids to include

task_runs.flow_run_id.is_null_

boolean | null

default:

false

Filter for task runs with None as their flow run id

task_runs.flow_run_id.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.id

object | null

Filter criteria for TaskRun.id

Show child attributes

task_runs.id.any_

string[] | null

A list of task run ids to include

task_runs.name

object | null

Filter criteria for TaskRun.name

Show child attributes

task_runs.name.any_

string[] | null

A list of task run names to include

task_runs.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

task_runs.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.start_time

object | null

Filter criteria for TaskRun.start_time

Show child attributes

task_runs.start_time.after_

string | null

Only include task runs starting at or after this time

task_runs.start_time.before_

string | null

Only include task runs starting at or before this time

task_runs.start_time.is_null_

boolean | null

If true, only return task runs without a start time

task_runs.state

object | null

Filter criteria for TaskRun.state

Show child attributes

task_runs.state.name

object | null

Filter criteria for TaskRun.state_name

Show child attributes

task_runs.state.name.any_

string[] | null

A list of task run state names to include

task_runs.state.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.state.type

object | null

Filter criteria for TaskRun.state_type

Show child attributes

task_runs.state.type.any_

enum<string>[] | null

A list of task run state types to include

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

task_runs.subflow_runs

object | null

Filter criteria for TaskRun.subflow_run

Show child attributes

task_runs.subflow_runs.exists_

boolean | null

If true, only include task runs that are subflow run parents; if false, exclude parent task runs

task_runs.tags

object | null

Filter criteria for TaskRun.tags

Show child attributes

task_runs.tags.all_

string[] | null

A list of tags. Task runs will be returned only if their tags are a superset of the list

task_runs.tags.is_null_

boolean | null

If true, only include task runs without tags

task_runs.tags.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

Response

200 - application/json

created

string | null

required

dynamic_key

string

required

A dynamic key used to differentiate between multiple runs of the same task within the same flow run.

id

string

required

task_key

string

required

A unique identifier for the task being run.

updated

string | null

required

cache_expiration

string | null

Specifies when the cached state should expire.

cache_key

string | null

An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run.

empirical_policy

object

Defines of how a task run should retry.

Show child attributes

empirical_policy.max_retries

integer

default:

0

deprecated

The maximum number of retries. Field is not used. Please use retries instead.

empirical_policy.retries

integer | null

The number of retries.

empirical_policy.retry_delay

A delay time or list of delay times between retries, in seconds.

empirical_policy.retry_delay_seconds

number

default:

0

deprecated

The delay between retries. Field is not used. Please use retry_delay instead.

empirical_policy.retry_jitter_factor

number | null

Determines the amount a retry should jitter

end_time

string | null

The actual end time.

estimated_run_time

number

default:

0

A real-time estimate of total run time.

estimated_start_time_delta

number

default:

0

The difference between actual and expected start time.

expected_start_time

string | null

The task run's expected start time.

flow_run_id

string | null

The flow run id of the task run.

flow_run_run_count

integer

default:

0

If the parent flow has retried, this indicates the flow retry this run is associated with.

labels

object | null

A dictionary of key-value labels. Values can be strings, numbers, or booleans.

Show child attributes

labels.{key}

name

string

next_scheduled_start_time

string | null

The next time the task run is scheduled to start.

run_count

integer

default:

0

The number of times the task run has been executed.

start_time

string | null

The actual start time.

state

object | null

The current task run state.

Show child attributes

state.id

string

required

state.type

enum<string>

required

Enumeration of state types.

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

state.data

any | null

Data associated with the state, e.g. a result. Content must be storable as JSON.

state.message

string | null

state.name

string | null

state.state_details

object

Show child attributes

state.state_details.cache_expiration

string | null

state.state_details.cache_key

string | null

state.state_details.child_flow_run_id

string | null

state.state_details.deferred

boolean | null

default:

false

state.state_details.flow_run_id

string | null

state.state_details.pause_key

string | null

state.state_details.pause_reschedule

boolean

default:

false

state.state_details.pause_timeout

string | null

state.state_details.refresh_cache

boolean | null

state.state_details.retriable

boolean | null

state.state_details.run_input_keyset

object | null

Show child attributes

state.state_details.run_input_keyset.{key}

string

state.state_details.scheduled_time

string | null

state.state_details.task_parameters_id

string | null

state.state_details.task_run_id

string | null

state.state_details.traceparent

string | null

state.state_details.transition_id

string | null

state.state_details.untrackable_result

boolean

default:

false

state.timestamp

string

state_id

string | null

The id of the current task run state.

state_name

string | null

The name of the current task run state.

state_type

enum<string> | null

The type of the current task run state.

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

tags

string[]

A list of tags for the task run.

task_inputs

object

Tracks the source of inputs to a task run. Used for internal bookkeeping.

Show child attributes

task_inputs.{key}

object[]

• TaskRunResult
• Parameter
• Constant

Show child attributes

task_inputs.{key}.id

string

required

task_inputs.{key}.input_type

string

default:

task_run

Allowed value: "task_run"

task_version

string | null

The version of the task being run.

total_run_time

number

default:

0

Total run time. If the task run was executed multiple times, the time of each run will be summed.