Get bot analytics
GET
/
v1
/
admin
/
bots
/
{id}
/
analytics
Copy
curl --request GET \
--url https://api.botpress.cloud/v1/admin/bots/{id}/analyticsCopy
{
"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
}
}
}
]
}Assistant
Responses are generated using AI and may contain mistakes.
Path Parameters
Bot ID
Query Parameters
Start date/time (inclusive)
End date/time (exclusive)
Response
200
application/json
Success
The response is of type object.
Was this page helpful?
Copy
curl --request GET \
--url https://api.botpress.cloud/v1/admin/bots/{id}/analyticsCopy
{
"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
}
}
}
]
}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
Get bot analytics
GET
/
v1
/
admin
/
bots
/
{id}
/
analytics
Copy
curl --request GET \
--url https://api.botpress.cloud/v1/admin/bots/{id}/analyticsCopy
{
"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
}
}
}
]
}Assistant
Responses are generated using AI and may contain mistakes.
Path Parameters
Bot ID
Query Parameters
Start date/time (inclusive)
End date/time (exclusive)
Response
200
application/json
Success
The response is of type object.
Was this page helpful?
Copy
curl --request GET \
--url https://api.botpress.cloud/v1/admin/bots/{id}/analyticsCopy
{
"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
}
}
}
]
}