dashboards
GET /api/dashboards
Summary: List all dashboards
Always filtered by owner, unless you have permission for managing dashboards AND set "show_all" parameter - then returns them all.
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| query | title |
string | no | |
| query | title__iregex |
string | no | |
| query | owner |
array | no | Multiple values may be separated by commas. |
| query | ordering |
string | no | Which field to use when ordering the results. |
| query | page |
integer | no | A page number within the paginated result set. |
| query | page_size |
integer | no | Number of results to return per page. |
| query | export |
boolean | no | Return exportable fields only |
| query | show_all |
boolean | no | Do not filter objects owned by current user |
Responses
-
200 —
-
Media type:
application/json
Type: PaginatedDashboardList
POST /api/dashboards
Summary: Create a new dashboard
You can provide full data for the new dashboard, or you can clone existing one with source_id parameter, pointing to another dashboard. When cloning you can also set "clone_widgets" to true to clone all widgets - otherwise they will be just added to the dashboard without cloning (often read_only).
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| query | clone_widgets |
boolean | no | when cloning, clone widgets instead of adding read only |
| query | source_id |
integer | no | clone existing dashboard |
Request Body
- Media type:
application/json
Type: Dashboard
- Media type:
application/x-www-form-urlencoded
Type: Dashboard
- Media type:
multipart/form-data
Type: Dashboard
Responses
-
201 —
-
Media type:
application/json
Type: Dashboard
DELETE /api/dashboards/{id}
Summary: Delete specified dashboard
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this dashboard. |
Responses
- 204 — No response body
GET /api/dashboards/{id}
Summary: Get details for specified dashboard
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this dashboard. |
| query | export |
boolean | no | Return exportable fields only |
Responses
-
200 —
-
Media type:
application/json
Type: Dashboard
PATCH /api/dashboards/{id}
Summary: Update specific settings for given dashboard
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this dashboard. |
Request Body
- Media type:
application/json
Type: PatchedDashboard
- Media type:
application/x-www-form-urlencoded
Type: PatchedDashboard
- Media type:
multipart/form-data
Type: PatchedDashboard
Responses
-
200 —
-
Media type:
application/json
Type: Dashboard
PUT /api/dashboards/{id}
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this dashboard. |
Request Body
- Media type:
application/json
Type: Dashboard
- Media type:
application/x-www-form-urlencoded
Type: Dashboard
- Media type:
multipart/form-data
Type: Dashboard
Responses
-
200 —
-
Media type:
application/json
Type: Dashboard
POST /api/dashboards/{id}/templates
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this dashboard. |
Request Body
- Media type:
application/json
Type: DashboardTemplatePath
- Media type:
application/x-www-form-urlencoded
Type: DashboardTemplatePath
- Media type:
multipart/form-data
Type: DashboardTemplatePath
Responses
-
200 —
-
Media type:
application/json
Type: DashboardTemplatePath
POST /api/dashboards/{id}/widgets
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this dashboard. |
Request Body
- Media type:
application/json
Type: Widget
- Media type:
application/x-www-form-urlencoded
Type: Widget
- Media type:
multipart/form-data
Type: Widget
Responses
-
200 —
-
Media type:
application/json
Type: Widget
DELETE /api/dashboards/{id}/widgets/
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this dashboard. |
Responses
- 204 — No response body