Retrieves GNSS statistics for specific metrics - Crosswork Network Controller 7.2 APIs

{"type":"api","title":"Retrieves GNSS statistics for specific metrics","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":["gnss-performance-controller"],"summary":"Retrieves GNSS statistics for specific metrics.","description":"Retrieves the GNSS statistics for the given device over a given period.","operationId":"getGnssGraph","parameters":[{"name":"metrics","in":"path","description":"A comma separated list of metric(s) to be retrieved. Possible metrics can be found by calling /crosswork/performance/v1/dashboards/gnss/metrics","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"device","in":"query","description":"The device's UUID","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"The requested start time in the format YYYY-MM-DDTHH:mm:ss.XXXZ","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","description":"The requested end time in the format YYYY-MM-DDTHH:mm:ss.XXXZ","required":false,"schema":{"type":"string"}},{"name":"timeInterval","in":"query","description":"The time interval in hours. This parameter is only required if from/to are not provided","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"The number of records to fetch","required":false,"schema":{"type":"integer","format":"int32","default":10000}},{"name":"page","in":"query","description":"The page number to fetch","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"events","in":"query","description":"True if events should be fetched for the given parameters","required":false,"schema":{"type":"boolean","default":false}},{"name":"thresholds","in":"query","description":"True if alarm thresholds definitions should be fetched for the given parameters","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"metricName":{"type":"string","description":"The metric's name.","example":"cpuUtilization"},"metricClassificationId":{"type":"string","description":"The metric's calssification/category for UI purposes.","example":"DEVICEHEALTH"},"metrics":{"type":"array","description":"The collection of samples and keys.","example":[{"keys":{"sensorName":"0/RSP0-DIE_PCH; description:Temperature Sensor","seriesName":"0/RSP0-DIE_PCH; description:Temperature Sensor","device":"b924104a-7f20-402b-b37f-937ffb47a188"},"data":[{"value":55,"timestamp":"2025-06-14T13:00:00Z"},{"value":55,"timestamp":"2025-06-14T14:00:00Z"},{"value":55,"timestamp":"2025-06-14T15:00:00Z"},{"value":55,"timestamp":"2025-06-14T16:00:00Z"}]}],"items":{"type":"object","description":"The collection of samples and keys.","example":[{"keys":{"sensorName":"0/RSP0-DIE_PCH; description:Temperature Sensor","seriesName":"0/RSP0-DIE_PCH; description:Temperature Sensor","device":"b924104a-7f20-402b-b37f-937ffb47a188"},"data":[{"value":55,"timestamp":"2025-06-14T13:00:00Z"},{"value":55,"timestamp":"2025-06-14T14:00:00Z"},{"value":55,"timestamp":"2025-06-14T15:00:00Z"},{"value":55,"timestamp":"2025-06-14T16:00:00Z"}]}],"properties":{"keys":{"type":"object","additionalProperties":{"description":"The schema's unique keys","example":{"sensorName":"0/RSP0-DIE_PCH; description:Temperature Sensor","seriesName":"0/RSP0-DIE_PCH; description:Temperature Sensor","device":"b924104a-7f20-402b-b37f-937ffb47a188"}},"description":"The schema's unique keys","example":{"sensorName":"0/RSP0-DIE_PCH; description:Temperature Sensor","seriesName":"0/RSP0-DIE_PCH; description:Temperature Sensor","device":"b924104a-7f20-402b-b37f-937ffb47a188"}},"data":{"type":"array","description":"The collection of samples.","example":[{"value":55,"timestamp":"2025-06-14T13:00:00Z"},{"value":55,"timestamp":"2025-06-14T14:00:00Z"},{"value":55,"timestamp":"2025-06-14T15:00:00Z"},{"value":55,"timestamp":"2025-06-14T16:00:00Z"}],"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"}},"$$ref":"#/components/schemas/GraphEntry"}},"avg":{"type":"number","description":"The average value of the metric for the given period and keys.","example":4.75},"min":{"type":"number","description":"The lowest value of the metric for the given period and keys.","example":4.75},"max":{"type":"number","description":"The highest value of the metric for the given period and keys.","example":4.75},"events":{"type":"array","description":"The list of events associated with this metric based of the given keys.","items":{"type":"object","description":"The list of events associated with this metric based of the given keys.","properties":{"id":{"type":"string","description":"Fault's event id.","example":123},"severity":{"type":"string","description":"The event's severity.","enum":["CRITICAL","MAJOR","MINOR","WARNING","CLEARED","INFORMATION"],"example":"CRITICAL"},"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"},"value":{"type":"number","description":"The value of the metric.","example":24.4},"correlatedAlarmId":{"type":"string","description":"Fault's alarm ID","example":5},"description":{"type":"string","description":"Fault's event description.","example":"TCA on CPU utilization. Current value: 24.4 % is above the threshold: 20 %. Policy name: \"Robot-Device-health-0250\"."}},"$$ref":"#/components/schemas/MetricEvent"}}},"$$ref":"#/components/schemas/MetricInstanceGraphEntry"}},"thresholds":{"type":"array","description":"The list of thresholds associated with this metric.","items":{"type":"object","description":"The list of thresholds associated with this metric.","properties":{"severity":{"type":"string","description":"The event's severity.","enum":["CRITICAL","MAJOR","MINOR","WARNING","CLEARED","INFORMATION"],"example":"CRITICAL"},"condition":{"type":"string","description":"The threshold's definition.","example":"≥1500"},"value":{"type":"number","description":"The value of the metric.","example":1500},"unit":{"type":"string","description":"The unit of the metric.","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"],"example":"BITS_PER_SECOND"},"seriesName":{"type":"string","description":"The label on the graph for this threshold.","example":"≥1500"}},"$$ref":"#/components/schemas/MetricThreshold"}},"avg":{"type":"number","description":"The average value of the metric for the given period.","example":4.75},"min":{"type":"number","description":"The lowest value of the metric for the given period.","example":2},"max":{"type":"number","description":"The highest value of the metric for the given period.","example":9.5},"unit":{"type":"string","description":"The unit of the metric.","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"],"example":"BITS_PER_SECOND"}},"$$ref":"#/components/schemas/GraphResponseGraphEntry"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/v1/dashboards/gnss/graph/{metrics}"}}