Read Logs

Query for logs.

Headers

x-prefect-api-version

string

Body

application/json

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

logs

object

Filter logs. Only logs matching all criteria will be returned

Show child attributes

logs.flow_run_id

object | null

Filter criteria for Log.flow_run_id

Show child attributes

logs.flow_run_id.any_

string[] | null

A list of flow run IDs to include

logs.level

object | null

Filter criteria for Log.level

Show child attributes

logs.level.ge_

integer | null

Include logs with a level greater than or equal to this level

logs.level.le_

integer | null

Include logs with a level less than or equal to this level

logs.operator

enum<string>

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

Available options:

and_,

or_

logs.task_run_id

object | null

Filter criteria for Log.task_run_id

Show child attributes

logs.task_run_id.any_

string[] | null

A list of task run IDs to include

logs.task_run_id.is_null_

boolean | null

If true, only include logs without a task run id

logs.timestamp

object | null

Filter criteria for Log.timestamp

Show child attributes

logs.timestamp.after_

string | null

Only include logs with a timestamp at or after this time

logs.timestamp.before_

string | null

Only include logs with a timestamp at or before this time

offset

integer

default:

0

Required range: x > 0

sort

enum<string>

Defines log sorting options.

Available options:

TIMESTAMP_ASC,

TIMESTAMP_DESC

Response

200 - application/json

created

string | null

required

id

string

required

level

integer

required

The log level.

message

string

required

The log message.

name

string

required

The logger name.

timestamp

string

required

The log timestamp.

updated

string | null

required

flow_run_id

string | null

The flow run ID associated with the log.

task_run_id

string | null

The task run ID associated with the log.