Find dashboards

GET

/v1/private/dashboards

GET

/api/v1/private/dashboards

1 curl http://localhost:5173/api/v1/private/dashboards \
2      -H "Content-Type: application/json"

200Retrieved

1 {
2   "content": [
3     {
4       "name": "Q1 Marketing Dashboard",
5       "config": {
6         "widgets": [
7           {
8             "type": "line_chart",
9             "data_source": "campaign_performance",
10             "settings": {
11               "x_axis": "date",
12               "y_axis": "clicks"
13             }
14           }
15         ]
16       },
17       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
18       "workspace_id": "workspace-12345",
19       "project_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
20       "slug": "q1-marketing-dashboard",
21       "type": "multi_project",
22       "scope": "workspace",
23       "description": "Dashboard showing key marketing metrics for Q1 campaigns.",
24       "created_by": "alice@example.com",
25       "last_updated_by": "bob@example.com",
26       "created_at": "2024-01-15T09:30:00Z",
27       "last_updated_at": "2024-01-15T09:30:00Z"
28     }
29   ],
30   "page": 1,
31   "size": 1,
32   "total": 1,
33   "sortable_by": [
34     "name",
35     "created_at",
36     "last_updated_at"
37   ]
38 }

Find dashboards in a workspace

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

namestringOptional

project_idstringOptionalformat: "uuid"

sortingstringOptional

filtersstringOptional

Response

Dashboard page

contentlist of objects

pageinteger

sizeinteger

totallong

sortable_bylist of strings