Dashboards
List Dashboards
List all dashboards 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 /dashboards
{
"data": [
{
"id": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
"name": "My dashboard",
"icon": "space_dashboard",
"note": "Test",
"date_created": "2023-01-25T19:16:49.009Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473",
"color": null,
"panels": "22640672-eef0-4ee9-ab04-591f3afb2883"
}
],
"meta": {}
}
Create Multiple Dashboards
Create multiple new dashboards.
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 /dashboards
{
"data": [
{
"id": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
"name": "My dashboard",
"icon": "space_dashboard",
"note": "Test",
"date_created": "2023-01-25T19:16:49.009Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473",
"color": null,
"panels": "22640672-eef0-4ee9-ab04-591f3afb2883"
}
],
"meta": {}
}
Delete Multiple Dashboards
Delete multiple existing dashboards.
204 Response
The resource was deleted successfully.
DELETE /dashboards
Update Multiple Dashboards
Update multiple dashboards 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 /dashboards
{
"data": [
{
"id": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
"name": "My dashboard",
"icon": "space_dashboard",
"note": "Test",
"date_created": "2023-01-25T19:16:49.009Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473",
"color": null,
"panels": "22640672-eef0-4ee9-ab04-591f3afb2883"
}
],
"meta": {}
}
Create a Dashboard
Create a new dashboard.
Query Parameters
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
POST /dashboards
{
"data": {
"id": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
"name": "My dashboard",
"icon": "space_dashboard",
"note": "Test",
"date_created": "2023-01-25T19:16:49.009Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473",
"color": null,
"panels": "22640672-eef0-4ee9-ab04-591f3afb2883"
}
}
Retrieve a Dashboard
List an existing dashboard by primary key.
Query Parameters
Unique identifier of the Dashboard.
Control what fields are being returned in the object.
What metadata to return in the response.
GET /dashboards/{id}
{
"data": {
"id": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
"name": "My dashboard",
"icon": "space_dashboard",
"note": "Test",
"date_created": "2023-01-25T19:16:49.009Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473",
"color": null,
"panels": "22640672-eef0-4ee9-ab04-591f3afb2883"
}
}
Delete a Dashboard
Delete an existing dashboard.
Query Parameters
Unique identifier of the dashboard.
204 Response
The resource was deleted successfully.
DELETE /dashboards/{id}
Update a Dashboard
Update an existing dashboard.
Query Parameters
Unique identifier of the dashboard.
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
PATCH /dashboards/{id}
{
"data": {
"id": "a79bd1b2-beb2-49fc-8a26-0b3eec0e2697",
"name": "My dashboard",
"icon": "space_dashboard",
"note": "Test",
"date_created": "2023-01-25T19:16:49.009Z",
"user_created": "fd066644-c8e5-499d-947b-fe6c6e1a1473",
"color": null,
"panels": "22640672-eef0-4ee9-ab04-591f3afb2883"
}
}