# Dashboard endpoints (Client API: account)

> 3 FeatherPanel Client API: account endpoints from user/dashboard.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Source: https://featherpanel.com/docs/api/reference/user/dashboard/

Defined in [`backend/app/routes/user/dashboard.php`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/dashboard.php). Authentication used here: **Signed-in user**. Read [Authentication](https://featherpanel.com/docs/api/authentication/) for how to send credentials and [Rate limits and errors](https://featherpanel.com/docs/api/rate-limits-and-errors/) for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

## Endpoints

### GET `/api/user/dashboard/overview`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`user-dashboard`)
- Route name: `user-dashboard-overview`
- Controller: [`DashboardOverviewController::overview`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Dashboard/DashboardOverviewController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/dashboard.php#L27)

**Dashboard overview** Aggregated usage, status, backups and schedules across the servers the current user can access.

```bash
curl -X GET "$PANEL_URL/api/user/dashboard/overview" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

Responses: `200` Overview retrieved · `401` Unauthorized

### GET `/api/user/dashboard/default-layout`

- Auth: Signed-in user
- Default rate limit: 30 / minute (`user-dashboard`)
- Route name: `user-dashboard-default-layout`
- Controller: [`DashboardDefaultLayoutController::show`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Dashboard/DashboardDefaultLayoutController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/dashboard.php#L39)

**Get the panel default dashboard layout**

```bash
curl -X GET "$PANEL_URL/api/user/dashboard/default-layout" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

Responses: `200` Default layout or null

### GET `/api/user/dashboard/resource-history`

- Auth: Signed-in user
- Default rate limit: 20 / minute (`user-dashboard-history`)
- Route name: `user-dashboard-resource-history`
- Controller: [`ResourceHistoryController::dashboard`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Dashboard/ResourceHistoryController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/dashboard.php#L51)

**Resource history for the dashboard** Five minute CPU, memory and disk samples over the last 24 hours for every server the user owns or is a subuser on, plus totals per sample.

```bash
curl -X GET "$PANEL_URL/api/user/dashboard/resource-history" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

Responses: `200` History retrieved · `401` Unauthorized