Update dashboard

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

Updates an existing dashboard in your account group.

Note: * Users with the Edit dashboard templates for all users in account group permission (Account Admin) can update any dashboard. * Users with the Edit own dashboard templates permission (Regular User) can only update the dashboards they have created themselves.

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.

Request Body

{"title"=>"HTTP Server Widgets", "isPrivate"=>true, "widgets"=>[{"type"=>"Agent Status", "title"=>"Widget Title", "visualMode"=>"Full", "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"}, "shouldExcludeAlertSuppressionWindows"=>false, "agents"=>"Endpoint Agents", "show"=>"All Assigned Agents", "dataSource"=>"ENDPOINT_AGENTS"}, {"type"=>"Agent Status", "title"=>"Widget Title", "visualMode"=>"Full", "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"}, "shouldExcludeAlertSuppressionWindows"=>false, "agents"=>"Endpoint Agents", "show"=>"Owned 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, "globalFilterId"=>"65babd9bb90bf55b17c96c8d"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"dashboardId":"5e1f7a99143ae6004fdc3bb4","title":"HTTP Server Widgets","isBuiltIn":true,"aid":"1234","createdBy":"1","modifiedBy":"1","modifiedDate":"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":"et","shouldExcludeAlertSuppressionWindows":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"aute veniam","deprecation":"ullamco do","name":"cupidatat laborum fugiat ad","profile":"dolore sit volupt","title":"pariatur in nulla laboris","hreflang":"cupidatat aute dolore"}},"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":"ex eiusmod sed","shouldExcludeAlertSuppressionWindows":false,"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"Ut","deprecation":"sint dolor","name":"proident non aute","profile":"laborum cupidatat Lorem","title":"velit amet ut Excepteur do","hreflang":"ullamco"}},"agents":"Enterprise Agents","show":"Owned 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":true,"type":"tempor commodo","deprecation":"officia","name":"exercitation do adipisicing dolore","profile":"ullamco id nisi","title":"enim aute ea","hreflang":"nostrud adipisicing aliquip"},"snapshots":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"laborum","deprecation":"eu do et","name":"in eu in","profile":"eu nostrud","title":"ut consequat occaecat veniam","hreflang":"ut ex anim do eu"}},"globalFilterId":"65babd9bb90bf55b17c96c8d"}