curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/analytics/v4/cohort/breakdown \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/analytics/v4/cohort/breakdown"
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/cohort/breakdown', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"path": "client_analysis",
"key": "disposition",
"breakdown": [
{
"value": "interested",
"calls": 120,
"connected": 84,
"connection_rate": 0.7,
"goal_rate": 0.625,
"aht_seconds": 41.2
}
]
}{
"message": "invalid channel(s): sms"
}{
"message": "Failed to fetch cohort breakdown!"
}Get Cohort Breakdown
Get calls, connection rate, goal rate and average handle time for each value of one analytics field, such as a disposition or a custom argument.
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/analytics/v4/cohort/breakdown \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/analytics/v4/cohort/breakdown"
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/cohort/breakdown', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"path": "client_analysis",
"key": "disposition",
"breakdown": [
{
"value": "interested",
"calls": 120,
"connected": 84,
"connection_rate": 0.7,
"goal_rate": 0.625,
"aht_seconds": 41.2
}
]
}{
"message": "invalid channel(s): sms"
}{
"message": "Failed to fetch cohort breakdown!"
}path and key from Get cohort dimensions.
Notes
path=custom_argsgroups by a variable you sent when placing calls, for examplekey=city.path=retry_countgroups by retry attempt and ignoreskey.goal_rateuses each call’s own version goal and isnullfor values with no scored calls.
Errors
400: a filter is invalid, such as an unknownchannel, a malformed ID, orsub_workspace_idsent from a workspace that isn’t a primary workspace.401:X-API-KEYis missing or invalid.
Authorizations
Query Parameters
(Required) Column to group by. Use the path returned by Get Cohort Dimensions.
client_analysis, platform_analysis, custom_args, retry_count "client_analysis"
Field inside path to group by, for example disposition. Ignored when path is retry_count.
"disposition"
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 one or more campaign (bulk list) IDs (comma-separated). Callback calls inherit the campaign of their parent call.
"00000000-0000-4000-8000-0000000000c1"
Filter by call channel (comma-separated): inbound, outbound, webcall. Unknown values return 400.
"outbound"
Include callback-feature calls (call_category = CALLBACK) in the metrics. Defaults to false.
false
Primary workspaces only: limit the combined analytics to these Ringg Spaces. Repeat the parameter for multiple IDs. The primary workspace's own ID is accepted; any other workspace sending this parameter gets 400.
["00000000-0000-4000-8000-000000000101"]
Was this page helpful?