Search logs in a log repository
curl --request POST \
--url https://api.getmaxim.ai/v1/log-repositories/logs/search \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"id": "<string>",
"timestamp": {
"gte": "<string>",
"lte": "<string>"
},
"sessionId": "<string>",
"searchQuery": "<string>",
"page": 0,
"limit": 10
}
'import requests
url = "https://api.getmaxim.ai/v1/log-repositories/logs/search"
payload = {
"workspaceId": "<string>",
"id": "<string>",
"timestamp": {
"gte": "<string>",
"lte": "<string>"
},
"sessionId": "<string>",
"searchQuery": "<string>",
"page": 0,
"limit": 10
}
headers = {
"x-maxim-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
id: '<string>',
timestamp: {gte: '<string>', lte: '<string>'},
sessionId: '<string>',
searchQuery: '<string>',
page: 0,
limit: 10
})
};
fetch('https://api.getmaxim.ai/v1/log-repositories/logs/search', 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.getmaxim.ai/v1/log-repositories/logs/search",
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([
'workspaceId' => '<string>',
'id' => '<string>',
'timestamp' => [
'gte' => '<string>',
'lte' => '<string>'
],
'sessionId' => '<string>',
'searchQuery' => '<string>',
'page' => 0,
'limit' => 10
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-maxim-api-key: <api-key>"
],
]);
$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.getmaxim.ai/v1/log-repositories/logs/search"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"sessionId\": \"<string>\",\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"limit\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-maxim-api-key", "<api-key>")
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.getmaxim.ai/v1/log-repositories/logs/search")
.header("x-maxim-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"sessionId\": \"<string>\",\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"limit\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmaxim.ai/v1/log-repositories/logs/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"sessionId\": \"<string>\",\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"limit\": 10\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uniqueTags": [
"<string>"
],
"logs": [
{
"id": "<string>",
"tags": {},
"timestamp": "<string>",
"startTimestamp": "<string>",
"name": "<string>",
"endTimestamp": "<string>",
"feedback": {
"score": 123,
"comment": "<string>"
}
}
]
},
"pagination": {
"total": 123,
"page": 123,
"limit": 123
}
}Log repository
Search logs in a log repository
Search logs in a log repository
POST
/
v1
/
log-repositories
/
logs
/
search
Search logs in a log repository
curl --request POST \
--url https://api.getmaxim.ai/v1/log-repositories/logs/search \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"id": "<string>",
"timestamp": {
"gte": "<string>",
"lte": "<string>"
},
"sessionId": "<string>",
"searchQuery": "<string>",
"page": 0,
"limit": 10
}
'import requests
url = "https://api.getmaxim.ai/v1/log-repositories/logs/search"
payload = {
"workspaceId": "<string>",
"id": "<string>",
"timestamp": {
"gte": "<string>",
"lte": "<string>"
},
"sessionId": "<string>",
"searchQuery": "<string>",
"page": 0,
"limit": 10
}
headers = {
"x-maxim-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
id: '<string>',
timestamp: {gte: '<string>', lte: '<string>'},
sessionId: '<string>',
searchQuery: '<string>',
page: 0,
limit: 10
})
};
fetch('https://api.getmaxim.ai/v1/log-repositories/logs/search', 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.getmaxim.ai/v1/log-repositories/logs/search",
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([
'workspaceId' => '<string>',
'id' => '<string>',
'timestamp' => [
'gte' => '<string>',
'lte' => '<string>'
],
'sessionId' => '<string>',
'searchQuery' => '<string>',
'page' => 0,
'limit' => 10
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-maxim-api-key: <api-key>"
],
]);
$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.getmaxim.ai/v1/log-repositories/logs/search"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"sessionId\": \"<string>\",\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"limit\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-maxim-api-key", "<api-key>")
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.getmaxim.ai/v1/log-repositories/logs/search")
.header("x-maxim-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"sessionId\": \"<string>\",\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"limit\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmaxim.ai/v1/log-repositories/logs/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"sessionId\": \"<string>\",\n \"searchQuery\": \"<string>\",\n \"page\": 0,\n \"limit\": 10\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uniqueTags": [
"<string>"
],
"logs": [
{
"id": "<string>",
"tags": {},
"timestamp": "<string>",
"startTimestamp": "<string>",
"name": "<string>",
"endTimestamp": "<string>",
"feedback": {
"score": 123,
"comment": "<string>"
}
}
]
},
"pagination": {
"total": 123,
"page": 123,
"limit": 123
}
}Authorizations
API key for authentication
Body
application/json
Unique identifier for the workspace
Log repository ID
Type of logs to retrieve (session or trace)
Available options:
session, trace Timestamp range for filtering logs eg: { gte: '2024-01-01T00:00:00Z', lte: '2024-01-31T23:59:59Z' }
Show child attributes
Show child attributes
Filter logs by session ID
Search query to filter logs
Trace properties to filter on
Show child attributes
Show child attributes
Evaluator metrics to be filtered on
Show child attributes
Show child attributes
Page number for pagination
Number of records per page (max: 100)
Required range:
x <= 50Sorting configuration for logs eg: { id: 'startTimestamp', desc: true }
Show child attributes
Show child attributes
Was this page helpful?
⌘I