---
title: "Get dashboard widgets"
type: reference
method: GET
path: /rest-api/dashboard/widgets.do
tag: "Dashboard"
---

# Get dashboard widgets

`GET https://YOUR-NETWORK-DOMAIN/rest-api/dashboard/widgets.do`

Returns the authenticated user's own dashboard, as the console's Dashboard page shows it: every widget with its id, stored title, the title as displayed in the user's language, type (TABLE, LINE_CHART, PIE_CHART, BAR_CHART or NOTICE), column x and row y (sorted by x, then y). A NOTICE widget carries its text in 'value'; every other widget carries its report definition in 'data' - statisticType, choosenMetric, range, customFrom/customTo, groupRange, groupBy, eqLong, eqStr and the rest - the same fields /widget/create and /widget/update take as data.*. No report is run: to get a widget's figures, run the analytics API with its data. Requires the Dashboard tab permission, like the console page.

## Responses

- `200` — {success:true, widgets:[{id, title, displayTitle, type, x, y, value | data}]}
- `400` — Bad request — invalid or missing parameters
- `401` — Unauthorized - authentication error
- `403` — The user's role has no Dashboard tab

## Example request

```bash
curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/dashboard/widgets.do' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

Source: https://epom.com/ad-server/docs/api/dashboard/get-dashboard-widgets