Skip to main content
GET
List dashboard widgets

Authorizations

Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

dashboard_id
string
required

The Relay global ID of the dashboard. A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Query Parameters

type
enum<string>

Filter widgets by type, for example LINE_CHART. If omitted, widgets of every type are returned. The kind of dashboard widget and the configuration shape it uses.

Available options:
LINE_CHART,
BAR_CHART,
STATISTIC,
TEXT,
PIVOT_TABLE,
EXPERIMENT_CHART
creation_status
enum<string>

Filter widgets by creation status, either DRAFT or PUBLISHED. Defaults to PUBLISHED if omitted. Whether the widget is still being edited or is available in the dashboard.

Available options:
DRAFT,
PUBLISHED
limit
integer
default:50

Maximum items to return. Defaults to 50 if omitted; maximum is 100.

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

Response

Returns a list of widget summaries for the dashboard.

widgets
object[]
required

A list of widget summaries.

pagination
object
required

Pagination metadata for cursor-based navigation