Skip to main content
POST
Create a dashboard widget

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

Service accounts may instead present an access token issued by an external identity provider (Microsoft Entra ID) when the account admin has configured that provider. Send it in the same header: Authorization: Bearer <access-token>.

Path Parameters

dashboard_id
string
required

The Relay global ID of the dashboard. A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing dashboard widget creation parameters.

Request to create a dashboard widget with its type-specific configuration.

type
enum<string>
required

Widget type. Must be LINE_CHART.

Available options:
LINE_CHART
title
string
required

Display title of the widget.

time_series_metric_type
string
required

Category of the metric displayed, for example modelDataMetric.

grid_position
integer[]

Widget position as [rowStart, colStart, rowEnd, colEnd]. The next available position is used when omitted.

Required array length: 4 elements
Required range: x >= 1
creation_status
enum<string>

Whether the widget is created as a draft or published. Defaults to PUBLISHED.

Available options:
DRAFT,
PUBLISHED
widget_type
enum<string>

Visualization mode of the line chart.

Available options:
LINE,
DRIFT,
MONITOR,
SCATTER
plots
object[]

Metric series displayed by the chart.

monitor_id
string

ID of the monitor displayed. Used by monitor-type line charts.

y_min
number | null

Lower bound of the y axis. The axis range is automatic when omitted.

y_max
number | null

Upper bound of the y axis. The axis range is automatic when omitted.

y_axis_label
string | null

Label displayed on the y axis.

x_axis_label
string | null

Label displayed on the x axis.

x_axis_tilt
string | null

Rotation applied to the x axis labels.

font_size
string | null

Font size used for chart text.

show_legend
boolean | null

Whether the chart legend is displayed.

legend_placement
string | null

Position of the chart legend.

timezone
string | null

IANA timezone used to interpret the time range, for example America/Los_Angeles.

start_time
string<date-time> | null

Start of a custom time range. Used with end_time when the widget overrides the dashboard time range.

end_time
string<date-time> | null

End of a custom time range. Used with start_time when the widget overrides the dashboard time range.

time_series_data_granularity
string | null

Granularity of the time series buckets, for example hour or day.

overwrite_global_time
boolean | null

Whether the widget uses its own time range instead of the dashboard time range.

time_range_key
string | null

Relative time range key, for example 7d, or custom to use start_time and end_time.

Response

Returns one dashboard widget with its type-specific configuration.

A dashboard widget and its type-specific saved configuration.

id
string
required

Unique identifier for the widget.

Example:

"RW50aXR5OjEyMzQ1"

type
enum<string>
required

Identifies this widget as a line chart.

Available options:
LINE_CHART
dashboard_id
string
required

Unique identifier for the dashboard containing the widget.

Example:

"RW50aXR5OjEyMzQ1"

title
string
required

Display title of the widget.

grid_position
integer[]
required

Position and size of the widget in the dashboard grid.

Required array length: 4 elements
Required range: x >= 1
creation_status
enum<string>
required

Publication state of the widget.

Available options:
DRAFT,
PUBLISHED
created_at
string<date-time>
required

Timestamp when the widget was created.

creator_user_id
string
required

Unique identifier for the user who created the widget.

Example:

"RW50aXR5OjEyMzQ1"

widget_type
enum<string>
required

Visualization mode used by the chart.

Available options:
LINE,
DRIFT,
MONITOR,
SCATTER
plots
object[]
required

Metric series displayed by the widget.

time_series_metric_type
string
required

Metric used to compute the time series.

monitor_id
string

Monitor represented by the widget when using the monitor chart mode.

Example:

"RW50aXR5OjEyMzQ1"

y_min
number | null

Minimum value displayed on the y-axis, or null for automatic scaling.

y_max
number | null

Maximum value displayed on the y-axis, or null for automatic scaling.

y_axis_label
string | null

Custom y-axis label, or null to use the default.

x_axis_label
string | null

Custom x-axis label, or null to use the default.

x_axis_tilt
string | null

Saved rotation setting for x-axis labels.

font_size
string | null

Saved chart font-size setting.

show_legend
boolean | null

Whether the legend is shown, or null to use the default.

legend_placement
string | null

Saved placement of the chart legend.

timezone
string | null

Timezone used to display time-series values.

start_time
string<date-time> | null

Widget-specific range start, or null when the dashboard range applies.

end_time
string<date-time> | null

Widget-specific range end, or null when the dashboard range applies.

time_series_data_granularity
string | null

Saved aggregation interval for the time series.

overwrite_global_time
boolean | null

Whether this widget uses its own time range instead of the dashboard range.

time_range_key
string | null

Saved relative time-range selection.