---
title: "List dashboard widgets"
method: GET
path: "/v2/dashboards/{dashboard_id}/widgets"
tags: ["Dashboards"]
---

# List dashboard widgets

`GET /v2/dashboards/{dashboard_id}/widgets`

## Request

- Base URL: `https://api.arize.com`
- URL: `https://api.arize.com/v2/dashboards/{dashboard_id}/widgets`
- Auth: HTTP bearer

List the widgets on a dashboard as summaries (id, title, type, and parent
dashboard). Use [Get a dashboard widget](#tag/Dashboards/operation/get_dashboard_widget)
to retrieve a widget's full configuration. The caller must have permission to
read the dashboard.

Only published widgets are returned by default. Set `creation_status` to
`DRAFT` to list draft widgets instead. Use `type` to return only widgets of one
type. Results use cursor-based pagination.

<Note>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Note>

## Path parameters

- `dashboard_id` string, required: A universally unique identifier (base64-encoded opaque string).

## Query parameters

- `type` 'LINE_CHART' | 'BAR_CHART' | 'STATISTIC' | 'TEXT' | 'PIVOT_TABLE' | 'EXPERIMENT_CHART': The kind of dashboard widget and the configuration shape it uses.
- `creation_status` 'DRAFT' | 'PUBLISHED': Whether the widget is still being edited or is available in the dashboard.
- `limit` integer
- `cursor` string

## Response `200`

Returns a list of widget summaries for the dashboard.

- ListDashboardWidgetsResponse
  - `widgets` WidgetSummary[], required: A list of widget summaries.
    - `id` string, required: A universally unique identifier (base64-encoded opaque string).
    - `title` string, required: Display title of the widget.
    - `type` 'LINE_CHART' | 'BAR_CHART' | 'STATISTIC' | 'TEXT' | 'PIVOT_TABLE' | 'EXPERIMENT_CHART', required: The kind of dashboard widget and the configuration shape it uses.
    - `grid_position` integer[], required: Widget position and size as [x, y, width, height].
  - `pagination` PaginationMetadata, required: Cursor-based pagination metadata. Use `next_cursor` in the subsequent request's `cursor` query parameter.
    - `next_cursor` string: Opaque cursor for fetching the next page. Treat as an unreadable token. Present when `has_more` is true; omitted when `has_more` is false.
    - `has_more` boolean, required: True if another page of results is available.

## Other responses

- `400`: Invalid request
- `401`: Authentication is required
- `403`: Insufficient permissions to access this resource
- `404`: Not found
- `429`: Rate limit exceeded

## Changes

> 48 revisions in range; 1 not diffed.

- **2026-10-27** `6f9c7e093512`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/arize-ai/apis/arize-rest-api/changes/v2/dashboards/:dashboard_id/widgets/get.md)

---

[API](https://skmtc.dev/arize-ai/apis/arize-rest-api.md) - [All operations](https://skmtc.dev/arize-ai/apis/arize-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/arize-ai/apis/arize-rest-api/revisions/22ad4acd3cbb?raw)