> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List dashboard widgets
> List the widgets on a dashboard as summaries (id, title, type, and parent
dashboard). Use [Get a dashboard widget](#tag/Dashboards/operation/get_dashboard_widget)
to retrieve a widget's full configuration. The caller must have permission to
read the dashboard.
Only published widgets are returned by default. Set `creation_status` to
`DRAFT` to list draft widgets instead. Use `type` to return only widgets of one
type. Results use cursor-based pagination.
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
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:
get:
tags:
- Dashboards
summary: List dashboard widgets
description: >
List the widgets on a dashboard as summaries (id, title, type, and
parent
dashboard). Use [Get a dashboard
widget](#tag/Dashboards/operation/get_dashboard_widget)
to retrieve a widget's full configuration. The caller must have
permission to
read the dashboard.
Only published widgets are returned by default. Set `creation_status` to
`DRAFT` to list draft widgets instead. Use `type` to return only widgets
of one
type. Results use cursor-based pagination.
This endpoint is in beta, read more
[here](https://arize.com/docs/ax/rest-reference#api-version-stages).
operationId: list_dashboard_widgets
parameters:
- $ref: '#/components/parameters/DashboardIdPathParam'
- $ref: '#/components/parameters/WidgetTypeQueryParam'
- $ref: '#/components/parameters/WidgetCreationStatusQueryParam'
- $ref: '#/components/parameters/LimitQueryParam'
- $ref: '#/components/parameters/CursorQueryParam'
responses:
'200':
$ref: '#/components/responses/ListDashboardWidgetsResponse'
'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
WidgetTypeQueryParam:
name: type
in: query
description: >-
Filter widgets by type, for example `LINE_CHART`. If omitted, widgets of
every type are returned.
schema:
$ref: '#/components/schemas/WidgetType'
example: LINE_CHART
WidgetCreationStatusQueryParam:
name: creation_status
in: query
description: >-
Filter widgets by creation status, either `DRAFT` or `PUBLISHED`.
Defaults to `PUBLISHED` if omitted.
schema:
$ref: '#/components/schemas/WidgetCreationStatus'
example: PUBLISHED
LimitQueryParam:
name: limit
in: query
description: Maximum items to return. Defaults to 50 if omitted; maximum is 100.
schema:
type: integer
minimum: 1
maximum: 100
default: 50
CursorQueryParam:
name: cursor
in: query
description: |
Opaque pagination cursor returned from a previous response
(`pagination.next_cursor`). Treat it as an unreadable token; do not
attempt to parse or construct it.
schema:
type: string
responses:
ListDashboardWidgetsResponse:
description: Returns a list of widget summaries for the dashboard.
content:
application/json:
schema:
$ref: '#/components/schemas/ListDashboardWidgetsResponse'
example:
widgets:
- id: TGluZUNoYXJ0V2lkZ2V0OjEyMw==
title: Latency over time
type: LINE_CHART
grid_position:
- 0
- 0
- 6
- 4
- id: VGV4dFdpZGdldDoxMjQ=
title: Investigation notes
type: TEXT
grid_position:
- 6
- 0
- 4
- 2
pagination:
has_more: false
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
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.
WidgetCreationStatus:
type: string
enum:
- DRAFT
- PUBLISHED
description: >-
Whether the widget is still being edited or is available in the
dashboard.
ListDashboardWidgetsResponse:
type: object
x-forward-compatible: true
required:
- widgets
- pagination
properties:
widgets:
type: array
items:
$ref: '#/components/schemas/WidgetSummary'
description: A list of widget summaries.
pagination:
$ref: '#/components/schemas/PaginationMetadata'
description: Pagination metadata for cursor-based navigation
additionalProperties: false
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
WidgetSummary:
type: object
required:
- id
- title
- type
- grid_position
description: >-
A brief description of a dashboard widget, without its saved
configuration.
properties:
id:
$ref: '#/components/schemas/Id'
description: Unique identifier of the widget.
title:
type: string
description: Display title of the widget.
type:
$ref: '#/components/schemas/WidgetType'
grid_position:
$ref: '#/components/schemas/WidgetGridPosition'
description: Widget position and size as [x, y, width, height].
additionalProperties: false
x-forward-compatible: true
PaginationMetadata:
required:
- has_more
type: object
properties:
next_cursor:
type: string
description: >
Opaque cursor for fetching the next page. Treat as an unreadable
token.
Present when `has_more` is true; omitted when `has_more` is false.
has_more:
type: boolean
description: True if another page of results is available.
description: |
Cursor-based pagination metadata. Use `next_cursor` in the subsequent
request's `cursor` query parameter.
additionalProperties: false
x-forward-compatible: true
WidgetGridPosition:
type: array
description: Widget position and size as [x, y, width, height].
minItems: 4
maxItems: 4
items:
type: integer
minimum: 0
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
```
````