Learn about other types supported by the dashboards and widgets APIs
The monday.com dashboards and widgets APIs enable you to create, update, and delete dashboards/widgets.
The types below are used by the dashboards and widgets queries and mutations, and are not independently queryable.
Dashboard
An object containing the result of creating a new dashboard via the API.
| Field | Type | 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. | PRIVATEPUBLIC |
| 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 |
|---|---|
APP_FEATURE | App feature widgets for embedding custom app functionality in dashboards. (version 2026-04 and later) |
BATTERY | The battery widget is used to track progress and visualize completion status. |
CHART | The chart widget is used to visualize data (e.g., pie charts, bar charts, column charts). |
LISTVIEW | Cross-board items displayed in a tabular list format with filtering and sorting. (version 2026-04 and later) |
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 | Type | Description | Supported Fields |
|---|---|---|---|
| message | String! | A message about the operation's result. | |
| overview | Overview | The updated dashboard's metadata. | created_at ISO8601DateTimecreator User!folder_id IDid ID!kind Stringname String!state String!updated_at ISO8601DateTimeworkspace_id ID |
| success | Boolean! | Whether the operation was successful. |
Overview
An object containing metadata about the updated dashboard.
| Field | Type | 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 | Type | Description |
|---|---|---|
| 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. |
| 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 | Type | 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. | BoardFolderOverview |
WidgetModel
An object containing the result of creating a new widget via the API.
| Field | Type | Description |
|---|---|---|
| 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. |
WidgetParentOutput
An object containing the widget's parent properties.
| Field | Type | Description | Enum Values |
|---|---|---|---|
| id | Int | The unique identifier of the parent dashboard or board view. | |
| kind | WidgetParentKind | The type of parent container. | BOARD_VIEWDASHBOARD |
WidgetParentKind
Supported WidgetParentKindenum values.
| Enum Value | Description |
|---|---|
BATTERY | The battery widget is used to track progress and visualize completion status. |
CHART | The chart widget is used for visualizing data (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 | Type | Description | Enum Values |
|---|---|---|---|
| id | Int! | The unique identifier of the parent dashboard or board view. | |
| kind | WidgetParentKind! | The type of parent container. | BOARD_VIEWDASHBOARD |