List dashboards

GET

https://api.speechify.ai/v1/agents/dashboards

GET

/v1/agents/dashboards

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

1 {
2   "dashboards": [
3     {
4       "id": "dash_01f4g7h8j9k0l2m3n4p5q6r7s",
5       "name": "Acme Inc Call Analytics",
6       "layout": {
7         "widgets": [
8           {
9             "id": "widget_001",
10             "title": "Total Calls",
11             "chart_type": "number",
12             "query": {
13               "metric": {
14                 "agg": "count",
15                 "field": "",
16                 "rate_predicate": {
17                   "field": "call_status",
18                   "op": "eq",
19                   "value": "completed"
20                 }
21               },
22               "group_by": [],
23               "filters": [
24                 {
25                   "field": "agent_id",
26                   "op": "neq",
27                   "value": "agent_000"
28                 }
29               ],
30               "time": {
31                 "field": "started_at",
32                 "bucket": "none",
33                 "from": "2024-04-01T00:00:00Z",
34                 "to": "2024-04-30T23:59:59Z",
35                 "timezone": "UTC"
36               },
37               "compare_to_previous": true,
38               "breakdown_limit": 50
39             },
40             "position": {
41               "x": 0,
42               "y": 0,
43               "w": 4,
44               "h": 3
45             },
46             "group_dim": ""
47           }
48         ]
49       },
50       "created_at": "2024-04-01T08:00:00Z",
51       "updated_at": "2024-04-15T12:00:00Z",
52       "description": "Overview of call volume and agent performance for Acme Inc."
53     }
54   ]
55 }

The caller's workspace's saved analytics dashboards. Dashboards are shared across the workspace.

Authentication

AuthorizationBearer

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

Response

The workspace's dashboards.

dashboardslist of objects

Errors

401

Unauthorized Error