Skip to main content
GET
Get topics analytics

Authorizations

Authorization
string
header
required

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

Query Parameters

agentId
string
required

The ID of the agent/chatbot

Example:

"clx1234567890abcdef"

startDate
string<date>
required

Start date for analytics (ISO 8601 format)

Example:

"2024-01-01"

endDate
string<date>
required

End date for analytics (ISO 8601 format)

Example:

"2024-01-31"

showAllTopics
boolean
default:false

Show all topics instead of just top 6

Example:

false

timezone
string

Timezone for date calculations (defaults to system timezone)

Example:

"America/New_York"

Response

Successfully retrieved topics analytics data

status
string
Example:

"success"

data
object[]

Daily breakdown of conversation topics (dynamic properties based on topics)

keys
string[]

Top topic names (top 6 by default, all if showAllTopics=true)

Example:
allTopics
object[]

All topics with their total counts across the entire period

areAllTopicsVisible
boolean

Whether all topics are currently visible or filtered to top 6

Example:

false