curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/analytics/v4/chat-analytics \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/analytics/v4/chat-analytics"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/analytics/v4/chat-analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"volume": {
"total": 20,
"by_bucket": [
{
"bucket": "2026-10-15",
"count": 20
}
]
},
"channel_split": {
"whatsapp_meta_chat": 14,
"chat": 6
},
"outcomes": {
"initiated": 20,
"engaged": 16,
"resolved": 12,
"avg_session_seconds": 184.2,
"avg_turns": 9.4,
"goal_rate": 0.5,
"positive_sentiment_share": 0.6
}
}{
"message": "invalid channel(s): sms"
}{
"message": "Failed to fetch chat analytics!"
}Get Chat Analytics
Get web chat and WhatsApp session volume over time, sessions per channel, and engagement, resolution and goal metrics, filtered by date, agent or channel.
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/analytics/v4/chat-analytics \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/analytics/v4/chat-analytics"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/analytics/v4/chat-analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"volume": {
"total": 20,
"by_bucket": [
{
"bucket": "2026-10-15",
"count": 20
}
]
},
"channel_split": {
"whatsapp_meta_chat": 14,
"chat": 6
},
"outcomes": {
"initiated": 20,
"engaged": 16,
"resolved": 12,
"avg_session_seconds": 184.2,
"avg_turns": 9.4,
"goal_rate": 0.5,
"positive_sentiment_share": 0.6
}
}{
"message": "invalid channel(s): sms"
}{
"message": "Failed to fetch chat analytics!"
}Notes
channeltakes chat channels such aschatorwhatsapp_meta_chat, not the call channels.engaged_turnssets how many user messages make a sessionengaged(default1).resolvedcounts completed sessions.goal_rateuses each session’s own version goal.
Errors
401:X-API-KEYis missing or invalid.
Authorizations
Query Parameters
Start of the reporting window. Accepts YYYY-MM-DD or ISO-8601. Omit both dates for all time.
"2026-10-01"
End of the reporting window (inclusive). Accepts YYYY-MM-DD or ISO-8601.
"2026-10-15"
Filter by one or more agent IDs (comma-separated).
"00000000-0000-4000-8000-0000000000a1"
Filter by one or more agent version IDs (comma-separated).
"00000000-0000-4000-8000-0000000000d1"
Filter by chat channel (comma-separated), for example chat or whatsapp_meta_chat.
"whatsapp_meta_chat"
Minimum user turns for a session to count as engaged.
x >= 1IANA 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.
"Asia/Kolkata"
Was this page helpful?