ThousandEyes Dashboards API
Manage ThousandEyes Dashboards.
OpenAPI Specification
openapi: 3.0.1
security:
- BearerAuth: []
servers:
- description: ThousandEyes API production URL
url: https://api.thousandeyes.com/v7
info:
version: 7.0.100
title: Dashboards API
description: Manage ThousandEyes Dashboards.
x-provenance:
method: harvested
authored_by: Cisco ThousandEyes
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
provider_published: true
source_host: pubhub.devnetcloud.com
note: 27 OpenAPI 3.0 documents (26 per-area plus a unified 326-operation document) served anonymously from Cisco's DevNet
CDN. api.thousandeyes.com itself 401s every path, so the contract is public while the API host is gated.
x-evidence:
- type: source
url: https://pubhub.devnetcloud.com/media/000-v7-apis/docs/reference/
- type: source
url: https://developer.cisco.com/docs/thousandeyes/
tags:
- name: Dashboards
description: Dashboards and Widgets operations
- name: Dashboard Snapshots
description: Dashboard Snapshots CRUD operations
- name: Dashboards Filters
paths:
/dashboards:
get:
tags:
- Dashboards
operationId: getDashboards
summary: List dashboards
description: 'Returns a list of dashboards and their settings within your account group.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiDashboards'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
post:
tags:
- Dashboards
operationId: createDashboard
summary: Create dashboard
description: 'Creates a new dashboard in your account group. To create a dashboard, you must have one of the following
permissions:
* `Edit dashboard templates for all users in account group` permission (Account Admin).
* `Edit own dashboard templates` permission (Regular User).
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
requestBody:
description: Request body schema to create a dashboard.
content:
application/json:
schema:
$ref: '#/components/schemas/Dashboard'
required: true
responses:
'201':
description: Created
headers:
Location:
$ref: '#/components/headers/Location'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Dashboard'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboards/{dashboardId}:
get:
tags:
- Dashboards
operationId: getDashboard
summary: Retrieve dashboard
description: 'Returns a list of widgets within a dashboard, along with the dashboard''s metadata.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/DashboardIdPath'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiDashboard'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Dashboards
summary: Update dashboard
operationId: updateDashboard
description: "Updates an existing dashboard in your account group. \n\n**Note**: \n* Users with the `Edit dashboard\
\ templates for all users in account group` permission (Account Admin) can update any dashboard.\n* Users with the\
\ `Edit own dashboard templates` permission (Regular User) can only update the dashboards they have created themselves.\n"
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/DashboardIdPath'
requestBody:
description: Request body schema to update a dashboard.
content:
application/json:
schema:
$ref: '#/components/schemas/Dashboard'
required: true
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Dashboard'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Dashboards
operationId: deleteDashboard
summary: Delete dashboard
description: 'Deletes a dashboard using the `dashboardId` provided in the request.
**Note**:
* Users with the `Edit dashboard templates for all users in account group` permission (Account Admin) can delete any
dashboard.
* Users with the `Edit own dashboard templates` permission (Regular User) can only delete the dashboards they have
created themselves.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/DashboardIdPath'
responses:
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboards/{dashboardId}/clone:
post:
tags:
- Dashboards
operationId: cloneDashboard
summary: Clone dashboard
description: 'Creates a dashboard by cloning an existing dashboard. By default, the clone inherits the source dashboard''s
widgets, layout, default timespan, tags, and other supported settings. Values provided in the request override the
corresponding source dashboard settings. Sharing settings are not inherited. If `title` is omitted, the API generates
a unique title for the clone.
**Note**:
* Users with the `Edit dashboard templates for all users in account group` permission (Account Admin) can clone any
dashboard they can view.
* Users with the `Edit own dashboard templates` permission (Regular User) can clone dashboards they can view. The
current user owns the cloned dashboard.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/DashboardIdPath'
requestBody:
description: Optional overrides for the cloned dashboard.
content:
application/json:
schema:
$ref: '#/components/schemas/CloneDashboardRequest'
required: false
responses:
'201':
description: Dashboard cloned successfully.
headers:
Location:
$ref: '#/components/headers/Location'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Dashboard'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboards/{dashboardId}/actions/schedule:
put:
tags:
- Dashboards
operationId: updateDashboardSchedule
summary: Create or update dashboard snapshot schedule
description: 'Creates or replaces the snapshot schedule for a dashboard. Set `repeat` to `NONE` to generate one snapshot
at `startTime`. Other `repeat` values create recurring snapshots. Schedule settings control when snapshots are generated,
the data time range included in each snapshot, and email delivery options.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/DashboardIdPath'
requestBody:
required: true
description: Snapshot schedule configuration.
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardScheduleRequest'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiDashboard'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
description: The dashboard changed while the schedule operation was being applied.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
type: about:blank
title: Conflict
status: 409
detail: The dashboard changed while its schedule was being updated. Retry the request.
instance: /v7/dashboards/{dashboardId}/actions/schedule
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Dashboards
operationId: deleteDashboardSchedule
summary: Delete dashboard snapshot schedule
description: 'Removes the snapshot schedule from a dashboard. Existing snapshots are not deleted.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/DashboardIdPath'
responses:
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
description: The dashboard changed while the schedule operation was being applied.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
type: about:blank
title: Conflict
status: 409
detail: The dashboard changed while its schedule was being deleted. Retry the request.
instance: /v7/dashboards/{dashboardId}/actions/schedule
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboards/{dashboardId}/widgets/{widgetId}:
get:
tags:
- Dashboards
operationId: getDashboardWidgetData
summary: Retrieve dashboard widget data
description: 'Returns the raw data displayed within a widget in the dashboard.
'
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/WidgetId'
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/Window'
- $ref: '#/components/parameters/StartDateParameter'
- $ref: '#/components/parameters/EndDateParameter'
- $ref: '#/components/parameters/DashboardMax'
- $ref: '#/components/parameters/DashboardCursor'
- $ref: '#/components/parameters/DashboardSort'
- $ref: '#/components/parameters/DashboardOrder'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiWidgetDataResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboards/{dashboardId}/widgets/{widgetId}/cards/{cardId}:
get:
tags:
- Dashboards
operationId: getIndividualCardData
summary: Retrieve individual card data from numbers widget
description: 'Returns the raw data for an individual card within a numbers widget in the dashboard.
'
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/WidgetId'
- $ref: '#/components/parameters/CardId'
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/Window'
- $ref: '#/components/parameters/StartDateParameter'
- $ref: '#/components/parameters/EndDateParameter'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiNumbersCardData'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboards/{dashboardId}/widgets/{widgetId}/columns/{columnId}:
get:
tags:
- Dashboards
operationId: getIndividualColumnData
summary: Retrieve individual column data from multi-metric table widget
description: 'Returns the raw data for an individual column within a multi-metric table widget in the dashboard.
'
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/WidgetId'
- $ref: '#/components/parameters/ColumnId'
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/Window'
- $ref: '#/components/parameters/StartDateParameter'
- $ref: '#/components/parameters/EndDateParameter'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiMultiMetricColumnData'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboard-snapshots:
get:
tags:
- Dashboard Snapshots
operationId: getDashboardSnapshots
summary: List dashboard snapshots
description: 'Returns a list of dashboard snapshots within your account group. Use this data to identify a specific
dashboard snapshot, which can be used in other endpoints to access aggregated data. The `View Snapshots` permission
is required to use this endpoint."
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- name: dashboardId
in: query
required: false
schema:
type: string
example: 646f4d2ce3c99b0536c3821e
- $ref: '#/components/parameters/PaginationCursor'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/DashboardSnapshotsPage'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
post:
tags:
- Dashboard Snapshots
operationId: createDashboardSnapshot
summary: Create dashboard snapshot
description: 'Creates a new dashboard snapshot within your account group. The `Edit Snapshots` permission is required
to use this endpoint.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
requestBody:
description: Request body schema to create a dashboard snapshot.
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateDashboardSnapshotRequest'
required: true
responses:
'201':
description: Created
headers:
Location:
$ref: '#/components/headers/Location'
X-Dashboard-Snapshot-Rate-Limit-Limit:
$ref: '#/components/headers/DashboardSnapshotRateLimit'
X-Dashboard-Snapshot-Rate-Limit-Remaining:
$ref: '#/components/headers/DashboardSnapshotRateLimitRemaining'
X-Dashboard-Snapshot-Rate-Limit-Reset:
$ref: '#/components/headers/DashboardSnapshotRateLimitReset'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/DashboardSnapshotResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
description: Exhausted rate limit for snapshot creation
headers:
X-Dashboard-Snapshot-Rate-Limit-Limit:
$ref: '#/components/headers/DashboardSnapshotRateLimit'
X-Dashboard-Snapshot-Rate-Limit-Remaining:
$ref: '#/components/headers/DashboardSnapshotRateLimitRemaining'
X-Dashboard-Snapshot-Rate-Limit-Reset:
$ref: '#/components/headers/DashboardSnapshotRateLimitReset'
'500':
$ref: '#/components/responses/500'
/dashboard-snapshots/{snapshotId}:
get:
tags:
- Dashboard Snapshots
operationId: getDashboardSnapshot
summary: Retrieve dashboard snapshot
description: This operation returns a list of widgets configured in dashboard snapshot configured in ThousandEyes. Seed
this endpoint with a snapshotId found from the /dashboard-snapshots endpoint. This endpoint requires the `View Snapshots`
permission be assigned to the role of the user accessing this endpoint. Returns a list of widgets configured within
a dashboard snapshot. Use the `snapshotId` obtained from the `/dashboard-snapshots` endpoint. The `View Snapshots`
permission is required to use this endpoint."
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/SnapshotIdPath'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiDashboardSnapshot'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
patch:
tags:
- Dashboard Snapshots
operationId: updateDashboardSnapshotExpirationDate
summary: Update snapshot expiration
description: 'Updates the expiration date of a dashboard snapshot. The `Edit snapshots` permission is required to access
this endpoint.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/SnapshotIdPath'
requestBody:
description: Request body schema to update a snapshot expiration.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSnapshotExpirationDateApiRequest'
required: true
responses:
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Dashboard Snapshots
operationId: deleteDashboardSnapshot
summary: Delete dashboard snapshot
description: 'Deletes a dashboard snapshot using the `snapshotId` provided in the request. Users with the `Edit reports
for all users in account group` permission (Account Admin) can delete any dashboard snapshot.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/SnapshotIdPath'
responses:
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboard-snapshots/{snapshotId}/widgets/{widgetId}:
get:
tags:
- Dashboard Snapshots
operationId: getDashboardSnapshotWidgetData
summary: Retrieve dashboard snapshot data
description: 'Returns actual metrics used in the generation of a dashboard snapshot.
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
- $ref: '#/components/parameters/SnapshotIdPath'
- $ref: '#/components/parameters/WidgetId'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiWidgetDataSnapshotResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboards/filters:
get:
tags:
- Dashboards Filters
summary: List dashboard filters
operationId: getDashboardsFilters
description: 'Returns a list of dashboard filters and its context within your account group.
'
parameters:
- $ref: '#/components/parameters/DashboardFilterSearchPattern'
- $ref: '#/components/parameters/AccountGroupId'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiContextFiltersResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
post:
tags:
- Dashboards Filters
summary: Create dashboard filter
operationId: createDashboardFilter
description: 'Creates a new dashboard filter in your account group. To create a filter, you must have one of the following
permissions:
* `Edit dashboard templates for all users in account group` permission (Account Admin). * `Edit own dashboard templates`
permission (Regular User).
'
parameters:
- $ref: '#/components/parameters/AccountGroupId'
requestBody:
description: Dashboard filter object to be created and saved
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApiContextFilterRequest'
responses:
'201':
description: Created
headers:
Location:
$ref: '#/components/headers/Location'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiContextFilterResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/dashboards/filters/{id}:
get:
tags:
- Dashboards Filters
summary: Get dashboard filter
operationId: getDashboardFilter
description: 'Returns a list of data source filters and their metadata within the dashboard filter.
'
parameters:
- $ref: '#/components/parameters/DashboardFilterIdPath'
- $ref: '#/components/parameters/AccountGroupId'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiContextFilterResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Dashboards Filters
summary: Update dashboard filter
operationId: updateDashboardFilter
description: "Updates an existing dashboard filter in your account group.\n \n **Note**:\n \n *\
\ Users with the `Edit dashboard templates for all users in account group` permission (Account Admin) can update any\
\ dashboard filter.\n \n * Users with the `Edit own dashboard templates` permission (Regular User) can only update\
\ the dashboard filters they have created themselves.\n"
parameters:
- $ref: '#/components/parameters/DashboardFilterIdPath'
- $ref: '#/components/parameters/AccountGroupId'
requestBody:
description: Updated dashboard filter context object
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApiContextFilterRequest'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiContextFilterResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Dashboards Filters
summary: Delete dashboard filter
operationId: deleteDashboardFilter
description: "Deletes a dashboard filter using the `filterId` provided in the request.\n\n\n **Note**:\n\n * Users with\
\ the `Edit dashboard templates for all users in account group` permission (Account Admin) can delete any dashboard\
\ filter.\n\n * Users with the `Edit own dashboard templates` permission (Regular User) can only delete the dashboard\
\ filters they have created themselves.\n"
parameters:
- $ref: '#/components/parameters/DashboardFilterIdPath'
- $ref: '#/components/parameters/AccountGroupId'
responses:
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Bearer authentication token
parameters:
DashboardIdPath:
name: dashboardId
required: true
in: path
description: A Identifier for a dashboard which can be obtained from the `/dashboards` endpoint.
schema:
type: string
example: 646f4d2ce3c99b0536c3821e
WidgetId:
name: widgetId
required: true
in: path
description: A Identifier for a widget.
schema:
type: string
example: unpmg
SnapshotIdPath:
name: snapshotId
required: true
in: path
description: A Identifier for a dashboard snapshot which can be obtained from the `/dashboards-snapshots` endpoint.
schema:
type: string
example: d28bb71f-5a47-4783-8f12-d4b115e61b0c
DashboardCursor:
name: cursor
in: query
description: An optional pagination cursor. This parameter should not not be used directly. Instead, use the `_links`
returned by the API. This feature is only available in the **Test Table** widget.
schema:
type: string
example: bGFzdFJvdW5kSWQ9MTY4MTQxMDQ4MA
DashboardMax:
name: max
in: query
description: 'Optionally specify the maximum number of objects to retrieve. This only applies to the **Alert List**
and **Test Table** Widgets.
* The default for the **Alert List** widget is set by its limitBy configuration.
* The default value for the **Test Table** widget is 10.'
schema:
type: number
example: 10
DashboardSort:
name: sort
in: query
description: 'Optional sorting parameter with attributes listed comma-separated. This only applies to the **Alert List**
and **Test Table** Widgets.
* For the **Alert List** widget, you can sort by `alertStatus` or `startTime`. The default is `alertStatus`.
* For the **Test Table** widget, you can sort by `alertStatus`, `testName`, or `testType`. The sequence might vary
from the web application. The default sort attribute is `alertStatus`.'
schema:
type: string
example: alertStatus
DashboardOrder:
name: order
in: query
description: Optional sorting order parameter that accepts either `asc` (ascending) or `desc` (descending) values. This
only applies to the **Alert List** and **Test Table** Widgets.
schema:
$ref: '#/components/schemas/DashboardOrder'
example: asc
DashboardFilterSearchPattern:
in: query
name: searchPattern
description: Optional search pattern parameter to filter list of dashboard filters by either name or description values.
required: false
schema:
type: string
example: cea-filter
DashboardFilterIdPath:
na
# --- truncated at 32 KB (144 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/thousandeyes/refs/heads/main/openapi/thousandeyes-dashboards-openapi.yml