> ## 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 > List the fields you can slice call analytics by: built-in fields such as sentiment, and the Advanced Analysis variables configured on your agent. # Get Cohort Dimensions export const RelatedTopics = ({items}) =>
Related topics
{items.map(([title, href]) => {title} )}
; Start here to build a cohort view. Pass a dimension's `path` and `key` to [Get cohort values](/api-reference/monitoring/analytics/get-cohort-values) for its values, or to [Get cohort breakdown](/api-reference/monitoring/analytics/get-cohort-breakdown) for metrics per value. ## Notes * Dimensions come from `agent_version_id`, else `agent_id`, else the agent that runs `bulk_list_id`. * Number fields are returned only with `include_numeric=true`, because they can't be grouped. * The goal variable appears as an ordinary Boolean field. ## Errors * `400`: an ID is malformed, or `sub_workspace_id` was sent from a workspace that isn't a primary workspace. * `401`: `X-API-KEY` is missing or invalid. ## OpenAPI ````yaml get /analytics/v4/cohort/dimensions 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/dimensions: get: tags: - analytics summary: Get Cohort Dimensions description: >- Lists the fields you can slice analytics by: built-in fields such as sentiment, and the post-call analysis fields configured on the agent. The configuration is read from `agent_version_id`, else `agent_id`, else the agent that owns `bulk_list_id`. operationId: getCohortDimensions parameters: - 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: include_numeric in: query description: >- Also return number and integer analysis fields. These can't be used for grouping, so they are left out by default. required: false schema: type: boolean default: 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 dimensions retrieved successfully. content: application/json: schema: type: object properties: reserved: type: array description: Built-in dimensions. items: type: object properties: path: type: string description: >- Column to pass as `path` to Get Cohort Values / Get Cohort Breakdown. key: type: string description: Field to pass as `key`. label: type: string description: Display label. type: type: string enum: - string - boolean - number - integer description: Field type. values: type: array description: Known values, when the set is fixed. items: type: string client_analysis: type: array description: Post-call analysis fields configured on the agent. items: type: object properties: path: type: string description: >- Column to pass as `path` to Get Cohort Values / Get Cohort Breakdown. key: type: string description: Field to pass as `key`. label: type: string description: Display label. type: type: string enum: - string - boolean - number - integer description: Field type. values: type: array description: Known values, when the set is fixed. items: type: string example: reserved: - path: platform_analysis key: sentiment label: Sentiment type: string values: - positive - neutral - negative client_analysis: - path: client_analysis key: ptp_obtained label: PTP obtained type: boolean - path: client_analysis key: disposition label: Disposition type: string '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 dimensions! 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.