Dashboards

List dashboards

Changed on

List the dashboards the user has access to, including their tags but not their widgets. Use Get a dashboard to retrieve a dashboard's widgets. Only dashboards the caller has permission to read are returned.

Set space_id to list the dashboards in a single space. If omitted, dashboards are listed across all spaces the caller can read. Use space_name to narrow results to spaces whose name contains the given string.

Only active dashboards are returned by default. Set status to INACTIVE to list inactive dashboards instead. Use name to search by name, and sort_column and sort_dir to control ordering. Results use cursor-based pagination.

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

get/v2/dashboards

Request

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

Query parameters

space_idstring

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

Filter search results to a particular space ID

space_namestring

Case-insensitive substring filter on the space name. Narrows results to resources in spaces whose name contains the given string. If omitted, no space name filtering is applied and all resources are returned.

namestring

Case-insensitive substring filter on the resource name. Returns only resources whose name contains the given string. For example, name=prod matches "production", "my-prod-dataset", etc. If omitted, no name filtering is applied and all resources are returned.

status'ACTIVE' | 'INACTIVE'

Filter dashboards by status, either ACTIVE or INACTIVE. Defaults to ACTIVE if omitted. Deleted dashboards are never returned.

sort_column'NAME' | 'CREATED_AT'

The column to sort dashboards by, either NAME or CREATED_AT. Defaults to NAME if omitted.

sort_dir'ASC' | 'DESC'

The sort direction, either ASC or DESC. Defaults to ASC if omitted.

limitinteger

Maximum items to return. Defaults to 50 if omitted; maximum is 100.

cursorstring

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.

Response

Returns a list of dashboards in the space.

Changes