Update dashboard

PATCH

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

PATCH

/v1/agents/dashboards/:id

$ curl -X PATCH https://api.speechify.ai/v1/agents/dashboards/id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

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

Partial update; omitted fields are left unchanged.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringOptional

descriptionstring or nullOptional

layoutobjectOptional

Response

The updated 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

404

Not Found Error