{"type":"api","title":"Get configdb metric within time-range","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Utility - Configuration DB"],"summary":"Get configdb metric within time-range","description":"By passing in the appropriate metric, it will return the values of the respective metric within the timeframe provided ","operationId":"returnMetric","parameters":[{"name":"metricName","in":"query","description":"Pass the metric name","required":true,"schema":{"type":"string"},"example":"neo4j.bolt.connections_running"},{"name":"startDate","in":"query","description":"Date in yyyy-MM-dd format or any Number format. If a number is passed, that will be the number of minutes. The start/end will be translated as \u003ccurrent date/time – minutes passed\u003e and \u003ccurrent date/time\u003e respectively.","required":true,"schema":{"type":"string"},"examples":{"yyyy-MM-dd":{"description":"yyyy-MM-dd","value":"2022-11-20"},"number (minutes)":{"description":"number (minutes)","value":10}}},{"name":"endDate","in":"query","description":"Date in yyyy-MM-dd format. The end date is given if data from multiple dates needs to be extracted. If single date data needed then endDate can be empty. endDate cannot be a previous date to the startDate.","schema":{"type":"string"},"example":"2022-11-23"},{"name":"start","in":"query","description":"Start Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":142430},{"name":"end","in":"query","description":"End Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":235830},{"name":"pageNo","in":"query","description":"Page Number","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"The numbers of items to return on given Page Number","schema":{"type":"integer","format":"int32","default":500}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","description":"timestamp in seconds","example":"123344555"},"value":{"type":"string","description":"count/value for corresponding timestamp","example":"718"}},"$$ref":"#/components/schemas/MetricData"}},"limit":{"type":"integer","description":"limit given in reqeust. By default - 500","format":"int64","example":50},"pageNo":{"type":"integer","description":"Page Number given in request. By default - 1","format":"int32","example":3},"recordsCurrentPage":{"type":"integer","description":"Records present on the current page","format":"int64","example":20},"totalPages":{"type":"integer","description":"Total Pages calculates based on limit and totalRecords values","format":"int32","example":3},"totalRecords":{"type":"integer","description":"Total count of metrics records ignoring limit","format":"int32","example":120}},"$$ref":"#/components/schemas/Neo4jMetricsResponse"}}}},"400":{"description":"Bad input parameter"},"500":{"description":"Internal Error"}},"__originalOperationId":"returnMetric","method":"get","path":"/util/configdb/metrics"}}