Learn how to create and update dashboards and widgets using the platform API
monday.com dashboards compile data from one or more boards into a centralized high-level overview. They're made up of apps and widgets that visually display key metrics like project progress, budgets, workloads, and much more!
Mutations
You can create and update dashboards and widgets via the API using the following mutations.
Create dashboard
The create_dashboard
mutation creates a new dashboard via the API. It returns the Dashboard
type which allows you to specify what fields to query back when you run it.
mutation {
create_dashboard(
board_ids: ["1234567890", "9876543210"]
board_folder_id: 18111021
kind: PRIVATE
name: "Team Performance"
workspace_id: -1
) {
id
name
kind
workspace_id
}
}
{
"data": {
"create_dashboard": {
"id": "12345",
"name": "Team Performance",
"kind": "PUBLIC",
"workspace_id": -1
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Arguments
You can use the following argument(s) to define the new dashboard's characteristics.
Argument | Description | Enum Values |
---|---|---|
board_ids [String!]! | The unique identifier of the board(s) to create dashboards for. | |
board_folder_id Int | The unique identifier of the folder to create the dashboard in. | |
kind DashboardKind | The dashboard's visibility. The default is PRIVATE . | PRIVATE PUBLIC |
name String! | The dashboard's name. Up to 255 characters. | |
workspace_id Int! | The unique identifier of the workspace to create the dashboard in. |
Update overview hierarchy
The udpate_overview_hierarchy
mutation updates a dashboard's position or location via the API. It returns the UpdateOverviewHierarchy
type which allows you to specify what fields to query back when you run it.
mutation {
update_overview_hierarchy (
overview_id: 12345
attributes: {
workspace_id: -1
position: {
is_after: true
object_id: "9876543210"
object_type: Board
}
}
) {
success
message
overview {
workspace_id
name
state
creator {
id
}
}
}
}
{
"data": {
"update_overview_hierarchy": {
"success": true,
"message": "Overview position updated successfully",
"overview": {
"workspace_id": "-1",
"name": "New Dashboard",
"state": "1",
"creator": {
"id": "1234567890"
}
}
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Arguments
You can use the following argument(s) to define the updated dashboard's characteristics.
Argument | Description | Supported Fields |
---|---|---|
attributes UpdateOverviewHierarchyAttributes | The dashboard's updated position and location attributes. | account_product_id ID folder_id ID position DynamicPosition workspace_id ID |
overview_id ID! | The dashboard's unique identifier. |