/api/dashboards
REST API endpoint: /api/dashboards
/api/dashboards
GET
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
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | No | |
| title__iregex | string | No | |
| owner | array | No | Multiple values may be separated by commas. |
| ordering | string | No | Which field to use when ordering the results. |
| page | integer | No | A page number within the paginated result set. |
| page_size | integer | No | Number of results to return per page. |
| export | boolean | No | Return exportable fields only |
| show_all | boolean | No | Do not filter objects owned by current user |
Responses
200
POST
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
| Name | Type | Required | Description |
|---|---|---|---|
| clone_widgets | boolean | No | when cloning, clone widgets instead of adding read only |
| source_id | integer | No | clone existing dashboard |
Request Body
json{
"example": "request body"
}