> ## Documentation Index > Fetch the complete documentation index at: https://docs.ringg.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > To search or read these docs, connect the Ringg docs MCP server at https://docs.ringg.ai/mcp (no key needed; tools search_ringg_ai and query_docs_filesystem_ringg_ai) instead of browsing pages one by one. Setup for each client: https://docs.ringg.ai/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants.md > The dashboard labels agents "Assistants"; these docs say "agent". Both mean the same object, identified by agent_id. > API base URL: https://prod-api.ringg.ai/ca/api/v0. Send the workspace API key in the X-API-KEY header, from server-side code only. > Placing a call dials a real phone number and spends credits. Confirm the number with the user before calling. > To act on a Ringg workspace (place calls, edit agents, read transcripts), use the separate Ringg workspace MCP server at https://mcp.ringg.ai/mcp: https://docs.ringg.ai/resources/mcp-server/workspace-mcp-server/overview.md > 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. # Get Cohort Breakdown export const RelatedTopics = ({items}) =>
Related topics
{items.map(([title, href]) => {title} )}
; Returns the data behind **Cohort analysis** in [Analytics](/documentation/monitor/analytics). Take `path` and `key` from [Get cohort dimensions](/api-reference/monitoring/analytics/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. ## OpenAPI ````yaml get /analytics/v4/cohort/breakdown openapi: 3.0.0 info: title: Ringg AI API Documentation description: >- The Ringg AI REST API. Base URL https://prod-api.ringg.ai/ca/api/v0; send your workspace API key in the X-API-KEY header from server-side code only. Requests and responses are JSON. version: 2.0.0 contact: name: Ringg AI support email: admin@ringg.ai url: https://docs.ringg.ai servers: - url: https://prod-api.ringg.ai/ca/api/v0 security: - ApiKeyAuth: [] tags: - name: workspace description: Endpoints for managing your workspace. - name: agent description: Endpoints for managing agents. - name: calling description: Endpoints for making and managing calls. - name: campaign description: Endpoints for managing campaigns. - name: analytics description: >- Analytics v4 endpoints for call, agent, cohort and chat performance metrics. - name: termination description: Endpoints for terminating active calls using different methods. - name: knowledgebase description: Endpoints for managing knowledge bases. paths: /analytics/v4/cohort/breakdown: get: tags: - analytics summary: Get Cohort Breakdown description: >- Returns call, connection, goal and handle-time metrics for each value of one dimension, for example connection rate per disposition. operationId: getCohortBreakdown parameters: - name: path in: query description: >- (Required) Column to group by. Use the `path` returned by Get Cohort Dimensions. required: true schema: type: string enum: - client_analysis - platform_analysis - custom_args - retry_count example: client_analysis - name: key in: query description: >- Field inside `path` to group by, for example `disposition`. Ignored when `path` is `retry_count`. required: false schema: type: string default: '' example: disposition - name: start_date in: query description: >- Start of the reporting window. Accepts `YYYY-MM-DD` or ISO-8601. Omit both dates for all time. required: false schema: type: string example: '2026-10-01' - name: end_date in: query description: >- End of the reporting window (inclusive). Accepts `YYYY-MM-DD` or ISO-8601. required: false schema: type: string example: '2026-10-15' - name: agent_id in: query description: Filter by one or more agent IDs (comma-separated). required: false schema: type: string example: 00000000-0000-4000-8000-0000000000a1 - name: agent_version_id in: query description: Filter by one or more agent version IDs (comma-separated). required: false schema: type: string example: 00000000-0000-4000-8000-0000000000d1 - name: bulk_list_id in: query description: >- Filter by one or more campaign (bulk list) IDs (comma-separated). Callback calls inherit the campaign of their parent call. required: false schema: type: string example: 00000000-0000-4000-8000-0000000000c1 - name: channel in: query description: >- Filter by call channel (comma-separated): `inbound`, `outbound`, `webcall`. Unknown values return `400`. required: false schema: type: string example: outbound - name: include_callback in: query description: >- Include callback-feature calls (`call_category = CALLBACK`) in the metrics. Defaults to `false`. required: false schema: type: boolean default: false example: false - name: sub_workspace_id in: query description: >- 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`. required: false schema: type: array items: type: string format: uuid example: - 00000000-0000-4000-8000-000000000101 style: form explode: true responses: '200': description: Cohort breakdown retrieved successfully. content: application/json: schema: type: object properties: path: type: string description: The requested `path`. key: type: string description: The requested `key`. breakdown: type: array items: type: object properties: value: type: string description: Dimension value. calls: type: integer description: Calls with this value. connected: type: integer description: Completed calls. connection_rate: type: number description: '`connected / calls` (0-1).' nullable: true goal_rate: type: number description: Goal rate (0-1). nullable: true aht_seconds: type: number description: Average handle time in seconds. nullable: true example: path: client_analysis key: disposition breakdown: - value: interested calls: 120 connected: 84 connection_rate: 0.7 goal_rate: 0.625 aht_seconds: 41.2 '400': description: >- Bad Request - invalid filter value (for example an unknown `channel` or malformed ID). content: application/json: example: message: 'invalid channel(s): sms' '401': description: Unauthorized - Invalid or missing authentication. '500': description: Internal Server Error. content: application/json: example: message: Failed to fetch cohort breakdown! components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.