Dashboards

List dashboard widgets

Changed on

List the widgets on a dashboard as summaries (id, title, type, and parent dashboard). Use Get a 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.</Note>

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

Path parameters

dashboard_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The Relay global ID of the dashboard.

Query parameters

type'LINE_CHART' | 'BAR_CHART' | 'STATISTIC' | 'TEXT' | 'PIVOT_TABLE' | 'EXPERIMENT_CHART'

The kind of dashboard widget and the configuration shape it uses.

Filter widgets by type, for example LINE_CHART. If omitted, widgets of every type are returned.

creation_status'DRAFT' | 'PUBLISHED'

Whether the widget is still being edited or is available in the dashboard.

Filter widgets by creation status, either DRAFT or PUBLISHED. Defaults to PUBLISHED if omitted.

limitinteger

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

cursorstring

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.

Example response

{
  "widgets": [
    {
      "id": "RW50aXR5OjEyMzQ1"
    }
  ]
}

Changes