{"type":"api","title":"Overall system histogram for a specific metric","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/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.2.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/performance-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{{server}}:30603/crosswork/performance","description":"Generated server url"}]},"spec":{"tags":["metric-histogram-controller"],"summary":"Overall system histogram for a specific metric.","description":"The data is displayed for a specific metric over a given period.It can be filtered for a specific device group or port group. Supported metrics are listed under 'dashboards-metrics' API","operationId":"getHistogram","parameters":[{"name":"metric","in":"query","description":"The metric name for which to rerieve the histogram in the format: SCHEMA_metricName","required":true,"schema":{"type":"string"}},{"name":"deviceGroup","in":"query","description":"The device group by which to filter the result","required":false,"schema":{"type":"string"}},{"name":"portGroup","in":"query","description":"The port group(s) by which to filter the result","required":false,"schema":{"type":"string"}},{"name":"matchCos","in":"query","description":"QoS match line in a packet's Class of Service. Valid value is a number between 0-7 (including)","required":false,"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"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"metricName":{"type":"string"},"metricUnit":{"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","MICROSECONDS","MILLISECONDS","SECONDS"]},"elementCount":{"type":"integer","format":"int64"},"healthy":{"type":"object","properties":{"categoryName":{"type":"string"},"seriesName":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number","description":"The value of the metric.","example":3.75},"timestamp":{"type":"string","description":"The time of the sample in the format of DateTimeFormatter.ISO_OFFSET_DATE_TIME with locale","example":"2025-06-11T12:00:00Z"},"stackedValue":{"type":"number"}},"$$ref":"#/components/schemas/StackedGraphEntry"}},"count":{"type":"integer","format":"int64"},"avgCount":{"type":"integer","format":"int64"},"minCount":{"type":"integer","format":"int64"},"maxCount":{"type":"integer","format":"int64"}},"$$ref":"#/components/schemas/StackedMetricInstance"},"minor":{"type":"object","properties":{"categoryName":{"type":"string"},"seriesName":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number","description":"The value of the metric.","example":3.75},"timestamp":{"type":"string","description":"The time of the sample in the format of DateTimeFormatter.ISO_OFFSET_DATE_TIME with locale","example":"2025-06-11T12:00:00Z"},"stackedValue":{"type":"number"}},"$$ref":"#/components/schemas/StackedGraphEntry"}},"count":{"type":"integer","format":"int64"},"avgCount":{"type":"integer","format":"int64"},"minCount":{"type":"integer","format":"int64"},"maxCount":{"type":"integer","format":"int64"}},"$$ref":"#/components/schemas/StackedMetricInstance"},"major":{"type":"object","properties":{"categoryName":{"type":"string"},"seriesName":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number","description":"The value of the metric.","example":3.75},"timestamp":{"type":"string","description":"The time of the sample in the format of DateTimeFormatter.ISO_OFFSET_DATE_TIME with locale","example":"2025-06-11T12:00:00Z"},"stackedValue":{"type":"number"}},"$$ref":"#/components/schemas/StackedGraphEntry"}},"count":{"type":"integer","format":"int64"},"avgCount":{"type":"integer","format":"int64"},"minCount":{"type":"integer","format":"int64"},"maxCount":{"type":"integer","format":"int64"}},"$$ref":"#/components/schemas/StackedMetricInstance"},"critical":{"type":"object","properties":{"categoryName":{"type":"string"},"seriesName":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number","description":"The value of the metric.","example":3.75},"timestamp":{"type":"string","description":"The time of the sample in the format of DateTimeFormatter.ISO_OFFSET_DATE_TIME with locale","example":"2025-06-11T12:00:00Z"},"stackedValue":{"type":"number"}},"$$ref":"#/components/schemas/StackedGraphEntry"}},"count":{"type":"integer","format":"int64"},"avgCount":{"type":"integer","format":"int64"},"minCount":{"type":"integer","format":"int64"},"maxCount":{"type":"integer","format":"int64"}},"$$ref":"#/components/schemas/StackedMetricInstance"}},"$$ref":"#/components/schemas/HistogramResponse"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/v1/dashboards/histogram"}}