List analytics dimensions

GET

https://api.speechify.ai/v1/agents/analytics/dimensions

GET

/v1/agents/analytics/dimensions

$ curl https://api.speechify.ai/v1/agents/analytics/dimensions \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "dimensions": [
3     {
4       "key": "call_status",
5       "label": "Call Status",
6       "type": "enum",
7       "source": "conversation",
8       "filterable": true,
9       "groupable": true,
10       "enum_values": [
11         "completed",
12         "missed",
13         "voicemail",
14         "in_progress"
15       ]
16     },
17     {
18       "key": "agent_performance_score",
19       "label": "Agent Performance Score",
20       "type": "number",
21       "source": "evaluation",
22       "filterable": true,
23       "groupable": false
24     },
25     {
26       "key": "customer_satisfaction",
27       "label": "Customer Satisfaction",
28       "type": "enum",
29       "source": "evaluation",
30       "filterable": true,
31       "groupable": true,
32       "enum_values": [
33         "very_satisfied",
34         "satisfied",
35         "neutral",
36         "dissatisfied",
37         "very_dissatisfied"
38       ],
39       "agent_id": "agent_01arz3ndektsv4rrffq69g5fav"
40     },
41     {
42       "key": "call_duration_seconds",
43       "label": "Call Duration (seconds)",
44       "type": "number",
45       "source": "conversation",
46       "filterable": true,
47       "groupable": false
48     },
49     {
50       "key": "data_collection_consent",
51       "label": "Data Collection Consent",
52       "type": "bool",
53       "source": "data_field",
54       "filterable": true,
55       "groupable": true,
56       "agent_id": "agent_01arz3ndektsv4rrffq69g5fav"
57     }
58   ]
59 }

The typed dimension catalog the analytics dashboards filter and break down by. Returns the always-available call-level dimensions; pass agent_id to additionally include that agent’s evaluation criteria and typed data-collection fields. Each dimension declares its value type and whether it can be used to filter, to group by, or both. Free-text fields are never returned as dimensions.

The typed dimension catalog the analytics dashboards filter and break down by. Returns the always-available call-level dimensions; pass `agent_id` to additionally include that agent's evaluation criteria and typed data-collection fields. Each dimension declares its value `type` and whether it can be used to filter, to group by, or both. Free-text fields are never returned as dimensions.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Query parameters

agent_idstringOptional

Include this agent’s per-agent evaluation and data-collection dimensions.

Response

The analytics dimension catalog.

dimensionslist of objects

Errors

401

Unauthorized Error

404

Not Found Error