ThousandEyes Dashboards API
Dashboards and Widgets operations
ThousandEyes Dashboards API is one of 98 APIs that ThousandEyes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 11 operations across 7 paths, and defines 162 schemas. It is described by OpenAPI 3.2.0, at version 7.0.100.
Requests are made against a single base URL, https://api.thousandeyes.com/v7.
11 operations
7 paths
162 schemas
2 DELETE5 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ThousandEyes Dashboards API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
By default, every request must be authenticated.
BearerAuth— Bearer authentication token
Paths & Operations 11
Across 7 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Dashboards 11
Dashboards and Widgets operations
GET
/dashboards
List dashboards
POST
/dashboards
Create dashboard
GET
/dashboards/{dashboardId}
Retrieve dashboard
PUT
/dashboards/{dashboardId}
Update dashboard
DELETE
/dashboards/{dashboardId}
Delete dashboard
POST
/dashboards/{dashboardId}/clone
Clone dashboard
PUT
/dashboards/{dashboardId}/actions/schedule
Create or update dashboard snapshot schedule
DELETE
/dashboards/{dashboardId}/actions/schedule
Delete dashboard snapshot schedule
GET
/dashboards/{dashboardId}/widgets/{widgetId}
Retrieve dashboard widget data
GET
/dashboards/{dashboardId}/widgets/{widgetId}/cards/{cardId}
Retrieve individual card data from numbers widget
GET
/dashboards/{dashboardId}/widgets/{widgetId}/columns/{columnId}
Retrieve individual column data from multi-metric table widget
Schemas 162
The contract defines 162 schemas that model the data the API accepts and returns. The most detailed are ApiWidgetsDataV2 (14 properties), Widget (14 properties), CloneDashboardRequest (13 properties), ApiNumbersCardData (12 properties). Each schema is shown below with its type and property counts.
ApiGroupedBarchartWidget
object
Displays grouped bars, each representing multiple data points. You can configure the bars to align horizontally or vertically.
ApiNumbersCardWidget
object
A widget composed of multiple cards, each presenting a singular metric, such as average packet loss, page load time, or alert count.
ApiAgentStatusAgent
object
Agent shown in agent status widget.
5 properties
DashboardScheduleTimespanPeriod
string
DashboardScheduleAfterEndCondition
object
2 properties
2 required
ApiMultiSearchFilterApiTestTableFilterKey
object
A multi search filter key within the Multi-Metric table widget. The key represents the filter name, and the value specifies the filter value.
2 properties
EndDate
string
(Optional) When passing window or endDate parameter, the client will also receive the endDate field indicating the UTC end date of the data's time range being…
PieChartDatasource
string
Datasource of the pie chart widget.
TableDatasource
string
Datasource of the table widget.
LegacyApiDashboard
object
7 properties
ApiMultiMetricColumn
object
Defines a column within a table that aggregates and displays various metrics (Multi-Metric table).
8 properties
TestTableDatasource
string
Datasource of the test table widget.
BoxAndWhiskersDatasource
string
Datasource of the box and whiskers widget.
LegacyDefaultTimespan
object
3 properties
ApiBoxAndWhiskersWidget
object
A widget that displays a box and whisker plot, mapping data points over time with key statistics: median, range, and quartiles.
AgentStatusDatasource
string
Datasource of the agent to retrieve status.
DashboardSchedule
object
Snapshot schedule for a dashboard. A repeat value of NONE represents a one-time schedule.
11 properties
4 required
AlertListAlertType
string
Name of the alert type
DashboardScheduleNonCustomCronSpec
object
1 property
GroupedBarChartDatasource
string
Datasource of the grouped bar chart widget.
DashboardScheduleDateEndCondition
object
2 properties
2 required
AlertListWidgetType
string
Alert List widget type.
ApiAlertListAlert
object
Alert shown in the alert list widget.
9 properties
MapWidgetType
string
Map widget type.
WidgetSortDirection
LegacyWidgetSortProperty
string
Determines the card sorting criterion.
ApiWidgetsDataV2
object
Data of a widget.
14 properties
ApiDuration
object
Specifies a fixed timespan for data aggregation.
2 properties
SelfLinks
object
A links object containing the self link.
1 property
ApiTableWidget
object
Organizes data in rows and columns, with options to list by test, geographic location, data source, or aggregated categories.
CloneDashboardRequest
object
Optional values that override settings inherited from the source dashboard. Omit the request body or send an empty object ({}) to clone the dashboard without o…
13 properties
WidgetMeasureType
string
Determines how to aggregate the the metric.
ListWidgetType
string
List widget type. Currently supports only List.
EnterpriseAgentState
string
State of the agent.
ApiMultiMetricColumnData
object
The data presented within a single column of a Multi-Metric table.
6 properties
ApiListWidget
object
A widget that displays a list of items, such as events. It can use a time range to limit the items shown.
DashboardGlobalFilterId
object
1 property
WidgetFilters
object
(Optional) Specifies the filters applied to the widget. When present, the filters property displays. Each filter object has two properties: filterProperty and…
ApiNumbersCard
object
An individual number card within the numbers card widget.
BarChartStackedWidgetType
string
Bar Chart: Stacked widget type.
DashboardOrder
string
ApiDataPointGroup
object
Group of data points.
2 properties
ApiAlertListAlertType
TestTableFilterKey
string
NumbersCardDatasource
string
Datasource of the numbers card widget.
LegacyDurationUnit
string
Timespan unit.
PieChartWidgetType
string
Pie Chart widget type
DashboardScheduleCronSpec
object
Cron-style recurrence specification for a dashboard snapshot schedule.
4 properties
3 required
ApiDashboard
Dashboard upon which this dashboard snapshot is based upon.
DashboardScheduleTimespan
object
Amount of historical data to include in each scheduled snapshot.
2 properties
2 required
ApiStackedAreaChartWidgetProperties
object
4 properties
1 required
Dashboard
Dashboard upon which this dashboard snapshot is based upon.
DashboardLayoutDetails
objectnull
Layout details including widget positioning.
1 property
DashboardScheduleNonWeeklyCustomRepeatUnit
string
ApiGeoMapWidget
object
Displays data on a geographic map, highlighting information across different regions.
UnauthorizedError
object
2 properties
DashboardScheduleDataSource
object
Naming configuration for snapshots generated by the schedule. The required dataTimespan property on the schedule controls the snapshot data range.
1 property
1 required
WidgetValue
number
Aggregated value.
TimeSeriesLineWidgetType
string
Time Series: Line widget type.
BarChartGroupedWidgetType
string
Bar Chart: Grouped widget type.
DashboardScheduleCustomCronSpec
object
2 properties
1 required
ApiWidgetMeasure
object
Determines how to aggregate the the metric.
2 properties
ApiAgentStatusIpInfo
object
IP information of the agent.
4 properties
DashboardMetricDirection
string
Direction of agent to agent metric.
BoxAndWhiskersWidgetType
string
Box and Whiskers widget type.
ApiListWidgetRows
array
Detailed information about each row in the List widget.
AswRepeat
string
GeoMapDatasource
string
Datasource of the geo map widget.
StackedAreaChartDatasource
string
Datasource of the stacked area chart widget.
AgentWidgetShow
DashboardScheduleRequest
object
Snapshot schedule configuration for create or update requests.
10 properties
4 required
ApiListWidgetRow
object
A row in a List widget. Property names are dimension display labels mapped to their values for that row.
1 property
ActiveWithin
object
Timespan in which alerts must have been active to appear in the widget.
2 properties
HeatmapDatasource
string
Data source of the heatmap widget.
ListDatasource
string
Data source for the list widget.
AccountGroupId
string
A unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint.
TimeseriesDatasource
string
Datasource of the Timeseries widget.
TimeSeriesStackedAreaWidgetType
string
Time Series: Stacked Area widget type
RefreshRate
string
Auto-refresh interval for a dashboard. Use off to disable auto-refresh.
DashboardScheduleNeverEndCondition
object
1 property
1 required
DashboardScheduleCustomRepeat
object
3 properties
2 required
ShowSubmetrics
booleannull
Controls how metrics with submetric components are displayed. If true (default), the widget displays one chart per group. If false, the widget displays all sub…
ApiWidget
MultiMetricsTableDatasource
string
Datasource of the Multi-Metrics table widget.
DashboardScheduleNonCustomRepeat
string
ApiTimeseriesWidgetProperties
object
6 properties
1 required
ColorGridWidgetType
string
Color Grid widget type.
LegacyAgentWidgetType
string
Type of the agent.
DurationValue
integer
Timespan value.
ScalableWidget
object
3 properties
LegacyWidgetSortDirection
string
Specifies the order in which cards are sorted.
DashboardScheduleCustomRepeatType
string
ApiDashboards
array
CloneDashboardRefreshRate
string
Auto-refresh interval for the cloned dashboard. If omitted, the clone inherits the source dashboard's refresh rate.
ApiListWidgetLegend
object
Map of legend labels to their counts for the List widget.
ApiAggregateProperty
string
Defines the property by which to aggregate the metric. Metrics are grouped based on unique values of the chosen property. Selecting ALL aggregates the data int…
DashboardScheduleEndCondition
Condition that determines when the recurring schedule ends.
AlertListDatasource
string
Datasource of the alert list.
PaginationLinks
object
A links object containing pagination related link(s).
3 properties
VisualMode
string
Visual mode in the UI. Either full or half the width of the window.
LegacyAgentWidgetShow
string
Ownership of the agent.
MetricGroup
string
Metric group of widget as it appears in the UI. Note: may not be required in some cases.
ApiColorGridWidget
object
The Color Grid widget displays colored cards arranged in rows and columns.
BinSize
integer
Duration of each bin.
ApiAgentStatusSummary
object
Summary of the agent status.
3 properties
TagIds
array
List of tag IDs (obtained from /tags endpoint).
ApiDashboardAsw
object
Alert suppression window shown in a widget.
8 properties
Error
object
5 properties
ApiWidgetFilterApiTestTableFilterKey
object
2 properties
AgentStatusWidgetType
string
Agent Status widget type.
DashboardMetric
string
Indicates the specific metric in the report, determined by the layer, test type, and metric values.
ApiStackedBarchartWidget
Widget
object
14 properties
NumberWidgetType
string
Number widget type.
ApiTestTableWidget
object
Displays tests and statuses with options to sort and filter. It can be set to show only certain tests, like those with specific labels or failing tests.
DashboardLinks
object
A links object containing the self and the snapshots links.
2 properties
ApiReportDataComponentLabelMap
object
Map of group labels.
2 properties
ApiAlertListWidget
object
A widget that displays a list of alerts based on specified criteria, such as alert type and time frame.
DefaultTimespan
ValidationError
object
StackedBarChartDatasource
string
Datasource of the stacked bar chart widget.
ApiMultiMetricTableWidget
object
A Multi-Metric table widget with columns, each representing a different metric, offering a comprehensive view rather than restricting to a single metric.
ApiNumbersCardData
object
The data displayed on a numbers card.
12 properties
TableWidgetType
string
Table widget type.
MultiMetricTableWidgetType
string
Multi Metric Table widget type.
ApiStackedAreaChartWidget
object
Displays line plots over time, stacking quantities vertically to showcase cumulative data trends, similar to stacked bar charts. Ideal for visualizing changes…
ColorGridDatasource
string
Datasource of the color grid widget.
WidgetSortProperty
ValidationErrorItem
object
3 properties
WidgetStatus
string
Message for not fully configured card or no data.
ApiListWidgetRowLinks
object
Links for a List widget row.
1 property
LegacyAlertListAlertType
string
Name of the alert type
ApiPieChartWidgetProperties
object
4 properties
1 required
HeatmapWidgetType
string
Heatmap widget type.
ApiHeatmapWidget
object
Displays metric intensity across row and column groupings in a grid to help compare relative values across two dimensions.
Timestamp
integer
Timestamp of the aggregated data point.
ApiPieChartWidget
object
Displays data as segments of a pie, with each slice representing a portion of the total value.
ApiWidgetData
object
Response of a widget data request.
5 properties
ApiGraphletPoint
object
A data point on a graphlet.
2 properties
StartDate
string
(Optional) When passing window or startDate parameter, the client will also receive the startDate field indicating the UTC start date of the data's time range…
ApiReportDataComponentLabelMapEntry
object
Represents a mapping entry of a group label.
2 properties
WidgetPosition
object
Position and size of a widget in the layout grid.
5 properties
4 required
ApiAgentLocation
object
Location of the agent.
3 properties
ApiTestTableGraphletsData
object
Information displayed within a mini-graph associated with a specific test in a table.
3 properties
ApiWidgetDataResponse
AgentWidgetType
DashboardScheduleRepeat
string
Schedule repetition pattern. Use NONE to generate one snapshot at startTime.
ApiWidgetFixedYScalePrefix
string
Prefix denoting the unit of measurement for the fixed Y-axis scale.
TestTableFilterType
string
ApiWidgetDataPoint
object
Data point of a widget.
4 properties
DashboardScheduleCustomRepeatUnit
string
WidgetLimit
integer
Limit configured in the widget.
ApiDefaultTimespan
object
3 properties
Link
object
A hyperlink from the containing resource to a URI.
8 properties
1 required
ApiTestTableData
object
Data shown in a test table widget.
7 properties
TestTableWidgetType
string
Test Table widget type,
DashboardLayoutType
string
Type of the layout.
ApiAgentStatusWidget
object
DashboardLayout
object
Dashboard layout configuration for arranging widgets.
3 properties
1 required
AswRepeatUnit
string
ApiTimeseriesWidget
object
The Timeseries widget graphs data over time, with the chosen metric displayed on the vertical axis. vertical axis
DashboardScheduleOneTimeRepeatType
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ThousandEyes 12
Other APIs ThousandEyes publishes across the network.
ThousandEyes Account Groups API
ThousandEyes Agent Proxies API
ThousandEyes Agent to Agent Instant Tests API
ThousandEyes Agent to Agent Tests API
ThousandEyes Agent To Server Endpoint Dynamic Tests API
ThousandEyes Agent to Server Endpoint Instant Scheduled Tests API
ThousandEyes Agent to Server Endpoint Scheduled Tests API
ThousandEyes Agent to Server Instant Tests API
ThousandEyes Agent to Server Tests API
ThousandEyes Alert Rules API
ThousandEyes Alert Suppression Windows API
ThousandEyes Alerts API
#Dashboards
Where this information came from
This is an independent, third-party profile of ThousandEyes Dashboards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.