getBotLogs

Get bot logs

GET/v1/admin/bots/{id}/logs

Authorization

AuthorizationBearerrequired

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

Header parameters

x-workspace-idstringrequired

Workspace ID

x-multiple-integrationsstring

Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Path parameters

idstringrequired

Bot ID

Query parameters

timeStartstringrequired

Beginning of the time range to get logs from

timeEndstring

End of the time range to get logs from

levelstring

Filter by log level

userIdstring

Filter by user ID

workflowIdstring

Filter by workflow ID

conversationIdstring

Filter by conversation ID

messageContainsstring

Filter logs where the message contains this substring

nextTokenstring

Token to get the next page of logs

Response

Success

logsobject[]required

nextTokenstring

Request

curl --request GET \ \
  --url https://api.botpress.cloud/v1/admin/bots/{id}/logs \
  --header 'x-workspace-id: <x-workspace-id>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "logs": [
    {
      "timestamp": "string",
      "level": "string",
      "message": "string",
      "workflowId": "string",
      "userId": "string",
      "conversationId": "string"
    }
  ],
  "nextToken": "string"
}