Widgets
The calling user's dashboard bar, home dashboard and computed widget metrics.
6 tools
# get_home_dashboard
Get the calling user's private home dashboard and its widget definitions, creating it on first use. Save changes with put_dashboard_widgets.
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
# pin_dashboard
Pin a dashboard to the calling user's dashboard bar, appended after their existing pins. Pins are per user and never grant access.
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
| dashboard_id | string | ● | Dashboard ID |
# unpin_dashboard
Remove the calling user's pin of a dashboard; the remaining pins close the gap.
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
| dashboard_id | string | ● | Dashboard ID |
# reorder_dashboard_pins
Rewrite the calling user's dashboard bar in one whole-set save. Put a dashboard first to make it their default — the home route opens the first pin.
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
| dashboard_ids | array | ● | Every pinned dashboard ID, in the new bar order |
# list_widget_types
The widget catalog: every widget type a dashboard accepts, with its label, description, default and minimum grid size, whether it takes the surface's timeframe, and its config keys with allowed values. Widget scope is a saved view, not a project — save a view whose query spans several projects and scope each widget to it to cover them all on one dashboard.
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
# get_widget_metrics
Compute metrics for a widget (cycle time, velocity, etc.)
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
| project_id | string | — | Project ID (empty=workspace-wide) |