ARarize-ai
Dashboards

Get a dashboard

Changed on

Get a dashboard by its ID. The dashboard includes its tags and published widget summaries.

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

get/v2/dashboards/{dashboard_id}

Request

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

Response

Returns a dashboard with its tags and published widgets.

idstring required

The dashboard ID.

space_idstring required

The space ID the dashboard belongs to.

namestring required

The dashboard name.

status'ACTIVE' | 'INACTIVE' | 'DELETED' required

The dashboard status. Values are ACTIVE, INACTIVE, or DELETED.

timezonestring nullable

Saved timezone for the dashboard; null means clients use the viewer's local timezone.

start_timestring date-time nullable

The dashboard start time.

end_timestring date-time nullable

The dashboard end time.

time_series_data_granularitystring

The dashboard's time series data granularity, such as hour or day.

time_range_keystring required

The dashboard time range key, such as 7d or custom.

created_atstring date-time required

When the dashboard was created.

creator_user_idstring required

The ID of the user who created the dashboard.

Example response

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

Changes