Skip to main content
GET
Get Cohort Breakdown
Returns the data behind Cohort analysis in Analytics. Take path and key from Get cohort dimensions.

Notes

  • path=custom_args groups by a variable you sent when placing calls, for example key=city.
  • path=retry_count groups by retry attempt and ignores key.
  • goal_rate uses each call’s own version goal and is null for values with no scored calls.

Errors

  • 400: a filter is invalid, such as an unknown channel, a malformed ID, or sub_workspace_id sent from a workspace that isn’t a primary workspace.
  • 401: X-API-KEY is missing or invalid.

Authorizations

X-API-KEY
string
header
required

Query Parameters

path
enum<string>
required

(Required) Column to group by. Use the path returned by Get Cohort Dimensions.

Available options:
client_analysis,
platform_analysis,
custom_args,
retry_count
Example:

"client_analysis"

key
string
default:""

Field inside path to group by, for example disposition. Ignored when path is retry_count.

Example:

"disposition"

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"

bulk_list_id
string

Filter by one or more campaign (bulk list) IDs (comma-separated). Callback calls inherit the campaign of their parent call.

Example:

"00000000-0000-4000-8000-0000000000c1"

channel
string

Filter by call channel (comma-separated): inbound, outbound, webcall. Unknown values return 400.

Example:

"outbound"

include_callback
boolean
default:false

Include callback-feature calls (call_category = CALLBACK) in the metrics. Defaults to false.

Example:

false

sub_workspace_id
string<uuid>[]

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.

Example:

Response

Cohort breakdown retrieved successfully.

path
string

The requested path.

key
string

The requested key.

breakdown
object[]