Chat API
- Introduction
- Endpoints
Admin API
- Getting started
- Concepts
- Endpoints
- GETgetAccount
- PUTupdateAccount
- GETlistPublicIntegrations
- GETgetPublicIntegrationById
- GETgetPublicIntegration
- POSTcreateBot
- GETlistBots
- PUTupdateBot
- GETgetBot
- DELdeleteBot
- GETgetBotLogs
- GETgetBotAnalytics
- GETgetBotIssue
- DELdeleteBotIssue
- GETlistBotIssues
- GETlistBotIssueEvents
- POSTcreateWorkspace
- GETlistWorkspaces
- GETgetPublicWorkspace
- GETgetWorkspace
- PUTupdateWorkspace
- DELdeleteWorkspace
- GETlistPublicWorkspaces
- GETgetAuditRecords
- GETlistWorkspaceMembers
- POSTcreateWorkspaceMember
- GETgetWorkspaceMember
- DELdeleteWorkspaceMember
- PUTupdateWorkspaceMember
- POSTcreateIntegration
- GETlistIntegrations
- POSTvalidateIntegrationCreation
- PUTupdateIntegration
- GETgetIntegration
- DELdeleteIntegration
- PUTvalidateIntegrationUpdate
- GETgetIntegrationLogs
- GETgetIntegrationByName
- GET
Files API
Tables API
- Getting Started
- Endpoints
Runtime API
- Getting Started
- Concepts
- Endpoints
getBotAnalytics
Get bot analytics
GET
/
v1
/
admin
/
bots
/
{id}
/
analytics
curl --request GET \
--url https://api.botpress.cloud/v1/admin/bots/{id}/analytics
{
"records": [
{
"startDateTimeUtc": "<string>",
"endDateTimeUtc": "<string>",
"returningUsers": 123,
"newUsers": 123,
"sessions": 123,
"messages": 123,
"userMessages": 123,
"botMessages": 123,
"events": 123,
"eventTypes": {},
"customEvents": {},
"llm": {
"calls": 123,
"errors": 123,
"inputTokens": 123,
"outputTokens": 123,
"latency": {
"mean": 123,
"sd": 123,
"min": 123,
"max": 123
},
"tokensPerSecond": {
"mean": 123,
"sd": 123,
"min": 123,
"max": 123
},
"cost": {
"sum": 123,
"mean": 123,
"sd": 123,
"min": 123,
"max": 123
}
}
}
]
}
Path Parameters
Bot ID
Query Parameters
Start date/time (inclusive)
End date/time (exclusive)
Response
200
application/json
Success
ISO 8601 date string of the beginning (inclusive) of the period
ISO 8601 date string of the end (exclusive) of the period
Deprecated. Use userMessages
instead.
Was this page helpful?
curl --request GET \
--url https://api.botpress.cloud/v1/admin/bots/{id}/analytics
{
"records": [
{
"startDateTimeUtc": "<string>",
"endDateTimeUtc": "<string>",
"returningUsers": 123,
"newUsers": 123,
"sessions": 123,
"messages": 123,
"userMessages": 123,
"botMessages": 123,
"events": 123,
"eventTypes": {},
"customEvents": {},
"llm": {
"calls": 123,
"errors": 123,
"inputTokens": 123,
"outputTokens": 123,
"latency": {
"mean": 123,
"sd": 123,
"min": 123,
"max": 123
},
"tokensPerSecond": {
"mean": 123,
"sd": 123,
"min": 123,
"max": 123
},
"cost": {
"sum": 123,
"mean": 123,
"sd": 123,
"min": 123,
"max": 123
}
}
}
]
}