{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/0e4c66ca-115a-3769-be5b-c6944add743f","info":{"description":"Manage ThousandEyes Dashboards.","title":"Dashboards API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"description":"Dashboards and Widgets operations","name":"Dashboards"},{"description":"Dashboard Snapshots CRUD operations","name":"Dashboard Snapshots"},{"name":"Dashboards Filters"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"description":"Bearer authentication token","scheme":"bearer","type":"http"}}},"spec":{"description":"Response of a widget data request.","properties":{"groupLabels":{"items":{"description":"Map of group labels.","properties":{"groupProperty":{"description":"Defines the criterion used to aggregate data points under specific group values.","example":"AGENT","type":"string"},"groupLabels":{"description":"List of group labels.","items":{"description":"Represents a mapping entry of a group label.","properties":{"groupId":{"description":"Identifier of the group.","example":"2565","type":"string"},"groupLabel":{"description":"Label of the group.","example":"San Francisco, CA","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiReportDataComponentLabelMapEntry"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiReportDataComponentLabelMap"},"type":"array"},"binSize":{"description":"Duration of each bin.","example":3600,"format":"int64","type":"integer"},"data":{"description":"Data of a widget.","properties":{"cards":{"items":{"description":"The data displayed on a numbers card.","properties":{"cardId":{"description":"Identifier of the card.","example":"lrxxr","type":"string"},"startDate":{"description":"UTC start date of the data shown in the API output (ISO date-time format).","example":"2023-05-16T10:14:28Z","format":"date-time","type":"string"},"endDate":{"description":"UTC end date of the data shown in the API output (ISO date-time format).","example":"2023-05-16T10:14:28Z","format":"date-time","type":"string"},"previousValue":{"description":"Previous value if `compareToPreviousValue == true` in configuration.","example":500,"format":"double","type":"number"},"binSize":{"description":"Duration of each bin.","example":3600,"format":"int64","type":"integer"},"timestamp":{"description":"Timestamp of the aggregated data point.","example":1567620000,"format":"int64","type":"integer"},"numberOfDataPoints":{"description":"Number of points aggregated into the data point","example":24192,"format":"int64","type":"integer"},"value":{"description":"Aggregated value.","example":100,"format":"double","type":"number"},"status":{"description":"Message for not fully configured card or no data.","example":"No data","type":"string"},"alertSuppressionWindows":{"items":{"description":"Alert suppression window shown in a widget.","properties":{"id":{"description":"Identifier of the alert suppression window.","example":"281474976710662","type":"string"},"name":{"description":"Name of the alert suppression window.","example":"Test dashboards","type":"string"},"testIds":{"example":["281474976710661"],"items":{"type":"string"},"type":"array","uniqueItems":true},"startTimes":{"example":["2023-05-16T10:14:28Z"],"items":{"format":"date-time","type":"string"},"type":"array"},"durationInSeconds":{"example":7200,"format":"int64","type":"integer"},"repeat":{"enum":["none","every-day","alt-every-day","every-week","every-two-week","every-month","every-three-month","custom"],"example":"custom","type":"string","$$ref":"#/components/schemas/AswRepeat"},"repeatEvery":{"example":5,"format":"int32","type":"integer"},"repeatUnit":{"enum":["day","week","month"],"example":"week","type":"string","$$ref":"#/components/schemas/AswRepeatUnit"}},"type":"object","$$ref":"#/components/schemas/ApiDashboardAsw"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiNumbersCardData"},"type":"array"},"columns":{"items":{"description":"The data presented within a single column of a Multi-Metric table.","properties":{"columnId":{"description":"Identifier of the column.","example":"938to","type":"string"},"binSize":{"description":"Duration of each bin.","example":3600,"format":"int64","type":"integer"},"points":{"items":{"description":"Data point of a widget.","properties":{"timestamp":{"description":"Timestamp of the aggregated data point.","example":1567620000,"format":"int64","type":"integer"},"numberOfDataPoints":{"description":"Number of test data points aggregated into the widget data point.","example":23304,"format":"int64","type":"integer"},"value":{"description":"Aggregated value.","example":100,"format":"double","type":"number"},"groups":{"items":{"description":"Group of data points.","properties":{"groupProperty":{"description":"Defines the criterion used to aggregate data points under specific group values.","example":"COUNTRY","type":"string"},"groupValue":{"description":"The value of a group.","example":"US","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiDataPointGroup"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiWidgetDataPoint"},"type":"array"},"status":{"description":"Message for not fully configured card or no data.","example":"No data","type":"string"},"alertSuppressionWindows":{"items":{"description":"Alert suppression window shown in a widget.","properties":{"id":{"description":"Identifier of the alert suppression window.","example":"281474976710662","type":"string"},"name":{"description":"Name of the alert suppression window.","example":"Test dashboards","type":"string"},"testIds":{"example":["281474976710661"],"items":{"type":"string"},"type":"array","uniqueItems":true},"startTimes":{"example":["2023-05-16T10:14:28Z"],"items":{"format":"date-time","type":"string"},"type":"array"},"durationInSeconds":{"example":7200,"format":"int64","type":"integer"},"repeat":{"enum":["none","every-day","alt-every-day","every-week","every-two-week","every-month","every-three-month","custom"],"example":"custom","type":"string","$$ref":"#/components/schemas/AswRepeat"},"repeatEvery":{"example":5,"format":"int32","type":"integer"},"repeatUnit":{"enum":["day","week","month"],"example":"week","type":"string","$$ref":"#/components/schemas/AswRepeatUnit"}},"type":"object","$$ref":"#/components/schemas/ApiDashboardAsw"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiMultiMetricColumnData"},"type":"array"},"points":{"items":{"description":"Data point of a widget.","properties":{"timestamp":{"description":"Timestamp of the aggregated data point.","example":1567620000,"format":"int64","type":"integer"},"numberOfDataPoints":{"description":"Number of test data points aggregated into the widget data point.","example":23304,"format":"int64","type":"integer"},"value":{"description":"Aggregated value.","example":100,"format":"double","type":"number"},"groups":{"items":{"description":"Group of data points.","properties":{"groupProperty":{"description":"Defines the criterion used to aggregate data points under specific group values.","example":"COUNTRY","type":"string"},"groupValue":{"description":"The value of a group.","example":"US","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiDataPointGroup"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiWidgetDataPoint"},"type":"array"},"tests":{"items":{"description":"Data shown in a test table widget.","properties":{"testId":{"description":"Identifier of the test.","example":"68256","type":"string"},"testName":{"description":"Name of the test.","example":"Http Test Name","type":"string"},"target":{"description":"Configured target of the test.","example":"www.google.com","type":"string"},"testType":{"description":"Type of the test.","example":"Web - HTTP Server","type":"string"},"alertCount":{"description":"Number of active alerts of the test.","example":398,"format":"int64","type":"integer"},"isShared":{"description":"Set to `true` if test is shared, `false` otherwise.","type":"boolean"},"graphlets":{"description":"List of time series points for test metrics in the last 12 hours.","items":{"description":"Information displayed within a mini-graph associated with a specific test in a table.","properties":{"metric":{"description":"Name of the metric.","example":"Availability","type":"string"},"testId":{"description":"Identifier of the test.","example":"68257","type":"string"},"points":{"items":{"description":"A data point on a graphlet.","properties":{"x":{"description":"Timestamp of the data point.","example":1580403900,"format":"int64","type":"integer"},"y":{"description":"Value of the data point.","example":128.249,"format":"double","type":"number"}},"type":"object","$$ref":"#/components/schemas/ApiGraphletPoint"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiTestTableGraphletsData"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiTestTableData"},"type":"array"},"startRound":{"description":"Epoch time (seconds) indicating the start time of the round.","example":1384309800,"format":"int64","type":"integer"},"alertSuppressionWindows":{"items":{"description":"Alert suppression window shown in a widget.","properties":{"id":{"description":"Identifier of the alert suppression window.","example":"281474976710662","type":"string"},"name":{"description":"Name of the alert suppression window.","example":"Test dashboards","type":"string"},"testIds":{"example":["281474976710661"],"items":{"type":"string"},"type":"array","uniqueItems":true},"startTimes":{"example":["2023-05-16T10:14:28Z"],"items":{"format":"date-time","type":"string"},"type":"array"},"durationInSeconds":{"example":7200,"format":"int64","type":"integer"},"repeat":{"enum":["none","every-day","alt-every-day","every-week","every-two-week","every-month","every-three-month","custom"],"example":"custom","type":"string","$$ref":"#/components/schemas/AswRepeat"},"repeatEvery":{"example":5,"format":"int32","type":"integer"},"repeatUnit":{"enum":["day","week","month"],"example":"week","type":"string","$$ref":"#/components/schemas/AswRepeatUnit"}},"type":"object","$$ref":"#/components/schemas/ApiDashboardAsw"},"type":"array"},"totalAlerts":{"description":"Total number of active alerts within configured timespan.","example":500,"format":"int64","type":"integer"},"activeAlerts":{"description":"Total number of currently active alerts.","example":483,"format":"int64","type":"integer"},"alerts":{"items":{"description":"Alert shown in the alert list widget.","properties":{"alertId":{"description":"Identifier of the alert.","example":"2004945","type":"string"},"testId":{"description":"Identifier of the test.","example":"56512","type":"string"},"ruleId":{"description":"Identifier of the rule.","example":"281724","type":"string"},"alertSource":{"description":"Name of the agent, monitor or device producing the alert.","example":"Http Test","type":"string"},"alertRule":{"description":"Name of the alert rule that this alert belongs to.","example":"Http Test Rule","type":"string"},"alertType":{"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","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"],"type":"string","$$ref":"#/components/schemas/AlertListAlertType"},"startTime":{"description":"UTC date when the alert was first active.","example":"2023-06-02T08:54:00Z","format":"date-time","type":"string"},"durationInSeconds":{"description":"Number of seconds the alert was active. If it’s still active, this number will increase every second.","example":25,"format":"int64","type":"integer"},"active":{"description":"Set to `true` if alert is active, `false` otherwise.","example":true,"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/ApiAlertListAlert"},"type":"array"},"summary":{"description":"Summary of the agent status.","properties":{"online":{"description":"Shows the number of agents with an online status.","example":10,"format":"int32","type":"integer"},"offline":{"description":"Shows the number of agents with an offline status.","example":2,"format":"int32","type":"integer"},"disabled":{"description":"Shows the number of agents with disabled status.","example":3,"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/ApiAgentStatusSummary"},"agents":{"items":{"description":"Agent shown in agent status widget.","properties":{"agentId":{"description":"Identifier of the agent.","example":"6522","type":"string"},"status":{"description":"State of the agent.","enum":["online","offline","disabled"],"example":"online","readOnly":true,"type":"string","$$ref":"#/components/schemas/EnterpriseAgentState"},"ipInfo":{"description":"IP information of the agent.","properties":{"publicIp":{"description":"Public IP of the agent.","example":"172.58.92.31","format":"ipv4","type":"string"},"privateIp":{"description":"Private IP of the agent.","example":"172.58.92.31","format":"ipv4","type":"string"},"ipv6":{"type":"string"},"operativeSystemVersion":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiAgentStatusIpInfo"},"agentName":{"description":"Name of the agent","example":"0c3898000117","type":"string"},"location":{"description":"Location of the agent.","properties":{"latitude":{"description":"Latitude of the agent.","example":37.77493,"format":"double","type":"number"},"longitude":{"description":"Longitude of the agent.","example":-122.41942,"format":"double","type":"number"},"locationName":{"description":"Name of the agent location.","example":"San Francisco, California, US","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiAgentLocation"}},"type":"object","$$ref":"#/components/schemas/ApiAgentStatusAgent"},"type":"array"},"status":{"description":"Message for not fully configured card or no data.","example":"No data","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiWidgetsDataV2"},"startDate":{"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).","example":"2022-07-17T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"endDate":{"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).","example":"2022-07-18T22:00:54Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiWidgetData","title":"ApiWidgetData"}}