> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard Tools

> MCP tools for querying saved report dashboards and their widget configurations

# Dashboard Tools

Query saved report dashboards — custom views with widgets that visualize sustainability metrics, emissions charts, pivot tables, and KPI trackers. Dashboards are linked to projects and contain configurable widgets.

## `list_dashboards`

List all dashboards saved for the organization.

**Parameters:**

| Parameter         | Type   | Required | Default     | Description       |
| ----------------- | ------ | -------- | ----------- | ----------------- |
| `organization_id` | string | No       | default org | Organization UUID |

**Example response:**

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
[
  {
    "id": "d1a2b3c4-...",
    "project_id": "p5e6f7a8-...",
    "widgets": [
      {
        "id": "w1",
        "name": "Scope 1 & 2 Emissions",
        "type": "chart",
        "config": {
          "metrics": [...],
          "periodicity": "monthly",
          "periods": [{"from": "2024-01", "to": "2024-12"}],
          "unit": "tCO2e"
        }
      }
    ],
    "layouts": {
      "lg": [{ "i": "w1", "x": 0, "y": 0, "w": 6, "h": 4 }]
    },
    "created_at": "2024-06-01T10:00:00",
    "updated_at": "2025-01-15T14:30:00"
  }
]
```

**Key response fields:**

| Field        | Description                                                        |
| ------------ | ------------------------------------------------------------------ |
| `project_id` | The project this dashboard belongs to                              |
| `widgets`    | List of widget objects with name, type, and configuration          |
| `layouts`    | Responsive grid layout positions per breakpoint (`lg`, `md`, `sm`) |

## `get_dashboard`

Get a specific dashboard by ID with its full widget configuration.

**Parameters:**

| Parameter         | Type   | Required | Default     | Description           |
| ----------------- | ------ | -------- | ----------- | --------------------- |
| `dashboard_id`    | string | **Yes**  | —           | UUID of the dashboard |
| `organization_id` | string | No       | default org | Organization UUID     |

### Widget Types

Widgets can visualize different data sources:

| Widget Config    | Description                                                              |
| ---------------- | ------------------------------------------------------------------------ |
| **Metrics**      | Emission charts with configurable metrics, periodicity, and time periods |
| **Custom KPI**   | Custom KPI visualizations linked to datasets and campaigns               |
| **Pivot Table**  | Tabular data views (carbon footprint, energy, water, logistics)          |
| **Shipment Map** | Geographic visualization of transport routes                             |
| **File**         | Embedded file display                                                    |

**Example prompts:**

```
"What dashboards do we have?"
"Show me our emissions overview dashboard"
"List all dashboards for this project"
"What widgets are configured in dashboard abc-123?"
"Show me the metrics tracked in our main dashboard"
```

## Workflow

1. **List dashboards** — `list_dashboards` to discover available dashboards
2. **Get details** — `get_dashboard` with the dashboard ID to see widget configurations
3. **Explore data** — Use the tools that feed the widgets: `get_greenhouse_gas_emissions` for emission metrics, `list_custom_kpis` for KPI data, `list_logistics_requests` for shipment maps

## Related

<CardGroup cols={2}>
  <Card title="Emissions" icon="smog" href="/mcp/emissions">
    GHG emissions data that powers dashboard charts
  </Card>

  <Card title="Custom KPIs" icon="chart-bar" href="/mcp/custom-kpis">
    Custom KPI definitions used in dashboard widgets
  </Card>

  <Card title="Projects" icon="folder" href="/mcp/projects">
    Projects that own dashboards
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/dashboards/overview">
    REST API endpoints for dashboards
  </Card>
</CardGroup>