Dashboards

Manage Insights dashboards

Dashboards organize panels into customizable analytics views.

List Dashboards

Retrieve all dashboards.

GET /dashboards

Example:

curl "https://your-directus-instance.com/dashboards" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Dashboard

Retrieve a single dashboard with its panels.

GET /dashboards/:id

Include panels:

GET /dashboards/:id?fields=*,panels.*

Create Dashboard

Create a new dashboard.

POST /dashboards

Request Body:

{
  "name": "Analytics Dashboard",
  "icon": "dashboard",
  "color": "#6644FF",
  "note": "Sales and performance metrics"
}

Update Dashboard

Update dashboard properties.

PATCH /dashboards/:id

Delete Dashboard

Delete a dashboard.

DELETE /dashboards/:id

Dashboard Properties

id · string

Dashboard UUID

name · string

Dashboard name

icon · string

Material icon name

color · string

Hex color code

note · string

Description

panels · array

Dashboard panels

Next Steps

Panels

Manage panels

Insights

Learn about Insights