Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/directus/directus/llms.txt

Use this file to discover all available pages before exploring further.

Panels are visualization components within dashboards.

​
List Panels

Retrieve all panels. 
GET /panels

​
Get Panel

Retrieve a single panel. 
GET /panels/:id

​
Create Panel

Create a new panel. 
POST /panels
Request Body: 
{
  "dashboard": "dashboard-uuid",
  "name": "Total Sales",
  "icon": "attach_money",
  "color": "#00C897",
  "type": "metric",
  "position_x": 0,
  "position_y": 0,
  "width": 12,
  "height": 8,
  "options": {
    "collection": "orders",
    "field": "total",
    "function": "sum"
  }
}

​
Update Panel

Update panel configuration. 
PATCH /panels/:id

​
Delete Panel

Delete a panel. 
DELETE /panels/:id

​
Panel Types

  • metric - Single value metric
  • line-chart - Line chart visualization
  • bar-chart - Bar chart visualization
  • list - Item list
  • table - Data table
  • time-series - Time-based chart
  • label - Text label
  • markdown - Markdown content

​
Panel Properties

​
id
string
Panel UUID
​
dashboard
string
Parent dashboard UUID
​
name
string
Panel name
​
type
string
Panel type
​
position_x
integer
Horizontal position (grid units)
​
position_y
integer
Vertical position (grid units)
​
width
integer
Panel width (grid units)
​
height
integer
Panel height (grid units)
​
options
object
Panel-specific configuration

​
Next Steps

Dashboards

Manage dashboards

Insights

Learn about Insights