The monday.com dashboards and widgets APIs enable you to create and update dashboards and widgets.

Each object type described below represents a specific part of a dashboard or widget. You can use these object types to supply metadata in mutations or to define which fields should be returned in your queries.

Dashboard

An object containing the result of creating a new dashboard via the API.

Field	Description	Enum Values
board_folder_id `Int`	The unique identifier of the folder the dashboard is in.
id `ID`	The dashboard's unique identifier.
kind `DashboardKind`	The dashboard's visibility.	`PRIVATE` `PUBLIC`
name `String`	The dashboard's name.
workspace_id `Int`	The unique identifier of the workspace the dashboard is in.

ExternalWidget

Supported ExternalWidgetenum values.

Enum Value	Description
`BATTERY`	The battery widget is used to track progress and completion status visualization.
`CHART`	The chart widget is used for visual data representation (e.g., pie charts, bar charts, column charts).
`NUMBER`	The number widget displays numeric metrics (e.g., sums, averages, counts, and totals).

UpdateOverviewHierarchy

An object containing the result of updating a dashboard's hierarchy via the API.

Field	Description	Supported Fields
message `String!`	A message about the operation's result.
overview `Overview`	The updated dashboard's metadata.	created_at `ISO8601DateTime` creator `User!` folder_id `ID` id `ID!` kind `String` name `String!` state `String!` updated_at `ISO8601DateTime` workspace_id `ID`
success `Boolean!`	Whether the operation was successful.

Overview

An object containing metadata about the updated dashboard.

Field	Description
created_at `ISO8601DateTime`	The dashboard's creation date.
creator `User!`	The unique identifier of the dashboard's creator.
folder_id `ID`	The unique identifier of the folder the dashboard is in.
id `ID!`	The unique identifier of the dashboard.
kind `String`	The dashboard's kind (private or public).
name `String!`	The dashboard's name.
state `String!`	The dashboard's state.
updated_at `ISO8601DateTime`	The dashboard's last updated date.
workspace_id `ID`	The unique identifier of the workspace the dashboard is in.

UpdateOverviewHierarchyAttributes

An object containing the updated dashboard hierarchy attributes.

Field	Description	Supported Fields
account_product_id `ID`	The unique identifier of the account to which the dashboard should be moved.
folder_id `ID`	The unique identifier of the folder to which the dashboard should be moved.
position `DynamicPosition`	The dashboard's position in the left pane.	is_after `Boolean` object_id `String!` object_type `ObjectType!`
workspace_id `ID`	The unique identifier of the workspace to which the dashboard should be moved.

DynamicPosition

An object containing attributes about the updated dashboard's left pane reference item.

Field	Description	Enum Values
is_after `Boolean`	Whether the target dashboard will be placed after the reference object.
object_id `String!`	The unique identifier of the object relative to which the target dashboard will be positioned (e.g., board ID, dashboard ID, folder ID).
object_type `ObjectType!`	The type of object used to reference where the target dashboard should be positioned in relation to.	`Board` `Folder` `Overview`

WidgetModel

An object containing the result of creating a new widget via the API.

Field	Description	Supported Fields
id `Int`	The new widget's unique identifier.
kind `ExternalWidget`	The new widget's type.
name `String`	The new widget's name.
parent `WidgetParentOutput`	An object containing metadata about the widget's parent container.	id `Int` kind `WidgetParentKind`

WidgetParentOutput

An object containing the widget's parent properties.

Field	Description	Enum Values
id `Int`	The unique identifier of the parent dashboard or board view.
kind `WidgetParentKind`	The type of parent container.	`BOARD_VIEW` `DASHBOARD`

WidgetParentKind

Supported WidgetParentKindenum values.

Enum Value	Description
`BATTERY`	The battery widget is used to track progress and completion status visualization.
`CHART`	The chart widget is used for visual data representation (e.g., pie charts, bar charts, column charts).
`NUMBER`	The number widget displays numeric metrics (e.g., sums, averages, counts, and totals).

WidgetParentInput

An object containing the widget's parent properties.

Field	Description	Enum Values
id `Int!`	The unique identifier of the parent dashboard or board view.
kind `WidgetParentKind!`	The type of parent container.	`BOARD_VIEW` `DASHBOARD`