Dashboards

Create, read, update, and delete dashboards.

Method	Endpoint	Path
DELETE	Bulk delete dashboards	/api/v1/dashboard/
GET	Get a list of dashboards	/api/v1/dashboard/
POST	Create a new dashboard	/api/v1/dashboard/
GET	Get metadata information about this API resource (dashboard--info)	/api/v1/dashboard/_info
GET	Get a dashboard detail information	/api/v1/dashboard/{id_or_slug}
GET	Get a dashboard's chart definitions.	/api/v1/dashboard/{id_or_slug}/charts
POST	Create a copy of an existing dashboard	/api/v1/dashboard/{id_or_slug}/copy/
GET	Get dashboard's datasets	/api/v1/dashboard/{id_or_slug}/datasets
DELETE	Delete a dashboard's embedded configuration	/api/v1/dashboard/{id_or_slug}/embedded
GET	Get the dashboard's embedded configuration	/api/v1/dashboard/{id_or_slug}/embedded
POST	Set a dashboard's embedded configuration	/api/v1/dashboard/{id_or_slug}/embedded
PUT	Update dashboard by id_or_slug embedded	/api/v1/dashboard/{id_or_slug}/embedded
GET	Get dashboard's tabs	/api/v1/dashboard/{id_or_slug}/tabs
DELETE	Delete a dashboard	/api/v1/dashboard/{pk}
PUT	Update a dashboard	/api/v1/dashboard/{pk}
POST	Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)	/api/v1/dashboard/{pk}/cache_dashboard_screenshot/
PUT	Update colors configuration for a dashboard.	/api/v1/dashboard/{pk}/colors
DELETE	Remove the dashboard from the user favorite list	/api/v1/dashboard/{pk}/favorites/
POST	Mark the dashboard as favorite for the current user	/api/v1/dashboard/{pk}/favorites/
PUT	Update native filters configuration for a dashboard.	/api/v1/dashboard/{pk}/filters
GET	Get a computed screenshot from cache (dashboard-pk-screenshot-digest)	/api/v1/dashboard/{pk}/screenshot/{digest}/
GET	Get dashboard's thumbnail	/api/v1/dashboard/{pk}/thumbnail/{digest}/
GET	Download multiple dashboards as YAML files	/api/v1/dashboard/export/
GET	Check favorited dashboards for current user	/api/v1/dashboard/favorite_status/
POST	Import dashboard(s) with associated charts/datasets/databases	/api/v1/dashboard/import/
GET	Get related fields data (dashboard-related-column-name)	/api/v1/dashboard/related/{column_name}