Panels
Panels are modular units of data visualization that exist within the Insights module. Each panel exists within a Dashboard and can be positioned and resized as needed.
The Panel Object
id uuid
Primary key of the panel.
dashboard many-to-one
Dashboard where this panel is visible. Many-to-one to dashboards.
name string
Name of the panel.
icon string
Material design icon for the panel.
color string
Accent color of the panel.
show_header boolean
Whether or not the header should be rendered for this panel.
note string
Description for the panel.
type string
The panel type used for this panel.
position_x integer
The X position on the workspace grid.
position_y integer
The Y position on the workspace grid.
width integer
Width of the panel in number of workspace dots.
height integer
Height of the panel in number of workspace dots.
options JSON
Arbitrary options for the panel. Differs per panel type.
date_created Date
When the panel was created
user_created many-to-one
User that created the panel. Many-to-one to users.
{
"id": "22640672-eef0-4ee9-ab04-591f3afb2883",
"dashboard": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
"name": "30-day sales",
"icon": "paid",
"color": "#6B8068",
"show_header": true,
"note": "Overview of the sales numbers in the last 30 days",
"type": "time-series",
"position_x": 1,
"position_y": 1,
"width": 8,
"height": 6,
"options": {},
"date_created": "2023-01-05T19:05:51.884Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473"
}{
"id": "22640672-eef0-4ee9-ab04-591f3afb2883",
"dashboard": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
"name": "30-day sales",
"icon": "paid",
"color": "#6B8068",
"show_header": true,
"note": "Overview of the sales numbers in the last 30 days",
"type": "time-series",
"position_x": 1,
"position_y": 1,
"width": 8,
"height": 6,
"options": {},
"date_created": "2023-01-05T19:05:51.884Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473"
}List Panels
List all panels that exist in Directus.
Request
Query Parameters
Supports all global query parameters.
Response
An array of up to limit panel objects. If no items are available, data will be an empty array.
Example
Retrieve a Panel
List an existing panel by primary key.
Request
Query Parameters
Supports all global query parameters.
Response
Returns the requested panel object.
Example
Create a Panel
Create a new panel.
Request
Query Parameters
Supports all global query parameters.
Request Body
A partial panel object.
Response
Returns the panel object for the created panel.
Example
Create Multiple Panels
Create multiple new panels.
Request
Query Parameters
Supports all global query parameters.
Request Body
An array of partial panel objects.
Response
Returns the panel object for the created panel.
Example
Update a Panel
Update an existing panel.
Request
Query Parameters
Supports all global query parameters.
Request Body
A partial panel object.
Response
Returns the panel object for the updated panel.
Example
Update Multiple Panels
Update multiple existing panels.
Request
Query Parameters
Supports all global query parameters.
Request Body
keys Required
Array of primary keys of the panels you'd like to update.
data Required
Any of the panel's properties.
Response
Returns the panel objects for the updated panels.
Example
Delete a Panel
Delete an existing panel.
Request
Response
Empty body.
Example
Delete Multiple Panels
Delete multiple existing panels.
Request
Request Body
An array of panels primary keys
Response
Empty body.