Skip to main content
GET
Get Cohort Dimensions
Start here to build a cohort view. Pass a dimension’s path and key to Get cohort values for its values, or to 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.

Authorizations

X-API-KEY
string
header
required

Query Parameters

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"

include_numeric
boolean
default:false

Also return number and integer analysis fields. These can't be used for grouping, so they are left out by default.

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 dimensions retrieved successfully.

reserved
object[]

Built-in dimensions.

client_analysis
object[]

Post-call analysis fields configured on the agent.