{"type":"api","title":"Query Summary of KPI Profiles on devices","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":{"operationId":"QueryKpiProfilesDevicesSummary","requestBody":{"content":{"application/json":{"schema":{"description":"Description for pulseKpiProfileAssocSummaryReq","example":{"devices":["RouterMilpitas","RouterSanFrancisco","RouterFremont","RouterSFO"],"limit":0,"offset":0},"properties":{"devices":{"description":"devices","items":{"type":"string"},"title":"List of devices to be enabled with the KPI profiles or to query","type":"array"},"limit":{"description":"limit","format":"int64","title":"Applies to /query endpoint\nSpecifies limit on number of devices to return in a single query request\ne.g if limit = 4 then the api will return 4 devices\nDefault is 0","type":"integer"},"offset":{"description":"offset","format":"int64","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":"integer"}},"title":"KpiProfileAssocSummaryReq contains input parameters for KPI Profile device association summary","type":"object","$$ref":"#/components/schemas/pulseKpiProfileAssocSummaryReq"}}},"description":"Query Summary of KPI Profiles on devices","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Description for pulseKpiProfileAssocSummaryResp","example":{},"properties":{"device_kpi_profiles":{"description":"device_kpi_profiles","type":"string","properties":{"devices":{"description":"devices","items":{"description":"Description for pulseKpiProfileDeviceSummary","properties":{"device_id":{"description":"device_id","title":"device id","type":"array"},"enabled_profiles_count":{"description":"enabled_profiles_count","format":"int64","title":"Enabled profiles count for device_id","type":"array"},"kpi_device_profiles":{"description":"kpi_device_profiles","items":{"description":"Description for pulseKpiProfilesSummary","properties":{"kpi_profile_id":{"description":"kpi_profile_id","title":"kpi profile id","type":"array"},"state":{"description":"state","type":"array","default":"NONE","enum":["NONE","FAILED","PARTIAL","PROCESSING","ACTIVE"],"$$ref":"#/components/schemas/pulseKpiProfilesSummaryProfileStates"}},"title":"KpiProfilesSummary Contains Profile and state","type":"object","$$ref":"#/components/schemas/pulseKpiProfilesSummary"},"title":"Contains details of kpi profiles enabled on the device","type":"array"}},"title":"KpiProfileDeviceSummary contains details of kpi profiles enabled on specific device","type":"object","$$ref":"#/components/schemas/pulseKpiProfileDeviceSummary"},"title":"Contains a set of profile device groups","type":"array"}},"title":"KpiProfileDeviceGroups contains a list of Devices and KPI profiles","$$ref":"#/components/schemas/pulseKpiProfileSummaryDevice"}},"title":"KpiProfileAssocSummaryResp contains summary of kpiprofileassoc state","type":"object","$$ref":"#/components/schemas/pulseKpiProfileAssocSummaryResp"}}},"description":"A successful response."},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"description":"Description for error","example":"Internal Server Error","type":"string","$$ref":"#/components/schemas/error"}}},"description":"Internal Server Error"}},"summary":"Query Summary of KPI Profiles on devices","tags":["KPI Profile / Device(s) Enable/Disable/Jobs"],"x-codegen-request-body-name":"body","__originalOperationId":"QueryKpiProfilesDevicesSummary","security":[{"bearerAuth":[]}],"method":"post","path":"/kpiprofileassoc/summary/query"}}