Retrieves PTP statistics on specific metrics - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Retrieves PTP statistics on specific metrics","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":["ptp-performance-controller"],"summary":"Retrieves PTP statistics on specific metrics.","description":"Retrieves the PTP statistics for the given device over a given period.","operationId":"getPTPGraph","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/ptp/metrics","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"device","in":"query","description":"The device's UUID","required":true,"schema":{"type":"string"}},{"name":"ptpClockTypeIndex","in":"query","description":"The PTP clock type. One of: ordinaryClock(1), boundaryClock(2),transparentClock(3),boundaryNode(4)","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"ptpClockInstanceIndex","in":"query","description":"The PTP clock instance","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"ptpClockPortNumberIndex","in":"query","description":"The PTP port number","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"ptpClockDomainIndex","in":"query","description":"The PTP domain number","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"ptpClockPortRole","in":"query","description":"Describes the current role (primary/client) of the port","required":false,"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"},"metricClassificationId":{"type":"string"},"metrics":{"type":"array","items":{"type":"object","properties":{"keys":{"type":"object","additionalProperties":{"type":"object"}},"data":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"timestamp":{"type":"string"},"state":{"type":"string","enum":["HEALTHY","MINOR","MAJOR","CRITICAL"]}},"$$ref":"#/components/schemas/GraphEntryWithHealth"}},"avg":{"type":"number"},"min":{"type":"number"},"max":{"type":"number"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"severity":{"type":"string","enum":["CRITICAL","MAJOR","MINOR","WARNING","CLEARED","INFORMATION"]},"timestamp":{"type":"string"},"value":{"type":"number"},"correlatedAlarmId":{"type":"string"},"description":{"type":"string"}},"$$ref":"#/components/schemas/MetricEvent"}}},"$$ref":"#/components/schemas/MetricInstanceGraphEntryWithHealth"}},"thresholds":{"type":"array","items":{"type":"object","properties":{"severity":{"type":"string","enum":["CRITICAL","MAJOR","MINOR","WARNING","CLEARED","INFORMATION"]},"condition":{"type":"string"},"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"]},"seriesName":{"type":"string"}},"$$ref":"#/components/schemas/MetricThreshold"}},"avg":{"type":"number"},"min":{"type":"number"},"max":{"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/GraphResponseGraphEntryWithHealth"}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"__originalOperationId":"getPTPGraph","method":"get","path":"/v1/dashboards/ptp/graph/{metrics}"}}