> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a dashboard widget
> 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.
This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).
## OpenAPI
````yaml https://api.arize.com/v2/spec.yaml get /v2/dashboards/{dashboard_id}/widgets/{widget_id}
openapi: 3.0.3
info:
title: Arize REST API
version: 2.0.0
description: |
API specification for the backend data server. The API is hosted globally
at https://api.arize.com/v2 or in your own environment.
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- description: Global
url: https://api.arize.com
- description: Regional
url: https://api.{region}.arize.com
variables:
region:
default: eu-west-1a
enum:
- eu-west-1a
- ca-central-1a
- description: Custom Host
url: https://{host}
variables:
host:
default: api.arize.com
security:
- bearerAuth: []
tags:
- name: AI Integrations
description: |
AI integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the
entire account, a specific organization, or a specific space.
- name: Alignment
description: >
Alignment measures agreement between evaluator labels and human
annotations.
Tasks define the dataset columns and comparison function. Runs record the
resulting score for a dataset version.
- name: Annotation Configs
description: >
Annotation configs allow you to define consistent annotation schemas that
can be reused across your workspace, ensuring evaluations are structured
and
comparable over time.
- name: Annotation Queues
description: >
Annotation queues help you organize and manage human evaluation workflows.
Use queues to assign spans or examples to annotators for review and
labeling.
- name: API Keys
description: >
API keys are used to authenticate requests to the Arize API. List your
keys
to view metadata; the raw secret is never returned after creation.
- name: Audit Logs
description: >
Audit logs record authenticated user actions within an account, providing
a
chronological trail for security and compliance review. Access requires
account admin privileges and audit logging to be enabled.
- name: Dashboards
description: >
Dashboards organize charts and summaries that help teams understand their
data.
- name: Datasets
description: |
Datasets are structured, version-controlled example collections you use to
run, evaluate, and track LLM experiments.
- name: Evaluators
description: >
Evaluators are reusable evaluation configurations used to assess the
quality
of LLM outputs. They can be template-based (using LLM judges) or
code-based.
- name: Experiments
description: >
Experiments let you systematically test prompt/model changes using
datasets,
tasks, and evaluators.
- name: Integrations
description: >
Integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI), notifications services (e.g.
PagerDuty, Slack), and
your own agents. Integrations can be scoped to the entire account, a
specific
organization, or a specific space.
- name: Monitors
description: >
Monitors continuously track a metric over your model or LLM application
data
and alert you when it crosses a threshold. Each monitor watches a single
metric - data quality, model performance, drift, a custom metric, or a
tracing metric - and moves between statuses as the metric passes in and
out of its
healthy range.
- name: Organizations
description: >
Organizations are top-level containers within an Arize AX account for
grouping spaces.
- name: Projects
description: |
Projects represent LLM applications being monitored in Arize where you can
observe traces and spans.
- name: Prompts
description: >
Prompts are reusable, versioned templates for LLM interactions. Use
prompts
to standardize and manage how you interact with LLMs across your
application.
- name: Resource Restrictions
description: |
Endpoints for restricting and unrestricting resources (projects, models).
- name: Role Bindings
description: |
Role bindings assign a role to a user on a resource. REST currently
supports space- and project-scoped bindings.
- name: Roles
description: >
Roles define sets of permissions that can be assigned to users within an
account. Create custom roles to tailor access control to your team's
needs.
- name: SAML
description: Enterprise account-admin SAML configuration and role mappings.
- name: Spaces
description: >
Spaces are containers within an organization for grouping related
projects,
datasets, and experiments, enabling collaboration or isolated
experimentation
with role-based access control.
- name: Spans
description: |
Spans represent individual operations within a trace. A span captures the
timing, status, and attributes of a single operation in your application.
- name: Tags
description: |
Tags are reusable labels defined once per space and attached to resources
across the platform, so the same vocabulary can be applied to projects,
datasets, prompts, and more. Tags are shared: renaming or deleting a tag
affects every resource it is attached to.
- name: Tasks
description: |
Tasks are configurable units of work that tie one or more evaluators to a
data source (project or dataset). Use tasks to automate evaluation of LLM
outputs, with support for continuous evaluation and backfill runs.
- name: Traces
description: |
A trace is the collection of spans sharing a trace ID, representing a
single end-to-end request through an LLM application. Use the Traces
endpoint to retrieve traces with all of their spans in one call.
- name: Users
description: >
Users represent members of an account. The Users endpoints allow creating,
listing, updating (display name), and removing users from the account
programmatically.
- name: Webhooks
description: >
Webhooks are organization-owned destinations that receive event deliveries
over HTTPS. Deliveries are authenticated with a bearer token or signed
with
an HMAC signing secret — the secret is returned exactly once, when the
webhook is created. Delivery attempts are recorded and can be listed for
debugging. To choose which events a webhook receives, manage its
subscriptions through the prompt and evaluator webhook-subscription
endpoints.
paths:
/v2/dashboards/{dashboard_id}/widgets/{widget_id}:
get:
tags:
- Dashboards
summary: Get a dashboard widget
description: >
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.
This endpoint is in beta, read more
[here](https://arize.com/docs/ax/rest-reference#api-version-stages).
operationId: get_dashboard_widget
parameters:
- $ref: '#/components/parameters/DashboardIdPathParam'
- $ref: '#/components/parameters/WidgetIdPathParam'
responses:
'200':
$ref: '#/components/responses/Widget'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
components:
parameters:
DashboardIdPathParam:
name: dashboard_id
in: path
description: The Relay global ID of the dashboard.
required: true
schema:
$ref: '#/components/schemas/Id'
example: RGFzaGJvYXJkOjEyMzQ1
WidgetIdPathParam:
name: widget_id
in: path
description: The Relay global ID of the widget.
required: true
schema:
$ref: '#/components/schemas/Id'
example: TGluZUNoYXJ0V2lkZ2V0OjEyMzQ1
responses:
Widget:
description: Returns one dashboard widget with its type-specific configuration.
content:
application/json:
schema:
$ref: '#/components/schemas/Widget'
examples:
text_widget:
summary: Text widget
value:
id: VGV4dFdpZGdldDoxMjM=
type: TEXT
dashboard_id: RGFzaGJvYXJkOjQ1Ng==
title: Investigation notes
grid_position:
- 0
- 0
- 4
- 2
creation_status: PUBLISHED
created_at: '2026-10-21T17:00:00Z'
creator_user_id: VXNlcjo3ODk=
content: |-
## Findings
Review the latest evaluation results.
BadRequest:
description: Invalid request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 400
title: Invalid request parameters
detail: The 'name' field is required and must be a non-empty string.
instance: /resource
type: https://arize.com/docs/ax/rest-reference/errors#invalid-request
Unauthorized:
description: Authentication is required
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 401
title: Authentication required
detail: You must be authenticated to access this resource.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#authentication-required
Forbidden:
description: Insufficient permissions to access this resource
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 403
title: Access forbidden
detail: You do not have permission to access this resource.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#access-forbidden
NotFound:
description: Not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 404
title: Resource not found
detail: The requested resource with ID '12345' was not found.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#resource-not-found
RateLimitExceeded:
description: Rate limit exceeded
headers:
Retry-After:
description: |
When throttled (429), how long to wait before retrying. Value is
either a delta-seconds integer.
schema:
type: integer
minimum: 0
example: 42
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 429
title: Rate limit exceeded
detail: >-
You have exceeded the allowed number of requests. Please try again
later.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded
schemas:
Id:
type: string
description: A universally unique identifier (base64-encoded opaque string).
example: RW50aXR5OjEyMzQ1
Widget:
description: A dashboard widget and its type-specific saved configuration.
oneOf:
- $ref: '#/components/schemas/LineChartWidget'
- $ref: '#/components/schemas/BarChartWidget'
- $ref: '#/components/schemas/StatisticWidget'
- $ref: '#/components/schemas/TextWidget'
- $ref: '#/components/schemas/PivotTableWidget'
- $ref: '#/components/schemas/ExperimentChartWidget'
discriminator:
propertyName: type
mapping:
LINE_CHART: '#/components/schemas/LineChartWidget'
BAR_CHART: '#/components/schemas/BarChartWidget'
STATISTIC: '#/components/schemas/StatisticWidget'
TEXT: '#/components/schemas/TextWidget'
PIVOT_TABLE: '#/components/schemas/PivotTableWidget'
EXPERIMENT_CHART: '#/components/schemas/ExperimentChartWidget'
Problem:
type: object
description: RFC 9457 Problem Details
properties:
title:
type: string
description: A short, human-readable summary of the problem type
status:
type: integer
description: >-
The HTTP status code generated by the origin server for this
occurrence of the problem
type:
type: string
format: uri-reference
description: A URI reference that identifies the problem type
detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the
problem
instance:
type: string
format: uri-reference
description: >-
A URI reference that identifies the specific occurrence of the
problem
required:
- title
- status
additionalProperties: false
x-forward-compatible: true
LineChartWidget:
type: object
required:
- id
- type
- dashboard_id
- title
- grid_position
- creation_status
- created_at
- creator_user_id
- widget_type
- plots
- time_series_metric_type
description: A dashboard widget that displays one or more metric series.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the widget.
type:
allOf:
- $ref: '#/components/schemas/WidgetType'
enum:
- LINE_CHART
description: Identifies this widget as a line chart.
dashboard_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the dashboard containing the widget.
title:
type: string
description: Display title of the widget.
grid_position:
allOf:
- $ref: '#/components/schemas/WidgetGridPosition'
description: Position and size of the widget in the dashboard grid.
creation_status:
allOf:
- $ref: '#/components/schemas/WidgetCreationStatus'
description: Publication state of the widget.
created_at:
type: string
format: date-time
description: Timestamp when the widget was created.
creator_user_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the user who created the widget.
widget_type:
allOf:
- $ref: '#/components/schemas/LineChartType'
description: Visualization mode used by the chart.
plots:
type: array
description: Metric series displayed by the widget.
items:
$ref: '#/components/schemas/WidgetPlot'
time_series_metric_type:
type: string
description: Metric used to compute the time series.
monitor_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Monitor represented by the widget when using the monitor chart mode.
y_min:
type: number
nullable: true
description: >-
Minimum value displayed on the y-axis, or null for automatic
scaling.
y_max:
type: number
nullable: true
description: >-
Maximum value displayed on the y-axis, or null for automatic
scaling.
y_axis_label:
type: string
nullable: true
description: Custom y-axis label, or null to use the default.
x_axis_label:
type: string
nullable: true
description: Custom x-axis label, or null to use the default.
x_axis_tilt:
type: string
nullable: true
description: Saved rotation setting for x-axis labels.
font_size:
type: string
nullable: true
description: Saved chart font-size setting.
show_legend:
type: boolean
nullable: true
description: Whether the legend is shown, or null to use the default.
legend_placement:
type: string
nullable: true
description: Saved placement of the chart legend.
timezone:
type: string
nullable: true
description: Timezone used to display time-series values.
start_time:
type: string
format: date-time
nullable: true
description: >-
Widget-specific range start, or null when the dashboard range
applies.
end_time:
type: string
format: date-time
nullable: true
description: Widget-specific range end, or null when the dashboard range applies.
time_series_data_granularity:
type: string
nullable: true
description: Saved aggregation interval for the time series.
overwrite_global_time:
type: boolean
nullable: true
description: >-
Whether this widget uses its own time range instead of the dashboard
range.
time_range_key:
type: string
nullable: true
description: Saved relative time-range selection.
additionalProperties: false
x-forward-compatible: true
BarChartWidget:
type: object
required:
- id
- type
- dashboard_id
- title
- grid_position
- creation_status
- created_at
- creator_user_id
- is_normalized
- is_stacked
- plots
description: A dashboard widget that compares metric values across categories.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the widget.
type:
allOf:
- $ref: '#/components/schemas/WidgetType'
enum:
- BAR_CHART
description: Identifies this widget as a bar chart.
dashboard_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the dashboard containing the widget.
title:
type: string
description: Display title of the widget.
grid_position:
allOf:
- $ref: '#/components/schemas/WidgetGridPosition'
description: Position and size of the widget in the dashboard grid.
creation_status:
allOf:
- $ref: '#/components/schemas/WidgetCreationStatus'
description: Publication state of the widget.
created_at:
type: string
format: date-time
description: Timestamp when the widget was created.
creator_user_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the user who created the widget.
is_normalized:
type: boolean
description: Whether values are normalized before display.
performance_metric:
type: string
nullable: true
description: Performance metric displayed by the chart.
bin_option:
type: string
nullable: true
description: Saved binning strategy for numeric values.
num_bins:
type: integer
nullable: true
description: Number of bins used when values are grouped numerically.
custom_bins:
type: array
items:
type: number
nullable: true
description: Custom numeric bin boundaries.
quantiles:
type: array
items:
type: number
nullable: true
description: Quantile boundaries used to group values.
sort_order:
type: string
nullable: true
description: Saved ordering of chart categories.
top_n:
type: integer
nullable: true
description: Maximum number of categories displayed.
is_stacked:
type: boolean
description: Whether series are stacked in each category.
plots:
type: array
description: Metric series displayed by the widget.
items:
$ref: '#/components/schemas/WidgetPlot'
y_min:
type: number
nullable: true
description: >-
Minimum value displayed on the y-axis, or null for automatic
scaling.
y_max:
type: number
nullable: true
description: >-
Maximum value displayed on the y-axis, or null for automatic
scaling.
y_axis_label:
type: string
nullable: true
description: Custom y-axis label, or null to use the default.
x_axis_label:
type: string
nullable: true
description: Custom x-axis label, or null to use the default.
x_axis_tilt:
type: string
nullable: true
description: Saved rotation setting for x-axis labels.
font_size:
type: string
nullable: true
description: Saved chart font-size setting.
show_legend:
type: boolean
nullable: true
description: Whether the legend is shown, or null to use the default.
legend_placement:
type: string
nullable: true
description: Saved placement of the chart legend.
timezone:
type: string
nullable: true
description: Timezone used to display time-series values.
start_time:
type: string
format: date-time
nullable: true
description: >-
Widget-specific range start, or null when the dashboard range
applies.
end_time:
type: string
format: date-time
nullable: true
description: Widget-specific range end, or null when the dashboard range applies.
time_series_data_granularity:
type: string
nullable: true
description: Saved aggregation interval for time-series values.
overwrite_global_time:
type: boolean
nullable: true
description: >-
Whether this widget uses its own time range instead of the dashboard
range.
time_range_key:
type: string
nullable: true
description: Saved relative time-range selection.
additionalProperties: false
x-forward-compatible: true
StatisticWidget:
type: object
required:
- id
- type
- dashboard_id
- title
- grid_position
- creation_status
- created_at
- creator_user_id
- model_version_ids
- model_version_environment_metadata_ids
- aggregation
- time_series_metric_type
- filters
description: A dashboard widget that displays a single aggregated metric value.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the widget.
type:
allOf:
- $ref: '#/components/schemas/WidgetType'
enum:
- STATISTIC
description: Identifies this widget as a statistic.
dashboard_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the dashboard containing the widget.
title:
type: string
description: Display title of the widget.
grid_position:
allOf:
- $ref: '#/components/schemas/WidgetGridPosition'
description: Position and size of the widget in the dashboard grid.
creation_status:
allOf:
- $ref: '#/components/schemas/WidgetCreationStatus'
description: Publication state of the widget.
created_at:
type: string
format: date-time
description: Timestamp when the widget was created.
creator_user_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the user who created the widget.
model_id:
type: string
nullable: true
description: Model used by the statistic, or null when the source is a dataset.
model_version_ids:
type: array
items:
$ref: '#/components/schemas/Id'
description: Model versions included in the calculation.
model_environment_name:
type: string
nullable: true
description: Model environment name used by the statistic.
model_version_environment_metadata_ids:
type: array
items:
$ref: '#/components/schemas/Id'
description: Model lineage records included in the calculation.
aggregation:
type: string
description: Aggregation applied to the selected metric.
time_series_metric_type:
type: string
description: Metric used to compute the statistic.
dimension_category:
type: string
nullable: true
description: Category of the selected dimension.
dimension_name:
type: string
nullable: true
description: Name of the selected dimension.
dimension_data_type:
type: string
nullable: true
description: Data type of the selected dimension.
performance_metric:
type: string
nullable: true
description: Performance metric used by the statistic.
prediction_value_class:
type: string
nullable: true
description: Prediction class selected for class-specific metrics.
custom_metric_id:
type: string
nullable: true
description: Custom metric used by the statistic.
ranking_at_k:
type: integer
nullable: true
description: Ranking cutoff used by ranking metrics.
custom_statistic_text:
type: string
nullable: true
description: Custom text displayed with the statistic.
dataset_source:
allOf:
- $ref: '#/components/schemas/DatasetSource'
description: Dataset-backed source configuration for the statistic.
filters:
type: array
items:
$ref: '#/components/schemas/WidgetFilter'
description: Filters applied before computing the statistic.
additionalProperties: false
x-forward-compatible: true
TextWidget:
type: object
required:
- id
- type
- dashboard_id
- title
- grid_position
- creation_status
- created_at
- creator_user_id
- content
description: A dashboard widget that displays formatted text.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the widget.
type:
allOf:
- $ref: '#/components/schemas/WidgetType'
enum:
- TEXT
description: Identifies this widget as a text widget.
dashboard_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the dashboard containing the widget.
title:
type: string
description: Display title of the widget.
grid_position:
allOf:
- $ref: '#/components/schemas/WidgetGridPosition'
description: Position and size of the widget in the dashboard grid.
creation_status:
allOf:
- $ref: '#/components/schemas/WidgetCreationStatus'
description: Publication state of the widget.
created_at:
type: string
format: date-time
description: Timestamp when the widget was created.
creator_user_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the user who created the widget.
content:
type: string
description: Saved text content displayed by the widget.
additionalProperties: false
x-forward-compatible: true
PivotTableWidget:
type: object
required:
- id
- type
- dashboard_id
- title
- grid_position
- creation_status
- created_at
- creator_user_id
- model_version_ids
- model_version_environment_metadata_ids
- columns
- filters
description: A dashboard widget that groups metrics and dimensions into a table.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the widget.
type:
allOf:
- $ref: '#/components/schemas/WidgetType'
enum:
- PIVOT_TABLE
description: Identifies this widget as a pivot table.
dashboard_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the dashboard containing the widget.
title:
type: string
description: Display title of the widget.
grid_position:
allOf:
- $ref: '#/components/schemas/WidgetGridPosition'
description: Position and size of the widget in the dashboard grid.
creation_status:
allOf:
- $ref: '#/components/schemas/WidgetCreationStatus'
description: Publication state of the widget.
created_at:
type: string
format: date-time
description: Timestamp when the widget was created.
creator_user_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the user who created the widget.
model_id:
type: string
nullable: true
description: Model used by the table, or null when the source is a dataset.
model_version_ids:
type: array
items:
$ref: '#/components/schemas/Id'
description: Model versions included in the table.
model_environment_name:
type: string
nullable: true
description: Model environment name used by the table.
model_version_environment_metadata_ids:
type: array
items:
$ref: '#/components/schemas/Id'
description: Model lineage records included in the table.
grouped_dimension:
type: string
nullable: true
description: Dimension used to group table rows.
grouped_dimension_category:
type: string
nullable: true
description: Category of the dimension used to group table rows.
grouped_dimension_title:
type: string
nullable: true
description: Display title for the grouped dimension.
query_filter:
type: string
nullable: true
description: Saved query expression applied to the table.
timezone:
type: string
nullable: true
description: Timezone used to display time-based values.
start_time:
type: string
format: date-time
nullable: true
description: >-
Widget-specific range start, or null when the dashboard range
applies.
end_time:
type: string
format: date-time
nullable: true
description: Widget-specific range end, or null when the dashboard range applies.
time_range_key:
type: string
nullable: true
description: Saved relative time-range selection.
overwrite_global_time:
type: boolean
nullable: true
description: >-
Whether this widget uses its own time range instead of the dashboard
range.
columns:
type: array
items:
$ref: '#/components/schemas/PivotTableColumn'
description: Ordered columns displayed in the table.
filters:
type: array
items:
$ref: '#/components/schemas/WidgetFilter'
description: Filters applied to table values.
additionalProperties: false
x-forward-compatible: true
ExperimentChartWidget:
type: object
required:
- id
- type
- dashboard_id
- title
- grid_position
- creation_status
- created_at
- creator_user_id
- plots
description: A dashboard widget that compares evaluation metrics across experiments.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the widget.
type:
allOf:
- $ref: '#/components/schemas/WidgetType'
enum:
- EXPERIMENT_CHART
description: Identifies this widget as an experiment chart.
dashboard_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the dashboard containing the widget.
title:
type: string
description: Display title of the widget.
grid_position:
allOf:
- $ref: '#/components/schemas/WidgetGridPosition'
description: Position and size of the widget in the dashboard grid.
creation_status:
allOf:
- $ref: '#/components/schemas/WidgetCreationStatus'
description: Publication state of the widget.
created_at:
type: string
format: date-time
description: Timestamp when the widget was created.
creator_user_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the user who created the widget.
plots:
type: array
description: Experiment metric series displayed by the widget.
items:
$ref: '#/components/schemas/ExperimentChartWidgetPlot'
font_size:
type: string
nullable: true
description: Saved chart font-size setting.
show_legend:
type: boolean
nullable: true
description: Whether the legend is shown, or null to use the default.
legend_placement:
type: string
nullable: true
description: Saved placement of the chart legend.
x_axis_label:
type: string
nullable: true
description: Custom x-axis label, or null to use the default.
x_axis_tilt:
type: string
nullable: true
description: Saved rotation setting for x-axis labels.
y_min:
type: number
nullable: true
description: >-
Minimum value displayed on the y-axis, or null for automatic
scaling.
y_max:
type: number
nullable: true
description: >-
Maximum value displayed on the y-axis, or null for automatic
scaling.
additionalProperties: false
x-forward-compatible: true
WidgetType:
type: string
enum:
- LINE_CHART
- BAR_CHART
- STATISTIC
- TEXT
- PIVOT_TABLE
- EXPERIMENT_CHART
description: The kind of dashboard widget and the configuration shape it uses.
WidgetGridPosition:
type: array
description: Widget position and size as [x, y, width, height].
minItems: 4
maxItems: 4
items:
type: integer
minimum: 0
WidgetCreationStatus:
type: string
enum:
- DRAFT
- PUBLISHED
description: >-
Whether the widget is still being edited or is available in the
dashboard.
LineChartType:
type: string
enum:
- LINE
- DRIFT
- MONITOR
- SCATTER
description: The visualization mode used by a line chart widget.
WidgetPlot:
type: object
required:
- id
- position
- title
- model_version_ids
- model_version_environment_metadata_ids
- filters
description: A metric series displayed by a line or bar chart widget.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the plot.
position:
type: integer
description: Display order of the plot within the widget.
title:
type: string
description: Display title of the plot.
model_id:
type: string
nullable: true
description: Model used by the plot, or null when the source is a dataset.
model_version_ids:
type: array
items:
$ref: '#/components/schemas/Id'
description: Model versions included in the plot.
model_environment_name:
type: string
nullable: true
description: Model environment name used by the plot.
model_version_environment_metadata_ids:
type: array
items:
$ref: '#/components/schemas/Id'
description: Model lineage records included in the plot.
dimension_category:
type: string
nullable: true
description: Category of the selected dimension.
dimension_name:
type: string
nullable: true
description: Name of the selected dimension.
dimension_data_type:
type: string
nullable: true
description: Data type of the selected dimension.
prediction_value_class:
type: string
nullable: true
description: Prediction class selected for class-specific metrics.
metric:
type: string
nullable: true
description: Selected built-in metric identifier, such as accuracy or count.
custom_metric_id:
type: string
nullable: true
description: Custom metric represented by the plot.
ranking_at_k:
type: integer
nullable: true
description: Ranking cutoff used by ranking metrics.
comparison_model_baseline_id:
type: string
nullable: true
description: Model baseline used for comparison metrics.
comparison_reference_source:
allOf:
- $ref: '#/components/schemas/WidgetPlotComparisonReferenceSource'
nullable: true
description: >-
Whether the comparison uses the model's primary baseline or a custom
baseline.
comparison_reference_value:
type: object
allOf:
- $ref: '#/components/schemas/WidgetPlotComparisonReferenceValue'
nullable: true
metric_aggregation_type:
type: string
nullable: true
description: Aggregation applied to the selected metric.
split_by_enabled:
type: boolean
nullable: true
description: Whether the plot is split into separate series.
split_by_dimension:
type: string
nullable: true
description: Dimension used to split the plot into series.
split_by_dimension_category:
type: string
nullable: true
description: Category of the dimension used to split the plot.
split_by_overall_metric_enabled:
type: boolean
nullable: true
description: Whether an overall metric series is included with split series.
split_by_all_values_live_update_enabled:
type: boolean
nullable: true
description: Whether split series automatically include newly observed values.
cohorts:
type: array
items:
type: string
nullable: true
description: Cohort identifiers represented by the plot.
colors:
type: array
items:
type: string
nullable: true
description: Saved colors assigned to plot series.
stack_dimension_name:
type: string
nullable: true
description: Dimension used to stack values.
stack_dimension_category:
type: string
nullable: true
description: Category of the dimension used to stack values.
x_axis_dimension_name:
type: string
nullable: true
description: Dimension displayed on the x-axis.
x_axis_dimension_category:
type: string
nullable: true
description: Category of the dimension displayed on the x-axis.
y_axis_dimension_name:
type: string
nullable: true
description: Dimension displayed on the y-axis.
y_axis_dimension_category:
type: string
nullable: true
description: Category of the dimension displayed on the y-axis.
color_by_dimension_name:
type: string
nullable: true
description: Dimension used to assign series colors.
color_by_dimension_category:
type: string
nullable: true
description: Category of the dimension used to assign series colors.
dataset_source:
allOf:
- $ref: '#/components/schemas/DatasetSource'
description: Dataset-backed source configuration for the plot.
filters:
type: array
items:
$ref: '#/components/schemas/WidgetFilter'
description: Filters applied before computing the plot.
additionalProperties: false
x-forward-compatible: true
DatasetSource:
type: object
nullable: true
required:
- dataset_id
- dataset_version_id
- experiment_id
- source_fields
description: Dataset, version, experiment, and fields used as a widget data source.
properties:
dataset_id:
type: string
nullable: true
description: >-
Dataset supplying the values, or null when it is inferred from the
experiment.
dataset_version_id:
type: string
nullable: true
description: >-
Dataset version supplying the values, or null when no version is
selected.
experiment_id:
type: string
nullable: true
description: >-
Experiment supplying evaluation values, or null when no experiment
is selected.
source_fields:
type: array
minItems: 1
maxItems: 2
items:
$ref: '#/components/schemas/WidgetSourceField'
description: One or two dataset fields used to compute the widget value.
additionalProperties: false
x-forward-compatible: true
WidgetFilter:
type: object
required:
- filter_type
description: A saved condition that limits the data used by a widget.
properties:
filter_type:
type: string
description: Kind of filter and value representation.
dimension_name:
type: string
nullable: true
description: Dimension to which the filter applies.
dimension_data_type:
type: string
nullable: true
description: Data type of the filtered dimension.
operator:
type: string
nullable: true
description: Comparison applied by the filter.
dimension_values:
type: array
items:
type: string
nullable: true
description: General dimension values used by the filter.
binary_values:
type: array
items:
type: string
nullable: true
description: Binary values used by the filter.
numeric_values:
type: array
items:
type: number
nullable: true
description: Numeric values used by the filter.
categorical_values:
type: array
items:
type: string
nullable: true
description: Categorical values used by the filter.
additionalProperties: false
x-forward-compatible: true
PivotTableColumn:
type: object
required:
- id
- position
description: A saved column definition in a pivot table widget.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the column.
position:
type: integer
nullable: true
description: Display order of the column, or null when no order is saved.
dimension:
type: string
nullable: true
description: Dimension or metric represented by the column.
dimension_category:
type: string
nullable: true
description: Category of the selected dimension.
aggregation:
type: string
nullable: true
description: Aggregation applied to values in the column.
title:
type: string
nullable: true
description: Display title of the column.
dataset_source:
allOf:
- $ref: '#/components/schemas/DatasetSource'
description: Dataset-backed source configuration for the column.
additionalProperties: false
x-forward-compatible: true
ExperimentChartWidgetPlot:
type: object
required:
- id
- dataset_id
- position
- title
description: One experiment metric series displayed by an experiment chart widget.
properties:
id:
allOf:
- $ref: '#/components/schemas/Id'
description: Unique identifier for the plot.
dataset_id:
allOf:
- $ref: '#/components/schemas/Id'
description: Dataset whose experiments are represented by the plot.
position:
type: integer
description: Display order of the plot within the widget.
title:
type: string
description: Display title of the plot.
performance_metric:
type: string
nullable: true
description: Performance metric represented by the plot.
additionalProperties: false
x-forward-compatible: true
WidgetPlotComparisonReferenceSource:
type: string
enum:
- PRIMARY_BASELINE
- CUSTOM_BASELINE
description: >-
Whether the comparison uses the model's primary baseline or a custom
baseline.
WidgetPlotComparisonReferenceValue:
oneOf:
- $ref: '#/components/schemas/WidgetPlotComparisonFixedReferenceValue'
- $ref: '#/components/schemas/WidgetPlotComparisonMovingReferenceValue'
discriminator:
propertyName: type
mapping:
FIXED: '#/components/schemas/WidgetPlotComparisonFixedReferenceValue'
MOVING: '#/components/schemas/WidgetPlotComparisonMovingReferenceValue'
description: Saved fixed or moving reference data configuration.
WidgetSourceField:
description: A dataset column or nested JSON field used by a widget.
oneOf:
- $ref: '#/components/schemas/DatasetColumnSourceField'
- $ref: '#/components/schemas/NestedJsonFieldSourceField'
discriminator:
propertyName: kind
mapping:
DATASET_COLUMN: '#/components/schemas/DatasetColumnSourceField'
NESTED_JSON_FIELD: '#/components/schemas/NestedJsonFieldSourceField'
WidgetPlotComparisonFixedReferenceValue:
type: object
required:
- type
- environment_name
- external_batch_ids
- external_model_version_ids
- start_time
- end_time
description: Fixed time range used as the comparison reference.
properties:
type:
type: string
enum:
- FIXED
description: Identifies a fixed comparison reference.
environment_name:
type: string
description: Model environment containing the reference data.
external_batch_ids:
type: array
items:
type: string
description: Batches included in the reference.
external_model_version_ids:
type: array
items:
type: string
description: Model versions included in the reference.
model_version_environment_metadata_id:
type: string
nullable: true
description: Model lineage record defining the reference, when applicable.
start_time:
type: string
format: date-time
description: Inclusive start of the fixed reference range.
end_time:
type: string
format: date-time
description: Exclusive end of the fixed reference range.
additionalProperties: false
x-forward-compatible: true
WidgetPlotComparisonMovingReferenceValue:
type: object
required:
- type
- environment_name
- external_batch_ids
- external_model_version_ids
- moving_window_ms
- moving_window_delay_ms
description: Moving time range used as the comparison reference.
properties:
type:
type: string
enum:
- MOVING
description: Identifies a moving comparison reference.
environment_name:
type: string
description: Model environment containing the reference data.
external_batch_ids:
type: array
items:
type: string
description: Batches included in the reference.
external_model_version_ids:
type: array
items:
type: string
description: Model versions included in the reference.
model_version_environment_metadata_id:
type: string
nullable: true
description: Model lineage record defining the reference, when applicable.
moving_window_ms:
type: number
description: Duration of the moving reference range in milliseconds.
moving_window_delay_ms:
type: number
description: >-
Delay between the current time and the moving reference range in
milliseconds.
additionalProperties: false
x-forward-compatible: true
DatasetColumnSourceField:
type: object
required:
- kind
- data_type
- column_name
description: A top-level dataset column used by a widget.
properties:
kind:
allOf:
- $ref: '#/components/schemas/WidgetSourceFieldKind'
enum:
- DATASET_COLUMN
description: Identifies this source as a top-level dataset column.
data_type:
allOf:
- $ref: '#/components/schemas/WidgetSourceDataType'
description: Data type of the selected column.
column_name:
type: string
description: Name of the selected dataset column.
additionalProperties: false
x-forward-compatible: true
NestedJsonFieldSourceField:
type: object
required:
- kind
- data_type
- path
description: A nested field inside a JSON dataset column used by a widget.
properties:
kind:
allOf:
- $ref: '#/components/schemas/WidgetSourceFieldKind'
enum:
- NESTED_JSON_FIELD
description: Identifies this source as a nested JSON field.
data_type:
allOf:
- $ref: '#/components/schemas/WidgetSourceDataType'
description: Data type of the selected nested field.
path:
type: string
description: Saved path to the nested field.
additionalProperties: false
x-forward-compatible: true
WidgetSourceFieldKind:
type: string
enum:
- DATASET_COLUMN
- NESTED_JSON_FIELD
description: The kind of dataset field reference.
WidgetSourceDataType:
type: string
enum:
- STRING
- LONG
- DOUBLE
- FLOAT
- BOOLEAN
- EMBEDDING
- STRING_LIST
description: Data type of a dataset field used by a widget.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat:
description: >
Most Arize AI endpoints require authentication. For those endpoints that
require authentication, include your API key in the request header using
the format
``` Authorization: Bearer
```
````