{"type":"api","title":"Retrieve raw timeseries, summary of Impacted KPIs","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 retrieves a time series of the count of any new KPIs that received alerts in Critical and Major severity in the past minute during past 1hour only. A maximum total of 60 time series data points can be retreived from this api. 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 data by applying the default limit of 50 and default time interval of 1h.","operationId":"GetAlertsKpiSummary","requestBody":{"content":{"application/json":{"schema":{"description":"Description for pulseAlertsSeriesSummaryReq","example":{"limit":"20","offset":"0","time_ago":"0m","time_interval":"1d"},"properties":{"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"},"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":"AlertsSeriesSummaryReq defines the parameters used in POST request to get raw time series of a summary view of Impacted devices and Impacted KPIs (Crosswork UI landing page)","type":"object","$$ref":"#/components/schemas/pulseAlertsSeriesSummaryReq"}}},"description":"A successful response.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Description for pulseAlertsSeriesResp","example":{"devices":["RouterSFO"],"kpis":["pulse_cpu_threshold"],"levels":[""],"limit":"20","offset":"0","time_ago":"0m","time_interval":"1d"},"properties":{"series":{"description":"series","items":{"description":"Description for pulseAlertSummaryTS","properties":{"alerts":{"description":"alerts","items":{"description":"Description for pulseTimeCount","properties":{"alert":{"description":"alert","format":"int64","title":"alert is a count of alerts at the corresponding time","type":"array"},"time":{"description":"time","format":"uint64","title":"time is the timestamp corresponding to alerts","type":"array"}},"title":"TimeCount is a time series that contains count of alerts by time","type":"object","$$ref":"#/components/schemas/pulseTimeCount"},"title":"alerts is a count of alerts by time","type":"array"},"level":{"description":"level","title":"level is the level of an alert","type":"array"}},"title":"AlertSummaryTS is a time series that contains count of alerts by time for each alert level","type":"object","$$ref":"#/components/schemas/pulseAlertSummaryTS"},"title":"series contains time series of alert summary by levels","type":"array"}},"type":"object","$$ref":"#/components/schemas/pulseAlertsSeriesResp"}}},"description":"A successful response."},"400":{"content":{},"description":"Bad Request"}},"summary":"Retrieve raw timeseries, summary of Impacted KPIs","tags":["Alerts"],"x-codegen-request-body-name":"body","__originalOperationId":"GetAlertsKpiSummary","security":[{"bearerAuth":[]}],"method":"post","path":"/alerts/series/kpi"}}