Skip to main content
GET
Get CSAT 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"

timezone
string

Timezone for date calculations (defaults to system timezone)

Example:

"America/New_York"

page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
Example:

1

pageSize
integer
default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100
Example:

10

Response

Successfully retrieved CSAT analytics data

status
string
Example:

"success"

data
object