Create dashboard

POST

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

POST

/v1/agents/dashboards

$ curl -X POST https://api.speechify.ai/v1/agents/dashboards \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Acme Inc Voice Agent Dashboard",
>   "layout": {
>     "widgets": [
>       {
>         "id": "widget_01a2b3c4d5e6f7g8h9i0jklm",
>         "title": "Total Calls Handled",
>         "chart_type": "number",
>         "query": {
>           "metric": {
>             "agg": "count"
>           }
>         },
>         "position": {
>           "x": 0,
>           "y": 0,
>           "w": 4,
>           "h": 3
>         }
>       }
>     ]
>   }
> }'

1 {
2   "id": "dash_01a2b3c4d5e6f7g8h9i0jklmnp",
3   "name": "Acme Inc Voice Agent Dashboard",
4   "layout": {
5     "widgets": [
6       {
7         "id": "widget_01a2b3c4d5e6f7g8h9i0jklm",
8         "title": "Total Calls Handled",
9         "chart_type": "number",
10         "query": {
11           "metric": {
12             "agg": "count",
13             "field": "call_id",
14             "rate_predicate": {
15               "field": "call_status",
16               "op": "eq",
17               "value": "completed"
18             }
19           },
20           "group_by": [
21             "agent_id"
22           ],
23           "filters": [
24             {
25               "field": "call_type",
26               "op": "eq",
27               "value": "inbound"
28             }
29           ],
30           "time": {
31             "field": "started_at",
32             "bucket": "day",
33             "from": "2024-05-01T00:00:00Z",
34             "to": "2024-05-31T23:59:59Z",
35             "timezone": "America/New_York"
36           },
37           "compare_to_previous": true,
38           "breakdown_limit": 10
39         },
40         "position": {
41           "x": 0,
42           "y": 0,
43           "w": 4,
44           "h": 3
45         },
46         "group_dim": "agent_id"
47       }
48     ]
49   },
50   "created_at": "2024-05-31T12:00:00Z",
51   "updated_at": "2024-05-31T12:00:00Z",
52   "description": "Dashboard showing key metrics for Acme Inc's voice agents."
53 }

Create a saved dashboard. Each widget carries a chart type, a grid position, and an analytics query spec validated against the dimension registry. Limited to 10 dashboards per workspace.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

layoutobjectRequired

descriptionstring or nullOptional

Response

The created dashboard.

idstring

Prefixed wire id (dash_<26 char Crockford base32>).

namestring

layoutobject

created_atdatetime

updated_atdatetime

descriptionstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error