> For the complete documentation index, see [llms.txt](https://docs.biobox.io/guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.biobox.io/guide/how-to/ask-biobox-with-claude/tools/get-dashboard.md).

# get\_dashboard — Get dashboard

Get dashboard

Get dashboard

## What it does

Fetch one dashboard by its uuid and return its widgets — each widget's name, description, type, position, and the BxQL query that produces its data.

**When to use:** you have a dashboard uuid (from list\_dashboards / list\_object\_dashboards) and want to see what widgets it contains; the user asks what a specific dashboard shows, or how a widget is defined (its query); you need a widget's uuid (to fetch that widget's underlying data next with get\_widget\_data using its widget.uuid) or its query (BxQL).

**When NOT to use:** you only have a dashboard NAME, not a uuid — find it with list\_dashboards first; you want the list of ALL dashboards, or the dashboards pinned on an object (use list\_dashboards / list\_object\_dashboards); you want a widget's ACTUAL data rows — use get\_widget\_data with the widget.uuid.

**Parameters:**

* `dashboardId` — the dashboard's uuid (from a list\_dashboards / list\_object\_dashboards row). A uuid that resolves to no dashboard returns a 404 Not Found error.
* `includeConfig` — optional (default false). When true, include each widget's opaque `config` JSON (per-widget rendering config, can be several KB). Off by default to keep the response small; the agent rarely needs it.

**Returns:** The dashboard detail, flat at the root: uuid, displayName, description (or null), dateCreated, dateUpdated, widgetCount, and widgets — an array sorted by position ascending. Each widget has: uuid (feed to get\_widget\_data using its widget.uuid to get its rows), displayName, description (a natural-language explanation of the widget's query), type (a free-form kind, e.g. "data-table", "scatter-plot"), position, and query (the widget's BxQL spec — the query that produces its data; may be null/empty for custom widgets). Each widget also carries config ONLY when includeConfig:true. A dashboardId that resolves to no dashboard returns a 404 Not Found error (isError) naming the missing id.

## Parameters

| Parameter       | Type    | Required | Description                                                                                                                                                                                             |
| --------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `dashboardId`   | string  | yes      | the dashboard's uuid (from a list\_dashboards / list\_object\_dashboards row). A uuid that resolves to no dashboard returns a 404 Not Found error.                                                      |
| `includeConfig` | boolean | no       | optional (default false). When true, include each widget's opaque `config` JSON (per-widget rendering config, can be several KB). Off by default to keep the response small; the agent rarely needs it. |

## Response

```ts
{
  uuid: string;
  displayName: string | null;
  description: string | null;
  dateCreated: string | null;
  dateUpdated: string | null;
  widgets: Array<{
    uuid: string;
    displayName: string | null;
    description: string | null;
    type: string | null;
    position: number | null;
    query: string | null;
    config?: unknown;
  }>;
  widgetCount: number;
}
```

## Example

```json
// get_dashboard({"dashboardId":"G6RxOsORHHGfjl9nALAZK"})
{
  "dashboardId": "G6RxOsORHHGfjl9nALAZK"
}
```

Response (arrays truncated):

```json
{
  "uuid": "G6RxOsORHHGfjl9nALAZK",
  "displayName": "MTOR Target Dashboard",
  "description": "Multi-Omic Target Profiling",
  "dateCreated": "2025-06-12T19:13:06.929Z",
  "dateUpdated": "2026-01-20T18:16:42.068Z",
  "widgets": [
    {
      "uuid": "mIEQlYNQt1W8AamykZpBL",
      "displayName": "DepMap Gene Dependency",
      "description": "The query is looking to identify instances where a gene labeled \"MTOR\" has a dependency relationship with cell lines that model a particular disease, specifically targeting cell lines that exhibit neg…",
      "type": "data-table",
      "position": 0,
      "query": "(g:Gene { displayName=\"MTOR\" })<- has dependency { effect_score < 0  &  dependency_score > 0.5 } <-(c:CellLine)-> models disease ->(d:Disease)"
    },
    {
      "uuid": "eyCyoWFXcKYHRJwCHDiXb",
      "displayName": "Clinical Trial & Drug Interventions",
      "description": "This query aims to identify a specific drug, represented by the node `d:Drug`, that acts on the gene \"MTOR\" (`g:Gene`). It also links this drug to clinical trials (`c:ClinicalTrial`) that study a cond…",
      "type": "data-table",
      "position": 1,
      "query": "(g:Gene { displayName=\"MTOR\" })<- acts on <-(d:Drug)<- using the drug <-(c:ClinicalTrial)-> studies condition ->(d2:Disease)"
    },
    {
      "uuid": "mLPPyT5ju7Rq0OAf_-yb-",
      "displayName": "OpenTargets Genetics",
      "description": "The query is attempting to retrieve information about the gene \"MTOR\" and its relationship with a variant association, specifically looking for associations that link the variant to a trait affecting …",
      "type": "data-table",
      "position": 2,
      "query": "(g:Gene { displayName=\"MTOR\" })<- has association <-(v:VariantAssociation)-> of trait ->(d:Disease)"
    },
    "… 7 more"
  ],
  "widgetCount": 10
}
```