Dashboards

Get a dashboard widget

Changed on

Get a widget, including its saved configuration, from a dashboard. Draft and published widgets can be read. The widget must belong to the specified dashboard, and the caller must have permission to read that dashboard.

<Note>This endpoint is in beta, read more here.</Note>

get/v2/dashboards/{dashboard_id}/widgets/{widget_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/dashboards/{dashboard_id}/widgets/{widget_id}
  • 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.

widget_idstring required

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

Example:RW50aXR5OjEyMzQ1

The Relay global ID of the widget.

Response

Returns one dashboard widget with its type-specific configuration.

OR
OR
OR
OR
OR

Example response

{
  "id": "RW50aXR5OjEyMzQ1",
  "dashboard_id": "RW50aXR5OjEyMzQ1",
  "creator_user_id": "RW50aXR5OjEyMzQ1",
  "plots": [
    {
      "id": "RW50aXR5OjEyMzQ1",
      "model_version_ids": [
        "RW50aXR5OjEyMzQ1"
      ],
      "model_version_environment_metadata_ids": [
        "RW50aXR5OjEyMzQ1"
      ]
    }
  ],
  "monitor_id": "RW50aXR5OjEyMzQ1"
}

Changes