Skip to main content
GET
Get Chat Analytics
Covers chats only; the other analytics endpoints cover calls. The dashboard’s Analytics page doesn’t show chats.

Notes

  • channel takes chat channels such as chat or whatsapp_meta_chat, not the call channels.
  • engaged_turns sets how many user messages make a session engaged (default 1). resolved counts completed sessions.
  • goal_rate uses each session’s own version goal.

Errors

  • 401: X-API-KEY is missing or invalid.

Authorizations

X-API-KEY
string
header
required

Query Parameters

start_date
string

Start of the reporting window. Accepts YYYY-MM-DD or ISO-8601. Omit both dates for all time.

Example:

"2026-10-01"

end_date
string

End of the reporting window (inclusive). Accepts YYYY-MM-DD or ISO-8601.

Example:

"2026-10-15"

agent_id
string

Filter by one or more agent IDs (comma-separated).

Example:

"00000000-0000-4000-8000-0000000000a1"

agent_version_id
string

Filter by one or more agent version IDs (comma-separated).

Example:

"00000000-0000-4000-8000-0000000000d1"

channel
string

Filter by chat channel (comma-separated), for example chat or whatsapp_meta_chat.

Example:

"whatsapp_meta_chat"

engaged_turns
integer
default:1

Minimum user turns for a session to count as engaged.

Required range: x >= 1
tz
string

IANA timezone used to bucket the time series (for example Asia/Kolkata). Bucket labels are returned in this timezone. Omitted or invalid values fall back to UTC.

Example:

"Asia/Kolkata"

Response

Chat analytics retrieved successfully.

volume
object
channel_split
object

Sessions per channel.

outcomes
object