Skip to main content
POST
/
logs
/
filter
Read Logs
curl --request POST \
  --url https://api.example.com/logs/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "offset": 0,
  "logs": {
    "operator": "and_",
    "level": {
      "ge_": 20,
      "le_": 50
    },
    "timestamp": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "flow_run_id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "task_run_id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "text": {
      "query": "<string>"
    }
  },
  "sort": "TIMESTAMP_ASC",
  "limit": 123
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "level": 123,
    "message": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-prefect-api-version
string

Body

application/json
​
offset
integer
default:0
Required range: x >= 0
​
logs
LogFilter · object

Filter logs. Only logs matching all criteria will be returned

​
sort
enum<string>
default:TIMESTAMP_ASC

Defines log sorting options.

Available options:
TIMESTAMP_ASC,
TIMESTAMP_DESC
​
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

​
id
string<uuid>
required
​
created
string<date-time> | null
required
​
updated
string<date-time> | null
required
​
name
string
required

The logger name.

​
level
integer
required

The log level.

​
message
string
required

The log message.

​
timestamp
string<date-time>
required

The log timestamp.

​
flow_run_id
string<uuid> | null

The flow run ID associated with the log.

​
task_run_id
string<uuid> | null

The task run ID associated with the log.