Skip to main content
POST
Create a dashboard

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

Body

application/json

Body containing dashboard creation parameters

space_id
string
required

The ID of the space to create the dashboard in.

name
string
required

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

timezone
string | null

The timezone used to display dashboard data.

start_time
string<date-time> | null

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

end_time
string<date-time> | null

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_granularity
string | null

The granularity used to display time series data.

time_range_key
string

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

Response

Dashboard created

A dashboard groups charts, statistics, text, and tables to help you monitor and analyze your application data. The response includes published widgets only.

id
string
required

The dashboard ID.

space_id
string
required

The space ID the dashboard belongs to.

name
string
required

The dashboard name.

status
enum<string>
required

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

Available options:
ACTIVE,
INACTIVE,
DELETED
time_range_key
string
required

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

created_at
string<date-time>
required

When the dashboard was created.

creator_user_id
string
required

The ID of the user who created the dashboard.

tags
object[]
required

Tags applied to the dashboard.

widgets
object[]
required

Summaries of the published widgets on the dashboard. Full widget configuration is available from GET /v2/dashboards/{dashboard_id}/widgets/{widget_id} (get_dashboard_widget).

timezone
string | null

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

start_time
string<date-time> | null

The dashboard start time.

end_time
string<date-time> | null

The dashboard end time.

time_series_data_granularity
string | null

The dashboard time series data granularity.