GET
/
logs
Search logs
curl --request GET \
  --url https://localhost:5000/logs \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Logs retrieved successfully",
  "data": [
    {
      "_id": "<string>",
      "scenarioId": "<string>",
      "stepId": "<string>",
      "traceId": "<string>",
      "simTimestamp": 123,
      "level": "INFO",
      "action": {
        "type": "<string>",
        "description": "<string>"
      },
      "actor": {
        "type": "<string>",
        "id": "<string>"
      },
      "payload": {},
      "stateDiff": {
        "before": {},
        "after": {},
        "changes": [
          "<string>"
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

traceId
string

Trace ID for fuzzy matching

scenarioId
string

Scenario ID for fuzzy matching

level
enum<string>

Log level filter

Available options:
INFO,
WARN,
ERROR,
DEBUG
actorId
string

Actor ID for exact matching

actionType
string

Action type for fuzzy matching

startTime
integer

Start timestamp in milliseconds

endTime
integer

End timestamp in milliseconds

page
integer
default:1

Page number

limit
integer
default:20

Number of logs per page (max 100)

Required range: x <= 100

Response

Logs retrieved successfully

success
boolean
Example:

true

message
string
Example:

"Logs retrieved successfully"

data
object[]
pagination
object