{"type":"api","title":"Get Aggregation Data By Query Monitoring Interface Statistics 3303","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_MonitoringInterfaceStatistics_3303","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24000"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/1","system","vmanage_system","eth0","loopback65528","ge0/0"],"field":"interface","type":"string","operator":"in"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}],"aggregation":{"field":[{"property":"interface","sequence":1}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"rx_kbps","type":"avg"},{"property":"tx_kbps","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"entry_time":{"type":"string"},"interface":{"type":"string"},"rx_kbps":{"type":"number"},"tx_kbps":{"type":"number"},"vdevice_name":{"type":"string"}},"$$ref":"#/components/schemas/InterfaceAggResp"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"number of alarms to be fetched","format":"int64"},"endTime":{"type":"integer","description":"end time of alarms to be fetched","format":"int64"},"startTime":{"type":"integer","description":"start time of alarms to be fetched","format":"int64"}},"$$ref":"#/components/schemas/PageInfo"}},"description":"interface aggregation response with page info","$$ref":"#/components/schemas/InterfaceAggRespWithPageInfo"}},"examples":{"Aggregated Data":{"description":"Aggregated Data","value":[{"entry_time":1673766000000,"count":1,"interface":"eth0","tx_kbps":0,"rx_kbps":1},{"entry_time":1673766000000,"count":1,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"eth0","tx_kbps":1.8333333333333333,"rx_kbps":0.8333333333333334},{"entry_time":1673769600000,"count":6,"interface":"ge0/0","tx_kbps":0.3333333333333333,"rx_kbps":2.8333333333333335},{"entry_time":1673769600000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":2,"interface":"system","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"ge0/0","tx_kbps":5,"rx_kbps":48.833333333333336},{"entry_time":1673771400000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/statistics/interface/aggregation"}}