Skip to main content
GET
/
v1
/
admin
/
bots
/
{id}
/
logs
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/admin/bots/{id}/logs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "logs": [
    {
      "timestamp": "<string>",
      "level": "<string>",
      "message": "<string>",
      "workflowId": "<string>",
      "userId": "<string>",
      "conversationId": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-workspace-id
string
required

Workspace ID

​
x-multiple-integrations
string

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

​
id
string
required

Bot ID

Query Parameters

​
timeStart
string
required

Beginning of the time range to get logs from

​
timeEnd
string

End of the time range to get logs from

​
level
string

Filter by log level

​
userId
string

Filter by user ID

​
workflowId
string

Filter by workflow ID

​
conversationId
string

Filter by conversation ID

​
messageContains
string

Filter logs where the message contains this substring

​
nextToken
string

Token to get the next page of logs

Response

Success

​
logs
object[]
required
​
nextToken
string