{"type":"api","title":"Top N system summary","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/f117fa98-ad23-3ca8-adf8-21349b86b3ff","info":{"title":"Crosswork Performance APIs","description":"Performance APIs allow the user to perform CRUD operations on performance service","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/performance-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"http://localhost:8080/crosswork/performance","description":"Generated server url"}]},"spec":{"tags":["metric-summary-controller"],"summary":"Top N system summary.","description":"Top N summary for a specific metric over a given period divided to device groups.Supported metrics are listed under 'dashboards-metrics' API","operationId":"getTopNSummary","parameters":[{"name":"metric","in":"query","description":"The metric name in the format: SCHEMA_metricName","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"The time interval start time in the format YYYY-MM-DDTHH:mm:ss.XXXZ","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"The time interval end time in the format YYYY-MM-DDTHH:mm:ss.XXXZ","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The page number to fetch","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"metricName":{"type":"string"},"unit":{"type":"string","enum":["NUMBER","KNUMBER","MNUMBER","GNUMBER","PACKETS","KPACKETS","MPACKETS","GPACKETS","TPACKETS","PPACKETS","PACKETS_PER_SECOND","KPACKETS_PER_SECOND","MPACKETS_PER_SECOND","GPACKETS_PER_SECOND","BYTES","KBYTES","MBYTES","GBYTES","TBYTES","PBYTES","BYTES_PER_SECOND","KBYTES_PER_SECOND","MBYTES_PER_SECOND","GBYTES_PER_SECOND","TBYTES_PER_SECOND","BITS","KBITS","MBITS","GBITS","TBITS","PBITS","BITS_PER_SECOND","KBITS_PER_SECOND","MBITS_PER_SECOND","GBITS_PER_SECOND","WATTS","KWATTS","MWATTS","KWATTS_PER_DAY","MWATTS_PER_DAY","MILLIAMP","AMP","PERCENTAGE","CELSIUS","VOLT","DBM","DB","DBQ"]},"entries":{"type":"array","items":{"type":"object","properties":{"groupname":{"type":"string"},"groupuuid":{"type":"string"},"total":{"type":"number"},"display":{"type":"object","properties":{"value":{"type":"number"},"unit":{"type":"string","enum":["NUMBER","KNUMBER","MNUMBER","GNUMBER","PACKETS","KPACKETS","MPACKETS","GPACKETS","TPACKETS","PPACKETS","PACKETS_PER_SECOND","KPACKETS_PER_SECOND","MPACKETS_PER_SECOND","GPACKETS_PER_SECOND","BYTES","KBYTES","MBYTES","GBYTES","TBYTES","PBYTES","BYTES_PER_SECOND","KBYTES_PER_SECOND","MBYTES_PER_SECOND","GBYTES_PER_SECOND","TBYTES_PER_SECOND","BITS","KBITS","MBITS","GBITS","TBITS","PBITS","BITS_PER_SECOND","KBITS_PER_SECOND","MBITS_PER_SECOND","GBITS_PER_SECOND","WATTS","KWATTS","MWATTS","KWATTS_PER_DAY","MWATTS_PER_DAY","MILLIAMP","AMP","PERCENTAGE","CELSIUS","VOLT","DBM","DB","DBQ"]}},"$$ref":"#/components/schemas/DisplayDTO"}},"$$ref":"#/components/schemas/TopNSummaryRow"}}},"$$ref":"#/components/schemas/TopNSummaryResponse"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"__originalOperationId":"getTopNSummary","method":"get","path":"/v1/dashboards/summary/topN"}}