Panels
List panels
List all panels that exist in Directus.
Query Parameters
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
How many items to skip when fetching data.
What metadata to return in the response.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
Cursor for use in pagination. Often used in combination with limit.
GET /panels
{
"data": [
{
"id": "22640672-eef0-4ee9-ab04-591f3afb288",
"dashboard": "a79bd1b2-beb2-49fc-8a26-0b3eec0e269",
"name": "30-day sales",
"icon": "paid",
"color": null,
"show_header": true,
"note": "Overview of the sales numbers in the last 30 day",
"type": "time-series",
"position_x": 1,
"position_y": 1,
"width": 1,
"height": 1,
"options": {},
"date_created": "2023-01-05T19:05:51.884Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473"
}
],
"meta": {}
}
Create Multiple panels
Create multiple new panels.
Query Parameters
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
What metadata to return in the response.
How many items to skip when fetching data.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
Request Body
POST /panels
{
"data": [
{
"id": "22640672-eef0-4ee9-ab04-591f3afb288",
"dashboard": "a79bd1b2-beb2-49fc-8a26-0b3eec0e269",
"name": "30-day sales",
"icon": "paid",
"color": null,
"show_header": true,
"note": "Overview of the sales numbers in the last 30 day",
"type": "time-series",
"position_x": 1,
"position_y": 1,
"width": 1,
"height": 1,
"options": {},
"date_created": "2023-01-05T19:05:51.884Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473"
}
],
"meta": {}
}
Delete Multiple panels
Delete multiple existing panels.
DELETE /panels
Update Multiple panels
Update multiple panels at the same time.
Query Parameters
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
What metadata to return in the response.
How many items to skip when fetching data.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
Request Body
PATCH /panels
{
"data": [
{
"id": "22640672-eef0-4ee9-ab04-591f3afb288",
"dashboard": "a79bd1b2-beb2-49fc-8a26-0b3eec0e269",
"name": "30-day sales",
"icon": "paid",
"color": null,
"show_header": true,
"note": "Overview of the sales numbers in the last 30 day",
"type": "time-series",
"position_x": 1,
"position_y": 1,
"width": 1,
"height": 1,
"options": {},
"date_created": "2023-01-05T19:05:51.884Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473"
}
],
"meta": {}
}
Create a panel
Create a new panel.
Query Parameters
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
POST /panels
{
"data": {
"id": "22640672-eef0-4ee9-ab04-591f3afb288",
"dashboard": "a79bd1b2-beb2-49fc-8a26-0b3eec0e269",
"name": "30-day sales",
"icon": "paid",
"color": null,
"show_header": true,
"note": "Overview of the sales numbers in the last 30 day",
"type": "time-series",
"position_x": 1,
"position_y": 1,
"width": 1,
"height": 1,
"options": {},
"date_created": "2023-01-05T19:05:51.884Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473"
}
}
Retrieve a panel
List an existing panel by primary key.
Query Parameters
Unique identifier of the panel.
Control what fields are being returned in the object.
What metadata to return in the response.
GET /panels/{id}
{
"data": {
"id": "22640672-eef0-4ee9-ab04-591f3afb288",
"dashboard": "a79bd1b2-beb2-49fc-8a26-0b3eec0e269",
"name": "30-day sales",
"icon": "paid",
"color": null,
"show_header": true,
"note": "Overview of the sales numbers in the last 30 day",
"type": "time-series",
"position_x": 1,
"position_y": 1,
"width": 1,
"height": 1,
"options": {},
"date_created": "2023-01-05T19:05:51.884Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473"
}
}
DELETE /panels/{id}
Update a panel
Update an existing panel.
Query Parameters
Unique identifier of the panel.
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
PATCH /panels/{id}
{
"data": {
"id": "22640672-eef0-4ee9-ab04-591f3afb288",
"dashboard": "a79bd1b2-beb2-49fc-8a26-0b3eec0e269",
"name": "30-day sales",
"icon": "paid",
"color": null,
"show_header": true,
"note": "Overview of the sales numbers in the last 30 day",
"type": "time-series",
"position_x": 1,
"position_y": 1,
"width": 1,
"height": 1,
"options": {},
"date_created": "2023-01-05T19:05:51.884Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473"
}
}