Qodex.ai

Retrieve dashboard widget data

GET {{baseUrl}}/dashboards/:dashboardId/widgets/:widgetId?aid=1234&window=12h&startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&max=10&cursor=bGFzdFJvdW5kSWQ9MTY4MTQxMDQ4MA&sort=alertStatus&order=asc

Returns the raw data displayed within a widget in the dashboard.

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.
windowstringA dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: s for seconds (default if no type is specified), m for minutes, h for hours, d for days, and w for weeks.
For a precise date range, use startDate and endDate.
startDatestringUse with the endDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window.
endDatestringDefaults to current time the request is made. Use with the startDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window.
maxnumberOptionally specify the maximum number of objects to retrieve. This only applies to the Alert List and Test Table Widgets.
  • The default for the Alert List widget is set by its limitBy configuration.
  • The default value for the Test Table widget is 10. | | cursor | string | | An optional pagination cursor. This parameter should not not be used directly. Instead, use the _links returned by the API. This feature is only available in the Test Table widget. | | sort | string | | Optional sorting parameter with attributes listed comma-separated. This only applies to the Alert List and Test Table Widgets.
  • For the Alert List widget, you can sort by alertStatus or startTime. The default is alertStatus.
  • For the Test Table widget, you can sort by alertStatus, testName, or testType. The sequence might vary from the web application. The default sort attribute is alertStatus. | | order | string | | Optional sorting order parameter that accepts either asc (ascending) or desc (descending) values. This only applies to the Alert List and Test Table Widgets. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"groupLabels":[{"groupProperty":"AGENT","groupLabels":[{"groupId":"2565","groupLabel":"San Francisco, CA"},{"groupId":"2565","groupLabel":"San Francisco, CA"}]},{"groupProperty":"AGENT","groupLabels":[{"groupId":"2565","groupLabel":"San Francisco, CA"},{"groupId":"2565","groupLabel":"San Francisco, CA"}]}],"binSize":3600,"data":{"cards":[{"cardId":"lrxxr","startDate":"2023-05-16T10:14:28Z","endDate":"2023-05-16T10:14:28Z","previousValue":500,"binSize":3600,"timestamp":1567620000,"numberOfDataPoints":24192,"value":100,"status":"No data","alertSuppressionWindows":[{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"},{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"}]},{"cardId":"lrxxr","startDate":"2023-05-16T10:14:28Z","endDate":"2023-05-16T10:14:28Z","previousValue":500,"binSize":3600,"timestamp":1567620000,"numberOfDataPoints":24192,"value":100,"status":"No data","alertSuppressionWindows":[{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"},{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"}]}],"columns":[{"columnId":"938to","binSize":3600,"points":[{"timestamp":1567620000,"numberOfDataPoints":23304,"value":100,"groups":[{"groupProperty":"COUNTRY","groupValue":"US"},{"groupProperty":"COUNTRY","groupValue":"US"}]},{"timestamp":1567620000,"numberOfDataPoints":23304,"value":100,"groups":[{"groupProperty":"COUNTRY","groupValue":"US"},{"groupProperty":"COUNTRY","groupValue":"US"}]}],"status":"No data","alertSuppressionWindows":[{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"},{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"}]},{"columnId":"938to","binSize":3600,"points":[{"timestamp":1567620000,"numberOfDataPoints":23304,"value":100,"groups":[{"groupProperty":"COUNTRY","groupValue":"US"},{"groupProperty":"COUNTRY","groupValue":"US"}]},{"timestamp":1567620000,"numberOfDataPoints":23304,"value":100,"groups":[{"groupProperty":"COUNTRY","groupValue":"US"},{"groupProperty":"COUNTRY","groupValue":"US"}]}],"status":"No data","alertSuppressionWindows":[{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"},{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"}]}],"points":[{"timestamp":1567620000,"numberOfDataPoints":23304,"value":100,"groups":[{"groupProperty":"COUNTRY","groupValue":"US"},{"groupProperty":"COUNTRY","groupValue":"US"}]},{"timestamp":1567620000,"numberOfDataPoints":23304,"value":100,"groups":[{"groupProperty":"COUNTRY","groupValue":"US"},{"groupProperty":"COUNTRY","groupValue":"US"}]}],"tests":[{"testId":"68256","testName":"Http Test Name","target":"www.google.com","testType":"Web - HTTP Server","alertCount":398,"isShared":true,"graphlets":[{"metric":"Availability","testId":"68257","points":[{"x":1580403900,"y":128.249},{"x":1580403900,"y":128.249}]},{"metric":"Availability","testId":"68257","points":[{"x":1580403900,"y":128.249},{"x":1580403900,"y":128.249}]}]},{"testId":"68256","testName":"Http Test Name","target":"www.google.com","testType":"Web - HTTP Server","alertCount":398,"isShared":false,"graphlets":[{"metric":"Availability","testId":"68257","points":[{"x":1580403900,"y":128.249},{"x":1580403900,"y":128.249}]},{"metric":"Availability","testId":"68257","points":[{"x":1580403900,"y":128.249},{"x":1580403900,"y":128.249}]}]}],"startRound":1384309800,"alertSuppressionWindows":[{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"},{"id":"281474976710662","name":"Test dashboards","testIds":["281474976710661"],"startTimes":["2023-05-16T10:14:28Z"],"durationInSeconds":7200,"repeat":"custom","repeatEvery":5,"repeatUnit":"week"}],"totalAlerts":500,"activeAlerts":483,"alerts":[{"alertId":"2004945","testId":"56512","ruleId":"281724","alertSource":"Http Test","alertRule":"Http Test Rule","alertType":"web-ftp-server","startTime":"2023-06-02T08:54:00Z","durationInSeconds":25,"active":true},{"alertId":"2004945","testId":"56512","ruleId":"281724","alertSource":"Http Test","alertRule":"Http Test Rule","alertType":"dns-trace","startTime":"2023-06-02T08:54:00Z","durationInSeconds":25,"active":true}],"summary":{"online":10,"offline":2,"disabled":3},"agents":[{"agentId":"6522","status":"online","ipInfo":{"publicIp":"172.58.92.31","privateIp":"172.58.92.31","ipv6":"incididunt laboris","operativeSystemVersion":"labore consequat dolor"},"agentName":"0c3898000117","location":{"latitude":37.77493,"longitude":-122.41942,"locationName":"San Francisco, California, US"}},{"agentId":"6522","status":"online","ipInfo":{"publicIp":"172.58.92.31","privateIp":"172.58.92.31","ipv6":"aute laborum irure tempor","operativeSystemVersion":"quis Duis pariatur elit"},"agentName":"0c3898000117","location":{"latitude":37.77493,"longitude":-122.41942,"locationName":"San Francisco, California, US"}}],"status":"No data"},"startDate":"2022-07-17T22:00:54Z","endDate":"2022-07-18T22:00:54Z","_links":{"previous":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"irure mollit aliqua aute","deprecation":"enim mollit","name":"Excepteur do amet enim","profile":"ut eu consectetur","title":"enim labore ullamco amet","hreflang":"qui ea ipsum adipisicing est"},"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"commodo enim","deprecation":"ut nisi ullamco","name":"Duis ipsum mollit","profile":"in non eiusmod cupidatat","title":"dolore fugiat enim ea","hreflang":"sunt cupida"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"officia aliqua consequat","deprecation":"ea sit ex id enim","name":"tempor dolore id ad","profile":"laboris sit enim dolore","title":"dolor Duis culpa occaecat voluptate","hreflang":"aliquip id in"}}}