Retrieve dashboard snapshot

GET {{baseUrl}}/dashboard-snapshots/:snapshotId?aid=1234

This endpoint 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."

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

{"snapshotId":"d28bb71f-5a47-4783-8f12-d4b115e61b0c","snapshotName":"HTTP Server Dashboard Snapshot","aid":"1234","isShared":true,"snapshotCreatedDate":"2023-05-16T10:14:28Z","dashboard":{"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":true,"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 nostrud","shouldExcludeAlertSuppressionWindows":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"minim eiusmod ullamco","deprecation":"Exce","name":"non dolor in ut","profile":"proident anim adipisicing o","title":"laborum","hreflang":"in proident"}},"agents":"Enterprise Agents","show":"Owned 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":true,"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":"ex","shouldExcludeAlertSuppressionWindows":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"in sit Excepteur officia","deprecation":"Excepteur anim ad","name":"culpa","profile":"","title":"deserunt irure aute consequat","hreflang":"in"}},"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":true,"isMigratedReport":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"pariatur aliquip","deprecation":"aliqua commodo pariatur","name":"Excepteur ipsum dolore qui","profile":"deserunt","title":"non sunt nulla mollit exercitation","hreflang":"voluptate amet cupidatat ipsum"},"snapshots":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"dolore aute veniam","deprecation":"dolore Lorem in reprehenderit adipisicing","name":"in dolore eiusmod","profile":"do aliquip","title":"ea laborum null","hreflang":"est irure sint ipsum dolore"}},"globalFilterId":"65babd9bb90bf55b17c96c8d","accountId":1234,"createdBy":1,"modifiedBy":1,"modifiedDate":"2023-05-16 10:14:28","globalOverride":false,"migratedReport":false,"apiLink":[{"dolore4f":49917636.57465321},{"reprehenderit_c":-18953202.52717215,"exa3":"et Ut deserunt ad","reprehenderitfa":"in"}]},"widgets":[{"type":"Agent Status","id":"1234","title":"Widget Title","visualMode":"Full","embedUrl":"https://embed.thousandeyes.com/e/00aa:3039802d-5c76-42d2-9a93-c6e5f9d3122f","isEmbedded":true,"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":"et mollit Duis ipsum minim","shouldExcludeAlertSuppressionWindows":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"velit fugiat sit","deprecation":"dolor reprehenderit minim","name":"dolore ullamco in","profile":"in","title":"aliqua amet irure ad","hreflang":"minim ullamco do ex"}},"agents":"Endpoint 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":true,"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":"consectetur fugiat Duis aliqua","shouldExcludeAlertSuppressionWindows":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"Lorem aute ipsum ","deprecation":"ullamco fugiat sed ut sunt","name":"eiusmod eu pariatur","profile":"deserunt ex voluptate consectetur magna","title":"enim do exercitation","hreflang":"ut ullamco vel"}},"agents":"Enterprise Agents","show":"Owned Agents","dataSource":"ENDPOINT_AGENTS"}],"isScheduled":false,"timeSpan":{"startDate":"2023-05-16 10:14:28","start":"2023-05-16T10:14:28Z","duration":60},"snapshotExpirationDate":"2023-05-16T10:14:28Z","_links":{"appLink":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"dolore ea nu","deprecation":"irure anim","name":"occaecat Ut id in","profile":"sed ut incididunt aliquip deserunt","title":"in ad","hreflang":"labore in minim sit"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"consequat culpa","deprecation":"sunt ea","name":"Duis do","profile":"laborum proident ut labore","title":"consectetur incididunt","hreflang":"ut in adipisicing dolore"}},"accountId":1234,"createdDate":"2023-05-16 10:14:28","expirationDate":"2023-05-16 10:14:28","permalink":"https://app.thousandeyes.com/dashboard/?snapshotId=d28bb71f-5a47-4783-8f12-d4b115e61b0c","apiLinks":[{"cillum6d":-4162180.251037866,"etf79":true},{"dolor6a":true,"et_9":false}]}