Dashboards

Create a dashboard

Changed on

Create an empty dashboard in a space. The caller must have permission to create dashboards in the target space. New dashboards start active, and widgets are added separately.

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

post/v2/dashboards

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/dashboards
  • Auth
    HTTP bearer

Request body

space_idstring required

The ID of the space to create the dashboard in.

namestring required

The dashboard name. Leading and trailing whitespace is trimmed, and the trimmed name must be 1-255 characters.

timezonestring nullable

The timezone used to display dashboard data.

start_timestring date-time nullable

The start time for the dashboard's default time range, as an RFC 3339 timestamp. Required when time_range_key is custom.

end_timestring date-time nullable

The end time for the dashboard's default time range, as an RFC 3339 timestamp. Required when time_range_key is custom, and must not be earlier than start_time.

time_series_data_granularitystring

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

time_range_keystring

The dashboard's default time range. One of 15m, 1h, 12h, 1d, 7d, 14d, 1mo, 3mo, 6mo, or custom.

Response

Dashboard created

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