GET
/v6/dashboards
Dashboards list
This endpoint returns a list of dashboards configured in ThousandEyes in the context of the user’s current account group. Use this data to find a dashboard in your account, which is then used in other endpoints to access aggregated data.
Parameters
format=json|xmloptional, specifies the format of output requested. See Output Formats for more informationaid={aid}optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the/account-groupsendpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information
Request
- no request body
Example
$ curl https://api.thousandeyes.com/v6/dashboards.json \
-u {email}:{authToken}
Response
Sends back an array of dashboards configured in the current account group. Each dashboard contains the following fields:
| Field Name | Data Type | Notes |
|---|---|---|
| id | string | unique ID of the dashboard |
| name | string | title of the dashboard |
| description | string | A longer text explanation of what the dashboard does intended for the user. This field will be shown as text only. It may be used as help for other users but is not typically displayed when showing the dashboard. |
| isBuiltIn | boolean | true for built-in dashboards, false for user-created dashboards |
| createdBy | integer | ID of the user that created the dashboard |
| modifiedBy | integer | ID of the user that last modified the dashboard |
| modifiedDate | dateTime | the date/time when the dashboard was last modified |
| accountId | integer | ID of the account that the dashboard belongs to |
| isPrivate | boolean | The dashboard can be viewed by other users in the account. If true, only the creator of the dashboard may view it. If false, all users in the same account may view it. |
| isDefaultForUser | boolean | True if this dashboard is the default for the user; false otherwise |
| isDefaultForAccount | boolean | True if this dashboard is the default for the account group; false otherwise |
| defaultTimespan | object | Default timespan value to override widget timespans. See defaultTimespan below for details. |
| globalOverride | boolean | True to override widget timespans and use defaultTimespan |
| isMigratedReport | boolean | True if this dashboard was previously a report |
| apiLinks | array of apiLink objects | A list of links which can be followed to pull more information |
defaultTimespan object:
| Field | Data Type | Notes |
|---|---|---|
| timespanDuration | long | Relative timespan in seconds. For example, 3600 (Last 1 hour). |
| timespanStart | string | Start of the timespan, in UTC, for timespan range. Use yyyy-MM-dd HH:mm:ss format. For example 2022-07-17 22:00:54. |
| timespanEnd | string | End of the timespan, in UTC, for timespan range. Use yyyy-MM-dd HH:mm:ss format. For example 2022-07-19 22:00:54. |
Header
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 01 Mar 2022 17:53:57 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 970
X-Organization-Rate-Limit-Remaining: 968
X-Organization-Rate-Limit-Reset: 1492076520
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-2
Body
{
"dashboards": [
{
"id": "620ecb8e0112131fa51e263e",
"name": "Dashboard Title A",
"description": "Test Dashboard",
"isBuiltIn": false,
"createdBy": 6699,
"modifiedBy": 6699,
"modifiedDate": "2022-02-22 18:10:04",
"accountId": 11,
"isPrivate": false,
"isDefaultForUser": false,
"isDefaultForAccount": false,
"defaultTimespan": {
"timespanDuration": 86400
},
"globalOverride": false,
"isMigratedReport": false,
"apiLinks": [...]
},
...
]
}
For error responses, see the response status codes documentation.