{"type":"api","title":"Retrieve dashboard widget data","meta":{"id":"/apps/pubhub/media/000-v7-apis/a9d7d077fd3cd26af5968939669b4553e8957e87/0e4c66ca-115a-3769-be5b-c6944add743f","info":{"version":"7.0.107","title":"Dashboards API","description":"Manage ThousandEyes Dashboards."},"security":[{"BearerAuth":[]}],"tags":[{"name":"Dashboards","description":"Dashboards and Widgets operations"},{"name":"Dashboard Snapshots","description":"Dashboard Snapshots CRUD operations"},{"name":"Dashboards Filters"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication token"}}},"spec":{"tags":["Dashboards"],"operationId":"getDashboardWidgetData","summary":"Retrieve dashboard widget data","description":"Returns the raw data displayed within a widget in the dashboard.\n","parameters":[{"name":"dashboardId","required":true,"in":"path","description":"A Identifier for a dashboard which can be obtained from the `/dashboards` endpoint.","schema":{"type":"string"},"example":"646f4d2ce3c99b0536c3821e","$$ref":"#/components/parameters/DashboardIdPath"},{"name":"widgetId","required":true,"in":"path","description":"A Identifier for a widget.","schema":{"type":"string"},"example":"unpmg","$$ref":"#/components/parameters/WidgetId"},{"name":"aid","in":"query","description":"A 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.","required":false,"schema":{"type":"string","example":"1234"},"$$ref":"#/components/parameters/AccountGroupId"},{"name":"window","in":"query","description":"A 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.\nFor a precise date range, use `startDate` and `endDate`.","schema":{"type":"string","pattern":"^\\d+(?:[smhdw]{1})?$","example":"12h"},"$$ref":"#/components/parameters/Window"},{"name":"startDate","in":"query","description":"Use 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`.","schema":{"type":"string","format":"date-time","example":"2022-07-17T22:00:54Z"},"$$ref":"#/components/parameters/StartDateParameter"},{"name":"endDate","in":"query","description":"Defaults 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`.","schema":{"type":"string","format":"date-time","example":"2022-07-18T22:00:54Z"},"$$ref":"#/components/parameters/EndDateParameter"},{"name":"max","in":"query","description":"Optionally specify the maximum number of objects to retrieve. This only applies to the **Alert List** and **Test Table** Widgets.\n* The default for the **Alert List** widget is set by its limitBy configuration.\n* The default value for the **Test Table** widget is 10.","schema":{"type":"number"},"example":10,"$$ref":"#/components/parameters/DashboardMax"},{"name":"cursor","in":"query","description":"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.","schema":{"type":"string"},"example":"bGFzdFJvdW5kSWQ9MTY4MTQxMDQ4MA","$$ref":"#/components/parameters/DashboardCursor"},{"name":"sort","in":"query","description":"Optional sorting parameter with attributes listed comma-separated. This only applies to the **Alert List** and **Test Table** Widgets.\n* For the **Alert List** widget, you can sort by `alertStatus` or `startTime`. The default is `alertStatus`.\n* 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`.","schema":{"type":"string"},"example":"alertStatus","$$ref":"#/components/parameters/DashboardSort"},{"name":"order","in":"query","description":"Optional sorting order parameter that accepts either `asc` (ascending) or `desc` (descending) values. This only applies to the **Alert List** and **Test Table** Widgets.","schema":{"type":"string","enum":["asc","desc"],"$$ref":"#/components/schemas/DashboardOrder"},"example":"asc","$$ref":"#/components/parameters/DashboardOrder"}],"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"type":"object","description":"Response of a widget data request.","properties":{"groupLabels":{"type":"array","items":{"type":"object","description":"Map of group labels.","properties":{"groupProperty":{"type":"string","description":"Defines the criterion used to aggregate data points under specific group values.","example":"AGENT"},"groupLabels":{"type":"array","description":"List of group labels.","items":{"type":"object","description":"Represents a mapping entry of a group label.","properties":{"groupId":{"type":"string","description":"Identifier of the group.","example":"2565"},"groupLabel":{"type":"string","description":"Label of the group.","example":"San Francisco, CA"}},"$$ref":"#/components/schemas/ApiReportDataComponentLabelMapEntry"}}},"$$ref":"#/components/schemas/ApiReportDataComponentLabelMap"}},"binSize":{"type":"integer","format":"int64","description":"Duration of each bin.","example":3600,"$$ref":"#/components/schemas/BinSize"},"data":{"type":"object","description":"Data of a widget.","properties":{"cards":{"type":"array","items":{"type":"object","description":"The data displayed on a numbers card.","properties":{"cardId":{"type":"string","description":"Identifier of the card.","example":"lrxxr"},"cardName":{"type":"string","description":"Name of the card.","example":"Card Name"},"startDate":{"type":"string","format":"date-time","description":"UTC start date of the data shown in the API output (ISO date-time format).","example":"2023-05-16T10:14:28Z"},"endDate":{"type":"string","format":"date-time","description":"UTC end date of the data shown in the API output (ISO date-time format).","example":"2023-05-16T10:14:28Z"},"previousValue":{"type":"number","format":"double","description":"Previous value if `compareToPreviousValue == true` in configuration.","example":500},"binSize":{"type":"integer","format":"int64","description":"Duration of each bin.","example":3600,"$$ref":"#/components/schemas/BinSize"},"timestamp":{"type":"integer","format":"int64","description":"Timestamp of the aggregated data point.","example":1567620000,"$$ref":"#/components/schemas/Timestamp"},"numberOfDataPoints":{"type":"integer","format":"int64","description":"Number of points aggregated into the data point","example":24192},"value":{"type":"number","format":"double","description":"Aggregated value.","example":100,"$$ref":"#/components/schemas/WidgetValue"},"status":{"type":"string","description":"Message for not fully configured card or no data.","example":"No data","$$ref":"#/components/schemas/WidgetStatus"},"alertSuppressionWindows":{"type":"array","items":{"type":"object","description":"Alert suppression window shown in a widget.","properties":{"id":{"type":"string","description":"Identifier of the alert suppression window.","example":"281474976710662"},"name":{"type":"string","description":"Name of the alert suppression window.","example":"Test dashboards"},"testIds":{"uniqueItems":true,"type":"array","items":{"type":"string"},"example":["281474976710661"]},"startTimes":{"type":"array","items":{"type":"string","format":"date-time"},"example":["2023-05-16T10:14:28Z"]},"durationInSeconds":{"type":"integer","format":"int64","example":7200},"repeat":{"type":"string","enum":["none","every-day","alt-every-day","every-week","every-two-week","every-month","every-three-month","custom"],"example":"custom","$$ref":"#/components/schemas/AswRepeat"},"repeatEvery":{"type":"integer","format":"int32","example":5},"repeatUnit":{"type":"string","enum":["day","week","month"],"example":"week","$$ref":"#/components/schemas/AswRepeatUnit"}},"$$ref":"#/components/schemas/ApiDashboardAsw"}},"_links":{"type":"object","description":"A links object containing the self link.","readOnly":true,"properties":{"self":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/SelfLinks"}},"$$ref":"#/components/schemas/ApiNumbersCardData"}},"columns":{"type":"array","items":{"type":"object","description":"The data presented within a single column of a Multi-Metric table.","properties":{"columnId":{"type":"string","description":"Identifier of the column.","example":"938to"},"binSize":{"type":"integer","format":"int64","description":"Duration of each bin.","example":3600,"$$ref":"#/components/schemas/BinSize"},"points":{"type":"array","items":{"type":"object","description":"Data point of a widget.","properties":{"timestamp":{"type":"integer","format":"int64","description":"Timestamp of the aggregated data point.","example":1567620000,"$$ref":"#/components/schemas/Timestamp"},"numberOfDataPoints":{"type":"integer","format":"int64","description":"Number of test data points aggregated into the widget data point.","example":23304},"value":{"type":"number","format":"double","description":"Aggregated value.","example":100,"$$ref":"#/components/schemas/WidgetValue"},"groups":{"type":"array","items":{"type":"object","description":"Group of data points.","properties":{"groupProperty":{"type":"string","description":"Defines the criterion used to aggregate data points under specific group values.","example":"COUNTRY"},"groupValue":{"type":"string","description":"The value of a group.","example":"US"}},"$$ref":"#/components/schemas/ApiDataPointGroup"}}},"$$ref":"#/components/schemas/ApiWidgetDataPoint"}},"status":{"type":"string","description":"Message for not fully configured card or no data.","example":"No data","$$ref":"#/components/schemas/WidgetStatus"},"alertSuppressionWindows":{"type":"array","items":{"type":"object","description":"Alert suppression window shown in a widget.","properties":{"id":{"type":"string","description":"Identifier of the alert suppression window.","example":"281474976710662"},"name":{"type":"string","description":"Name of the alert suppression window.","example":"Test dashboards"},"testIds":{"uniqueItems":true,"type":"array","items":{"type":"string"},"example":["281474976710661"]},"startTimes":{"type":"array","items":{"type":"string","format":"date-time"},"example":["2023-05-16T10:14:28Z"]},"durationInSeconds":{"type":"integer","format":"int64","example":7200},"repeat":{"type":"string","enum":["none","every-day","alt-every-day","every-week","every-two-week","every-month","every-three-month","custom"],"example":"custom","$$ref":"#/components/schemas/AswRepeat"},"repeatEvery":{"type":"integer","format":"int32","example":5},"repeatUnit":{"type":"string","enum":["day","week","month"],"example":"week","$$ref":"#/components/schemas/AswRepeatUnit"}},"$$ref":"#/components/schemas/ApiDashboardAsw"}},"_links":{"type":"object","description":"A links object containing the self link.","readOnly":true,"properties":{"self":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/SelfLinks"}},"$$ref":"#/components/schemas/ApiMultiMetricColumnData"}},"points":{"type":"array","items":{"type":"object","description":"Data point of a widget.","properties":{"timestamp":{"type":"integer","format":"int64","description":"Timestamp of the aggregated data point.","example":1567620000,"$$ref":"#/components/schemas/Timestamp"},"numberOfDataPoints":{"type":"integer","format":"int64","description":"Number of test data points aggregated into the widget data point.","example":23304},"value":{"type":"number","format":"double","description":"Aggregated value.","example":100,"$$ref":"#/components/schemas/WidgetValue"},"groups":{"type":"array","items":{"type":"object","description":"Group of data points.","properties":{"groupProperty":{"type":"string","description":"Defines the criterion used to aggregate data points under specific group values.","example":"COUNTRY"},"groupValue":{"type":"string","description":"The value of a group.","example":"US"}},"$$ref":"#/components/schemas/ApiDataPointGroup"}}},"$$ref":"#/components/schemas/ApiWidgetDataPoint"}},"tests":{"type":"array","items":{"type":"object","description":"Data shown in a test table widget.","properties":{"testId":{"type":"string","description":"Identifier of the test.","example":"68256"},"testName":{"type":"string","description":"Name of the test.","example":"Http Test Name"},"target":{"type":"string","description":"Configured target of the test.","example":"www.google.com"},"testType":{"type":"string","description":"Type of the test.","example":"Web - HTTP Server"},"alertCount":{"type":"integer","format":"int64","description":"Number of active alerts of the test.","example":398},"isShared":{"type":"boolean","description":"Set to `true` if test is shared, `false` otherwise."},"graphlets":{"type":"array","description":"List of time series points for test metrics in the last 12 hours.","items":{"type":"object","description":"Information displayed within a mini-graph associated with a specific test in a table.","properties":{"metric":{"type":"string","description":"Name of the metric.","example":"Availability"},"testId":{"type":"string","description":"Identifier of the test.","example":"68257"},"points":{"type":"array","items":{"type":"object","description":"A data point on a graphlet.","properties":{"x":{"type":"integer","format":"int64","description":"Timestamp of the data point.","example":1580403900},"y":{"type":"number","format":"double","description":"Value of the data point.","example":128.249}},"$$ref":"#/components/schemas/ApiGraphletPoint"}}},"$$ref":"#/components/schemas/ApiTestTableGraphletsData"}}},"$$ref":"#/components/schemas/ApiTestTableData"}},"startRound":{"type":"integer","format":"int64","description":"Epoch time (seconds) indicating the start time of the round.","example":1384309800},"alertSuppressionWindows":{"type":"array","items":{"type":"object","description":"Alert suppression window shown in a widget.","properties":{"id":{"type":"string","description":"Identifier of the alert suppression window.","example":"281474976710662"},"name":{"type":"string","description":"Name of the alert suppression window.","example":"Test dashboards"},"testIds":{"uniqueItems":true,"type":"array","items":{"type":"string"},"example":["281474976710661"]},"startTimes":{"type":"array","items":{"type":"string","format":"date-time"},"example":["2023-05-16T10:14:28Z"]},"durationInSeconds":{"type":"integer","format":"int64","example":7200},"repeat":{"type":"string","enum":["none","every-day","alt-every-day","every-week","every-two-week","every-month","every-three-month","custom"],"example":"custom","$$ref":"#/components/schemas/AswRepeat"},"repeatEvery":{"type":"integer","format":"int32","example":5},"repeatUnit":{"type":"string","enum":["day","week","month"],"example":"week","$$ref":"#/components/schemas/AswRepeatUnit"}},"$$ref":"#/components/schemas/ApiDashboardAsw"}},"totalAlerts":{"type":"integer","format":"int64","description":"Total number of active alerts within configured timespan.","example":500},"activeAlerts":{"type":"integer","format":"int64","description":"Total number of currently active alerts.","example":483},"alerts":{"type":"array","items":{"type":"object","description":"Alert shown in the alert list widget.","properties":{"alertId":{"type":"string","description":"Identifier of the alert.","example":"2004945"},"testId":{"type":"string","description":"Identifier of the test.","example":"56512"},"ruleId":{"type":"string","description":"Identifier of the rule.","example":"281724"},"alertSource":{"type":"string","description":"Name of the agent, monitor or device producing the alert.","example":"Http Test"},"alertRule":{"type":"string","description":"Name of the alert rule that this alert belongs to.","example":"Http Test Rule"},"alertType":{"type":"string","description":"Name of the alert type","enum":["network-end-to-end-server","network-end-to-end-agent","network-path-trace","dns-server","dns-trace","dnssec","dns-plus-domain","dns-plus-server","web-http-server","web-page-load","web-transaction-classic","web-transaction","api","web-ftp-server","voice-sip-server","voice-rtp-stream","device","device-interface","endpoint-end-to-end-server","endpoint-web-http-server","endpoint-path-trace","browser-session-agent","browser-session-application","routing-bgp"],"$$ref":"#/components/schemas/AlertListAlertType"},"startTime":{"type":"string","format":"date-time","description":"UTC date when the alert was first active.","example":"2023-06-02T08:54:00Z"},"durationInSeconds":{"type":"integer","format":"int64","description":"Number of seconds the alert was active. If it’s still active, this number will increase every second.","example":25},"active":{"type":"boolean","description":"Set to `true` if alert is active, `false` otherwise.","example":true}},"$$ref":"#/components/schemas/ApiAlertListAlert"}},"summary":{"type":"object","description":"Summary of the agent status.","properties":{"online":{"type":"integer","format":"int32","description":"Shows the number of agents with an online status.","example":10},"offline":{"type":"integer","format":"int32","description":"Shows the number of agents with an offline status.","example":2},"disabled":{"type":"integer","format":"int32","description":"Shows the number of agents with disabled status.","example":3}},"$$ref":"#/components/schemas/ApiAgentStatusSummary"},"agents":{"type":"array","items":{"type":"object","description":"Agent shown in agent status widget.","properties":{"agentId":{"type":"string","description":"Identifier of the agent.","example":"6522"},"status":{"type":"string","description":"State of the agent.","enum":["online","offline","disabled"],"example":"online","readOnly":true,"$$ref":"#/components/schemas/EnterpriseAgentState"},"ipInfo":{"type":"object","description":"IP information of the agent.","properties":{"publicIp":{"type":"string","description":"Public IP of the agent.","format":"ipv4","example":"172.58.92.31"},"privateIp":{"type":"string","description":"Private IP of the agent.","format":"ipv4","example":"172.58.92.31"},"ipv6":{"type":"string"},"operativeSystemVersion":{"type":"string"}},"$$ref":"#/components/schemas/ApiAgentStatusIpInfo"},"agentName":{"type":"string","description":"Name of the agent","example":"0c3898000117"},"location":{"type":"object","description":"Location of the agent.","properties":{"latitude":{"type":"number","format":"double","description":"Latitude of the agent.","example":37.77493},"longitude":{"type":"number","format":"double","description":"Longitude of the agent.","example":-122.41942},"locationName":{"type":"string","description":"Name of the agent location.","example":"San Francisco, California, US"}},"$$ref":"#/components/schemas/ApiAgentLocation"}},"$$ref":"#/components/schemas/ApiAgentStatusAgent"}},"rows":{"type":"array","description":"Detailed information about each row in the **List** widget.","items":{"type":"object","description":"A row in a **List** widget. Property names are dimension display labels mapped to their values for that row.","properties":{"_links":{"type":"object","description":"Links for a **List** widget row.","readOnly":true,"properties":{"data":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/ApiListWidgetRowLinks"}},"additionalProperties":{"description":"Dimension display label mapped to its value for this row.","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"$$ref":"#/components/schemas/ApiListWidgetRow"},"$$ref":"#/components/schemas/ApiListWidgetRows"},"legend":{"type":"object","description":"Map of legend labels to their counts for the **List** widget.","additionalProperties":{"type":"integer","format":"int32"},"example":{"ONGOING":5,"CLEAR":3},"$$ref":"#/components/schemas/ApiListWidgetLegend"},"status":{"type":"string","description":"Message for not fully configured card or no data.","example":"No data","$$ref":"#/components/schemas/WidgetStatus"}},"$$ref":"#/components/schemas/ApiWidgetsDataV2"},"startDate":{"type":"string","format":"date-time","example":"2022-07-17T22:00:54Z","description":"(Optional) When passing `window` or `startDate` parameter, the client will also receive the `startDate` field indicating the UTC start date of the data's time range being retrieved (ISO date-time format).","readOnly":true,"$$ref":"#/components/schemas/StartDate"},"endDate":{"type":"string","format":"date-time","example":"2022-07-18T22:00:54Z","description":"(Optional) When passing `window` or `endDate` parameter, the client will also receive the `endDate` field indicating the UTC end date of the data's time range being retrieved (ISO date-time format).","readOnly":true,"$$ref":"#/components/schemas/EndDate"},"_links":{"type":"object","description":"A links object containing pagination related link(s).","properties":{"previous":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"},"next":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"},"self":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/PaginationLinks"}},"$$ref":"#/components/schemas/ApiWidgetDataResponse"}}}},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."},"errors":{"nullable":true,"type":"array","description":"(Optional) When multiple errors occur, the details for each error are listed.","items":{"type":"object","properties":{"code":{"type":"string","description":"(Optional) A unique error type/code that can be referenced in the documentation for further details."},"field":{"type":"string","description":"Identifies the field that triggered this particular error."},"message":{"type":"string","description":"A short, human-readable summary of the error."}},"$$ref":"#/components/schemas/ValidationErrorItem"}}},"$$ref":"#/components/schemas/ValidationError"},"example":{"type":"about:blank","title":"Request validation failed. There are invalid or missing fields","status":400,"detail":"Your request object contains invalid fields.","instance":"/v7","errors":[{"code":"AM-5432","field":"firstName","message":"firstName cannot have fancy characters"},{"code":"DASH-5622","field":"password","message":"Password cannot be blank"}]}}},"$$ref":"#/components/responses/400"},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"invalid_token"},"error_description":{"type":"string","example":"Invalid access token"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/401"},"403":{"description":"Insufficient permissions to query endpoint","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/403"},"404":{"description":"Not found","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"},"example":{"type":"about:blank","title":"URI Resource Not Found","status":404,"detail":"Details explaining if the 404 error is related to an invalid URI or a wrong ID","instance":"/v7"}}},"$$ref":"#/components/responses/404"},"429":{"description":"Exhausted rate limit for the organization","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/429"},"500":{"description":"Internal server error","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"},"example":{"type":"about:blank","title":"Internal server error","status":500,"detail":"Optional detail about the internal error message.","instance":"/v7"}}},"$$ref":"#/components/responses/500"}},"__originalOperationId":"getDashboardWidgetData","security":[{"BearerAuth":[]}],"method":"get","path":"/dashboards/{dashboardId}/widgets/{widgetId}"}}