Retrieve raw timeseries of alerts for tags - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Retrieve raw timeseries of alerts for tags","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/280afeb1-5ea4-33e3-8618-f92d3ecedf8f","info":{"contact":{"email":"support@cisco.com","name":"Crosswork Team, Cisco"},"description":"Health Insights(HI) is a software system that provides smart KPI monitoring and remediation for service provider networks. This document contains details of the HI RESTful APIs that can be used to manage KPIs, enable/disable KPIs on groups or devices, query KPIs and device alerts, remediate alerting KPIs etc.","license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"title":"Crosswork Health Insights API","version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CAHI/health_insights_overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/hi/v1","description":"Generated server url"}],"securitySchemes":{"bearerAuth":{"description":"token","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"description":"Response is returned in a time series format. The API currently supports retrieving all alerts for specified kpis and device tags and can be filtered by alert level(s) and time duration. Pagination is supported by specifying limit and offset in the POST request arguments. If no filter parameters are passed in to the query endpoints, the API will return alerts by applying the default limit of 50 and default time interval of 1h.","operationId":"GetAlertsRawDeviceTags","requestBody":{"content":{"application/json":{"schema":{"description":"Description for pulseAlertsSeriesDtlTagsReq","example":{"device_tags":["cli"],"kpis":["pulse_cpu_threshold"],"levels":[""],"limit":"20","offset":"0","time_ago":"0m","time_interval":"1d"},"properties":{"device_tags":{"description":"device_tags","items":{"type":"string"},"title":"Optional comma separated list of devices for which alerts are being requested\nIf nothing is passed alerts for all devices are considered","type":"array"},"kpis":{"description":"kpis","items":{"type":"string"},"title":"Optional comma separated list of KPI Ids(kpi_id) to filter the alerts","type":"array"},"levels":{"description":"levels","items":{"type":"string"},"title":"Optional comma separated list of alert levels to filter the alerts\nValid values include CRITICAL,WARNING,INFO,OK","type":"array"},"limit":{"description":"limit","title":"Specifies limit on number of devices to return in a single request\ne.g if limit = 4 then the api will return alerts for 4 devices\nDefault is 50","type":"string"},"offset":{"description":"offset","title":"For pagination, specify the offset while fetching records.\ne.g.: if limit is 10, then in the first API call offset will be 0, in the 2nd call offset=10, 3rd call offset=20 etc","type":"string"},"start_time":{"description":"startTime is the timestamp returned by the api to be used in subsequent calls for pagination\nIn all subsequent calls to this api, the starttime should be sent back in the request parameters\nIn a time series DB where data is continuously being written, the startTime helps preserve the data set of a query by fixing the starttime of the data so that during pagination, data is returned from the same data set that was returned in the first API call.","type":"string"},"time_ago":{"description":"time_ago","title":"Optional start time of the Time period in terms of minutes(m) or hours(h)\ne.g if time_ago = 4 then the api wil consider alerts that came in prior to alst 4hours\nDefault is now","type":"string"},"time_interval":{"description":"time_interval","title":"Specifies the length of the time period in terms of hours or minutes\ne.g. if timeInterval = 12h, the query will aggregate all alerts for past 12 hours and so on\nDefault is 1h","type":"string"}},"title":"AlertsSeriesDtlTagsReq defines the parameters used in POST request to get raw time series of alerts for device tags","type":"object","$$ref":"#/components/schemas/pulseAlertsSeriesDtlTagsReq"}}},"description":"Response is returned in a time series format. The API currently supports retrieving all alerts for specified kpis and device tags and can be filtered by alert level(s) and time duration. Pagination is supported by specifying limit and offset in the POST request arguments. If no filter parameters are passed in to the query endpoints, the API will return alerts by applying the default limit of 50 and default time interval of 1h.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Description for pulseAlertsSeriesDtlResp","example":{},"properties":{"time_series":{"description":"time_series","type":"array","properties":{"Results":{"description":"Results","items":{"description":"Description for pulseAlert","properties":{"cdg_id":{"description":"cdg_id","title":"uuid of cdg instance which generated this alert","type":"array"},"context_json":{"description":"context_json","title":"context json provides the key fields for the alert. this is a collection of key-value\npairs what pertain to the alert like interface ID, interface bandwidth. the value of\nthese fields directly contributed to the generation of the alert","type":"array"},"id":{"description":"id","title":"id is the ssc script ID that generated the alert. It might be different from kpi id","type":"array"},"kpi_id":{"description":"kpi_id","title":"kpi id which resulted in this alert","type":"array"},"kpi_profile":{"description":"kpi_profile","title":"kpi profile id which this alert belongs to","type":"array"},"level":{"description":"level","title":"severity of the alert","type":"array"},"misc_json":{"description":"misc_json","title":"miscellaneous json is a collection of key-value pairs of fields that were available in\nthe data point but do not directly contribute to the alert","type":"array"},"msg":{"description":"msg","title":"msg generated by the alerting entity","type":"array"},"producer":{"description":"producer","title":"node_id, typically the hostname, of the device on which this alert was\ngenerated","type":"array"},"state":{"description":"state","title":"state of the alert denotes that current status of the alert itself. when set to clear\nit means that all if well and a previously raised alert has been remediated","type":"array"},"timestamp":{"description":"timestamp","format":"uint64","title":"time at which the alert was generated represented as ns since epoch","type":"array"},"uuid":{"description":"uuid","title":"UUID of the device on which this alert was generated","type":"array"}},"type":"object","$$ref":"#/components/schemas/pulseAlert"},"type":"array"}},"$$ref":"#/components/schemas/pulseAlerts"}},"type":"object","$$ref":"#/components/schemas/pulseAlertsSeriesDtlResp"}}},"description":"A successful response."},"400":{"content":{},"description":"Bad Request"}},"summary":"Retrieve raw timeseries of alerts for tags","tags":["Alerts"],"x-codegen-request-body-name":"body","__originalOperationId":"GetAlertsRawDeviceTags","security":[{"bearerAuth":[]}],"method":"post","path":"/alerts/series/alerts/deviceTags"}}