Retrieve dashboard

GET {{baseUrl}}/dashboards/:dashboardId?aid=1234

Returns a list of widgets within a dashboard, along with the dashboard's metadata.

Request Params

KeyDatatypeRequiredDescription
aidnumberA unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"dashboardId":"5e1f7a99143ae6004fdc3bb4","title":"HTTP Server Widgets","isBuiltIn":true,"aid":"1234","dashboardCreatedBy":"1","dashboardModifiedBy":"1","dashboardModifiedDate":"2023-05-16T10:14:28Z","isPrivate":true,"isDefaultForUser":true,"isDefaultForAccount":false,"widgets":[{"type":"Agent Status","id":"1234","title":"Widget Title","visualMode":"Full","embedUrl":"https://embed.thousandeyes.com/e/00aa:3039802d-5c76-42d2-9a93-c6e5f9d3122f","isEmbedded":false,"metricGroup":"BGP","direction":"FROM_TARGET","metric":"ENDPOINT_GATEWAY_CPU_LOAD_PERCENT","filters":{"TEST":[5187,5227],"ENDPOINT_MACHINE_ID":["fbd0050c-07f7-43f7-9631-14b32f096962"]},"measure":{"type":"MEAN","percentileValue":95},"fixedTimespan":{"value":10,"unit":"Days"},"apiLink":"in L","shouldExcludeAlertSuppressionWindows":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"ipsum nisi minim","deprecation":"laboris Excepteur anim","name":"mollit culpa aliquip","profile":"in","title":"in","hreflang":"ipsum sunt proident e"}},"agents":"Enterprise Agents","show":"All Assigned Agents","dataSource":"ENDPOINT_AGENTS"},{"type":"Agent Status","id":"1234","title":"Widget Title","visualMode":"Full","embedUrl":"https://embed.thousandeyes.com/e/00aa:3039802d-5c76-42d2-9a93-c6e5f9d3122f","isEmbedded":false,"metricGroup":"BGP","direction":"FROM_TARGET","metric":"ENDPOINT_GATEWAY_CPU_LOAD_PERCENT","filters":{"TEST":[5187,5227],"ENDPOINT_MACHINE_ID":["fbd0050c-07f7-43f7-9631-14b32f096962"]},"measure":{"type":"MEAN","percentileValue":95},"fixedTimespan":{"value":10,"unit":"Days"},"apiLink":"laborum culpa incidid","shouldExcludeAlertSuppressionWindows":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"nulla ut officia","deprecation":"tempor ad in sed","name":"s","profile":"dolore nulla","title":"est ipsum irure","hreflang":"ex deserunt non ut tempor"}},"agents":"Enterprise Agents","show":"All Assigned Agents","dataSource":"ENDPOINT_AGENTS"}],"description":"HTTP Server Widgets","defaultTimespan":{"timespanDuration":7200,"timespanStart":"2023-05-16 10:14:28","timespanEnd":"2023-05-16 11:14:28","duration":7200,"start":"2023-05-16T10:14:28Z","end":"2023-05-16T11:14:28Z"},"isGlobalOverride":false,"isMigratedReport":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"non in","deprecation":"aliquip est","name":"voluptate aliqua velit sed","profile":"adipisicing irure","title":"mollit offic","hreflang":"voluptate amet cupidatat velit"},"snapshots":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"sint deserunt proident","deprecation":"et sit voluptate nulla pariatur","name":"anim dolore elit","profile":"sed consequat fugiat quis ut","title":"u","hreflang":"anim in irure"}},"globalFilterId":"65babd9bb90bf55b17c96c8d","accountId":1234,"createdBy":1,"modifiedBy":1,"modifiedDate":"2023-05-16 10:14:28","globalOverride":false,"migratedReport":false,"apiLink":[{"sed_a0":93421023.15178552},{"fugiatc0":"ipsum commodo voluptate enim","in_3_1":8485839}]}