{"type":"model","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":"Description for pulseTxnResultQueryReq","example":{"descending_order":true,"device_id":"RouterSanFrancisco","end_time":"1585202281518486500","error":"nso","kpi_id":"Ethernet port packet statistics","kpi_profile_id":"layer1traffic","kpi_type":"KPI","limit":0,"offset":0,"sort_by":"state","start_time":"1585198526801108200","state":"Failed","tx_id":"39"},"properties":{"descending_order":{"description":"descending_order","title":"Sort order. Default is ascending","type":"boolean"},"device_id":{"description":"device_id","title":"Pulse Device ID","type":"string"},"end_time":{"description":"end_time","format":"int64","title":"Timestamp for end time","type":"string"},"error":{"description":"error","title":"Error","type":"string"},"kpi_id":{"description":"kpi_id","title":"Pulse KPI ID","type":"string"},"kpi_profile_id":{"description":"kpi_profile_id","title":"Pulse KPI profile ID","type":"string"},"kpi_type":{"description":"kpi_type","title":"Pulse KPI type","type":"string"},"limit":{"description":"limit","title":"Specifies limit on number of rows to return in a single request\ne.g if limit = 4 then the api will return 4 rows\nDefault is 10","type":"integer"},"offset":{"description":"offset","format":"int32","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"},"sort_by":{"description":"sort_by","title":"Sort field name","type":"string"},"start_time":{"description":"start_time","title":"Timestamp for start time","type":"string"},"state":{"description":"state","title":"Transaction State","type":"string"},"tx_id":{"description":"tx_id","format":"int64","title":"Transactin ID","type":"string"}},"title":"pulseTxnResultQueryReq","type":"object","$$ref":"#/components/schemas/pulseTxnResultQueryReq"}}