# Dashboard

```{eval-rst}
.. autoclass:: ab.api.endpoints.dashboard.DashboardEndpoint
   :members:
   :undoc-members:
```

## Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the
Python and CLI call signatures, and the request/response model field tables.
This is the page `help(api.dashboard.<method>)` links to via its `Docs:` footer.
These pages are generated by `scripts/generate_endpoint_docs.py` and kept
current by a CI freshness gate.

```{toctree}
:maxdepth: 1
:glob:

dashboard/*
```


## Methods

### get

`GET /dashboard` — Aggregated dashboard summary.

**Returns:** {class}`~ab.api.models.dashboard.DashboardSummary`

```python
summary = api.dashboard.get()
print(summary.inbound_count, summary.outbound_count)
```

### get_grid_views

`GET /dashboard/gridviews` — List available grid views.

**Returns:** `list[`{class}`~ab.api.models.dashboard.GridViewInfo`]`

### get_grid_view_state / save_grid_view_state

`GET/POST /dashboard/gridviewstate/{id}` — Read/save grid view state.

**Returns:** {class}`~ab.api.models.dashboard.GridViewState`

### inbound / in_house / outbound / local_deliveries / recent_estimates

`POST /dashboard/{panel}` — Operational panel data.

```python
data = api.dashboard.inbound()
```