# Dashboards API

> List, create, fetch dashboards and set their tile layout under /api/dashboards.

*[View this page in the Flax docs](https://flax-analytics.com/docs/api-reference/dashboards)*

The dashboards endpoints manage laid-out collections of charts. Reads need the
`read` scope; creating and changing layout need `write`.

## List dashboards

`GET /api/dashboards` — return the dashboards the service account can read.

## Create a dashboard

`POST /api/dashboards` — create an empty dashboard. Requires the `write` scope.

```bash
curl https://flax-analytics.com/api/dashboards \
  -H "Authorization: Bearer flax_pat_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Executive overview" }'
```

## Get a dashboard

`GET /api/dashboards/{dashboardId}` — fetch a dashboard and its tiles by id.

## Set the layout

`PUT /api/dashboards/{dashboardId}/layout` — replace the dashboard's tile layout.
Each tile references a chart and its grid position. Requires the `write` scope.

```json
{
  "tiles": [
    { "chartId": "cht_123", "x": 0, "y": 0, "w": 6, "h": 4 },
    { "chartId": "cht_456", "x": 6, "y": 0, "w": 6, "h": 4 }
  ]
}
```

## Related

- [Dashboards](/docs/visualizations/dashboards)
- [Interactivity](/docs/visualizations/interactivity)