Dashboards tools
- list_dashboards: List the dashboards visible in a project.
- get_dashboard: Get the full layout and components of a dashboard.
list_dashboards
Lists every dashboard visible in a project. Dashboards aggregate multiple analyses into a single page view. The response gives you the name, shared flag, home flag, archived flag, and metadata.
The list is user-scoped — what's returned reflects what the authenticated user has access to. Component layouts are not included here — use get_dashboard for those.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
Response parameters
The tool returns a DashboardsResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | list[DashboardSummary] | The dashboard summaries. |
error | str | null | Error message if the request failed. |
The DashboardSummary object has the following fields:
| Field | Type | Description |
|---|---|---|
id | str | The dashboard's unique ID. |
name | str | The dashboard's display name. |
archived | bool | Whether the dashboard has been archived. |
shared | bool | Whether the dashboard is shared with other users. |
home | bool | Whether the dashboard is set as the project home page. |
created | any | null | Unix timestamp of when the dashboard was created. |
created_by_display_name | str | null | Display name of the creator. |
edited | any | null | Unix timestamp of the last edit. |
edited_by_display_name | str | null | Display name of the last editor. |
get_dashboard
Returns the full definition of a single dashboard, including every component configuration (embedded analyses, HTML blocks, images, and so on) in display order.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
dashboard_id | str | Yes | The dashboard ID returned by list_dashboards. |
Response parameters
The tool returns a DashboardResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | Dashboard | null | The full dashboard definition with all components. |
error | str | null | Error message if the request failed. |
The Dashboard object adds the following field on top of the summary record:
| Field | Type | Description |
|---|---|---|
components | list[any] | The dashboard component definitions (analyses, HTML, images, and so on) in display order. Each component has a type, a config, and a layout. |
Updated about 1 hour ago
