Appearance

On this page

Dashboards ​

Dashboards within the Insights module organize different Panels into an at-a-glance view. They can be used to group data based on department, objective, business process or anything you choose. Learn more about Dashboards.

The Dashboard Object ​

id uuid
Primary key of the dashboard.

name string
Name of the dashboard.

icon string
Material icon for dashboard.

note string
Descriptive text about the dashboard.

date_created Date
When the dashboard was created

user_created many-to-one
User that created the dashboard. Many-to-one to users.

color string
Accent color for the dashboard.

panels one-to-many
Panels that are in this dashboard. One-to-may to panels.

json
{
	"id": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
	"name": "My Dashboard",
	"icon": "dashboard",
	"note": "Test",
	"date_created": "2023-01-05T19:03:15.051Z",
	"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473",
	"color": "#6644FF",
	"panels": ["22640672-eef0-4ee9-ab04-591f3afb2883"]
}
{
	"id": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
	"name": "My Dashboard",
	"icon": "dashboard",
	"note": "Test",
	"date_created": "2023-01-05T19:03:15.051Z",
	"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473",
	"color": "#6644FF",
	"panels": ["22640672-eef0-4ee9-ab04-591f3afb2883"]
}

List Dashboards ​

List all dashboards that exist in Directus.

Request ​

API

Query Parameters ​

Supports all global query parameters.

Response ​

An array of up to limit dashboard objects. If no items are available, data will be an empty array.

Example ​

API

Retrieve a Dashboard ​

List an existing dashboard by primary key.

Request ​

API

Query Parameters ​

Supports all global query parameters.

Response ​

Returns the requested dashboard object.

Example ​

API

Create a Dashboard ​

Create a new dashboard.

Request ​

API

Query Parameters ​

Supports all global query parameters.

Request Body ​

A partial dashboard object.

Response ​

Returns the dashboard object for the created dashboard.

Example ​

API

Create Multiple Dashboards ​

Create multiple new dashboards.

Request ​

API

Query Parameters ​

Supports all global query parameters.

Request Body ​

An array of partial dashboard objects.

Response ​

Returns the dashboard object for the created dashboard.

Example ​

API

Update a Dashboard ​

Update an existing dashboard.

Request ​

API

Query Parameters ​

Supports all global query parameters.

Request Body ​

A partial dashboard object.

Response ​

Returns the dashboard object for the updated dashboard.

Example ​

API

Update Multiple Dashboards ​

Update multiple existing dashboards.

Request ​

API

Query Parameters ​

Supports all global query parameters.

Request Body ​

keys Required
Array of primary keys of the dashboards you'd like to update.

data Required
Any of the dashboard's properties.

Response ​

Returns the dashboard objects for the updated dashboards.

Example ​

API

Delete a Dashboard ​

Delete an existing dashboard.

Request ​

API

Response ​

Empty body.

Example ​

API

Delete Multiple Dashboards ​

Delete multiple existing dashboards.

Request ​

API

Request Body ​

An array of dashboards primary keys

Response ​

Empty body.

Example ​

API