Search logs in a log repository

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Query Parameters

workspaceIdRequiredstring

Unique identifier for the workspace

idRequiredstring

Log repository ID

typeRequiredstring

Type of logs to retrieve (session or trace)

Value in: "session" | "trace"

timestampobject

Timestamp range for filtering logs eg: { gte: '2024-01-01T00:00:00Z', lte: '2024-01-31T23:59:59Z' }

sessionIdstring

Filter logs by session ID

searchQuerystring

Search query to filter logs

traceFiltersobject

Trace properties to filter on

evaluatorFiltersobject

Evaluator metrics to be filtered on

pagenumber

Page number for pagination

Default: 0

limitnumber

Number of records per page (max: 100)

Default: 10Maximum: 50

sortingobject

Sorting configuration for logs eg: { id: 'startTimestamp', desc: true }

curl -X POST "https://api.getmaxim.ai/v1/log-repositories/logs/search?workspaceId=%3Cstring%3E&id=%3Cstring%3E&type=session&timestamp=%5Bobject+Object%5D&sessionId=%3Cstring%3E&searchQuery=%3Cstring%3E&traceFilters=%5Bobject+Object%5D&evaluatorFilters=%5Bobject+Object%5D&page=0&limit=10&sorting=%5Bobject+Object%5D" \
  -H "x-maxim-api-key: <token>"

Logs retrieved successfully

{
  "data": {
    "uniqueTags": [
      "string"
    ],
    "logs": [
      {
        "id": "string",
        "tags": {
          "property1": "string",
          "property2": "string"
        },
        "timestamp": "string",
        "startTimestamp": "string",
        "endTimestamp": "string",
        "name": "string",
        "feedback": {
          "score": 0,
          "comment": "string"
        }
      }
    ]
  },
  "pagination": {
    "total": 0,
    "page": 0,
    "limit": 0
  }
}

Search logs in a log repository

Authorization

Query Parameters

Response

TypeScript