Retrieve individual column data from multi-metric table widget - ThousandEyes API v7

{"type":"api","title":"Retrieve individual column data from multi-metric table widget","meta":{"id":"/apps/pubhub/media/000-v7-apis/3dd1d908714132ba5e7ccb5fae34e2a525a1052a/0e4c66ca-115a-3769-be5b-c6944add743f","info":{"description":"Manage ThousandEyes Dashboards.","title":"Dashboards API","version":"7.0.72"},"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":"Returns the raw data for an individual column within a multi-metric table widget in the dashboard.\n","operationId":"getIndividualColumnData","parameters":[{"description":"A Identifier for a dashboard which can be obtained from the `/dashboards` endpoint.","example":"646f4d2ce3c99b0536c3821e","explode":false,"in":"path","name":"dashboardId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"A Identifier for a widget.","example":"unpmg","explode":false,"in":"path","name":"widgetId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"An identifier for a column within the multi-metric table widget.","example":"col123","explode":false,"in":"path","name":"columnId","required":true,"schema":{"type":"string"},"style":"simple"},{"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.","in":"query","name":"aid","required":false,"schema":{"example":"1234","type":"string"}},{"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`.","in":"query","name":"window","schema":{"example":"12h","pattern":"^\\d+(?:[smhdw]{1})?$","type":"string"}},{"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`.","in":"query","name":"startDate","schema":{"example":"2022-07-17T22:00:54Z","format":"date-time","type":"string"}},{"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`.","in":"query","name":"endDate","schema":{"example":"2022-07-18T22:00:54Z","format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/hal+json":{"schema":{"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"},"_links":{"description":"A links object containing the self link.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"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.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/SelfLinks"}},"type":"object","$$ref":"#/components/schemas/ApiMultiMetricColumnData"}}},"description":"OK"},"400":{"content":{"application/problem+json":{"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"}]},"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"},"errors":{"description":"(Optional) When multiple errors occur, the details for each error are listed.","items":{"properties":{"code":{"description":"(Optional) A unique error type/code that can be referenced in the documentation for further details.","type":"string"},"field":{"description":"Identifies the field that triggered this particular error.","type":"string"},"message":{"description":"A short, human-readable summary of the error.","type":"string"}},"type":"object","$$ref":"#/components/schemas/ValidationErrorItem"},"nullable":true,"type":"array"}},"type":"object","$$ref":"#/components/schemas/ValidationError"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"properties":{"error":{"example":"invalid_token","type":"string"},"error_description":{"example":"Invalid access token","type":"string"}},"type":"object","$$ref":"#/components/schemas/UnauthorizedError"}}},"description":"Unauthorized"},"403":{"content":{"application/problem+json":{"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Insufficient permissions to query endpoint"},"404":{"content":{"application/problem+json":{"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"},"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Not found"},"429":{"content":{"application/problem+json":{"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Exhausted rate limit for the organization"},"500":{"content":{"application/problem+json":{"example":{"type":"about:blank","title":"Internal server error","status":500,"detail":"Optional detail about the internal error message.","instance":"/v7"},"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Internal server error"}},"summary":"Retrieve individual column data from multi-metric table widget","tags":["Dashboards"],"__originalOperationId":"getIndividualColumnData","security":[{"BearerAuth":[]}],"method":"get","path":"/dashboards/{dashboardId}/widgets/{widgetId}/columns/{columnId}"}}