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
}
'import requests
url = "https://api.example.com/logs/filter"
payload = {
"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
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.example.com/logs/filter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/logs/filter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/logs/filter"
payload := strings.NewReader("{\n \"offset\": 0,\n \"logs\": {\n \"operator\": \"and_\",\n \"level\": {\n \"ge_\": 20,\n \"le_\": 50\n },\n \"timestamp\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"flow_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"task_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"text\": {\n \"query\": \"<string>\"\n }\n },\n \"sort\": \"TIMESTAMP_ASC\",\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/logs/filter")
.header("Content-Type", "application/json")
.body("{\n \"offset\": 0,\n \"logs\": {\n \"operator\": \"and_\",\n \"level\": {\n \"ge_\": 20,\n \"le_\": 50\n },\n \"timestamp\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"flow_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"task_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"text\": {\n \"query\": \"<string>\"\n }\n },\n \"sort\": \"TIMESTAMP_ASC\",\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/logs/filter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"offset\": 0,\n \"logs\": {\n \"operator\": \"and_\",\n \"level\": {\n \"ge_\": 20,\n \"le_\": 50\n },\n \"timestamp\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"flow_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"task_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"text\": {\n \"query\": \"<string>\"\n }\n },\n \"sort\": \"TIMESTAMP_ASC\",\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body[
{
"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"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Logs
Read Logs
Query for logs.
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
}
'import requests
url = "https://api.example.com/logs/filter"
payload = {
"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
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.example.com/logs/filter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/logs/filter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/logs/filter"
payload := strings.NewReader("{\n \"offset\": 0,\n \"logs\": {\n \"operator\": \"and_\",\n \"level\": {\n \"ge_\": 20,\n \"le_\": 50\n },\n \"timestamp\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"flow_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"task_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"text\": {\n \"query\": \"<string>\"\n }\n },\n \"sort\": \"TIMESTAMP_ASC\",\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/logs/filter")
.header("Content-Type", "application/json")
.body("{\n \"offset\": 0,\n \"logs\": {\n \"operator\": \"and_\",\n \"level\": {\n \"ge_\": 20,\n \"le_\": 50\n },\n \"timestamp\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"flow_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"task_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"text\": {\n \"query\": \"<string>\"\n }\n },\n \"sort\": \"TIMESTAMP_ASC\",\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/logs/filter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"offset\": 0,\n \"logs\": {\n \"operator\": \"and_\",\n \"level\": {\n \"ge_\": 20,\n \"le_\": 50\n },\n \"timestamp\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"flow_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"task_run_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"text\": {\n \"query\": \"<string>\"\n }\n },\n \"sort\": \"TIMESTAMP_ASC\",\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body[
{
"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"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
Required range:
x >= 0Filter logs. Only logs matching all criteria will be returned
Show child attributes
Show child attributes
Defines log sorting options.
Available options:
TIMESTAMP_ASC, TIMESTAMP_DESC Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
Successful Response
The logger name.
The log level.
The log message.
The log timestamp.
The flow run ID associated with the log.
The task run ID associated with the log.
Was this page helpful?
⌘I