Data Usage - Cisco Catalyst SD-WAN Manager API, Release 20.18 - Cisco DevNet

{"type":"api","title":"Data Usage","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Overview - Cellular"],"description":"Cellular DataUsage Dashlet","operationId":"dataUsage","parameters":[{"name":"lastNHours","in":"query","description":"last N hours","schema":{"type":"string","enum":["1","3","6","12","24"]}},{"name":"drillDown","in":"query","description":"drill down","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"CARRIER_NAME":{"type":"object","properties":{"carrierName":{"type":"string","example":"Verizon"},"deviceList":{"type":"array","items":{"type":"object","properties":{"activeSim":{"type":"string","example":"0"},"carrier":{"type":"string","example":"vedge"},"deviceType":{"type":"string","example":"vedge"},"hostName":{"type":"string","example":"vedge"},"ifName":{"type":"string","example":"vedge"},"linkUpTime":{"type":"string","example":"0"},"localSystemIp":{"type":"string","example":"0"},"model":{"type":"string","example":"vedge"},"product":{"type":"string","example":"0"},"rat":{"type":"string","example":"vedge"},"slot":{"type":"string","example":"0"},"systemIp":{"type":"string","example":"0"},"totalKbs":{"type":"integer","format":"int32","example":0},"uuid":{"type":"string","example":"vedge"}},"$$ref":"#/components/schemas/CellularDeviceDetail"}},"monthUsage":{"type":"object","properties":{"carrierName":{"type":"string","example":"Verizon"},"deviceList":{"type":"array","items":{"type":"object","properties":{"activeSim":{"type":"string","example":"0"},"carrier":{"type":"string","example":"vedge"},"deviceType":{"type":"string","example":"vedge"},"hostName":{"type":"string","example":"vedge"},"ifName":{"type":"string","example":"vedge"},"linkUpTime":{"type":"string","example":"0"},"localSystemIp":{"type":"string","example":"0"},"model":{"type":"string","example":"vedge"},"product":{"type":"string","example":"0"},"rat":{"type":"string","example":"vedge"},"slot":{"type":"string","example":"0"},"systemIp":{"type":"string","example":"0"},"totalKbs":{"type":"integer","format":"int32","example":0},"uuid":{"type":"string","example":"vedge"}},"$$ref":"#/components/schemas/CellularDeviceDetail"}},"totalUsage":{"type":"integer","format":"int32","example":2262628}},"$$ref":"#/components/schemas/CellularDataUsageDetailsItem"},"oneDayUsage":{"type":"object","properties":{"carrierName":{"type":"string","example":"Verizon"},"deviceList":{"type":"array","items":{"type":"object","properties":{"activeSim":{"type":"string","example":"0"},"carrier":{"type":"string","example":"vedge"},"deviceType":{"type":"string","example":"vedge"},"hostName":{"type":"string","example":"vedge"},"ifName":{"type":"string","example":"vedge"},"linkUpTime":{"type":"string","example":"0"},"localSystemIp":{"type":"string","example":"0"},"model":{"type":"string","example":"vedge"},"product":{"type":"string","example":"0"},"rat":{"type":"string","example":"vedge"},"slot":{"type":"string","example":"0"},"systemIp":{"type":"string","example":"0"},"totalKbs":{"type":"integer","format":"int32","example":0},"uuid":{"type":"string","example":"vedge"}},"$$ref":"#/components/schemas/CellularDeviceDetail"}},"totalUsage":{"type":"integer","format":"int32","example":2262628}},"$$ref":"#/components/schemas/CellularDataUsageDetailsItem"},"threeMonthUsage":{"type":"object","properties":{"carrierName":{"type":"string","example":"Verizon"},"deviceList":{"type":"array","items":{"type":"object","properties":{"activeSim":{"type":"string","example":"0"},"carrier":{"type":"string","example":"vedge"},"deviceType":{"type":"string","example":"vedge"},"hostName":{"type":"string","example":"vedge"},"ifName":{"type":"string","example":"vedge"},"linkUpTime":{"type":"string","example":"0"},"localSystemIp":{"type":"string","example":"0"},"model":{"type":"string","example":"vedge"},"product":{"type":"string","example":"0"},"rat":{"type":"string","example":"vedge"},"slot":{"type":"string","example":"0"},"systemIp":{"type":"string","example":"0"},"totalKbs":{"type":"integer","format":"int32","example":0},"uuid":{"type":"string","example":"vedge"}},"$$ref":"#/components/schemas/CellularDeviceDetail"}},"totalUsage":{"type":"integer","format":"int32","example":2262628}},"$$ref":"#/components/schemas/CellularDataUsageDetailsItem"},"totalUsage":{"type":"integer","format":"int32","example":2262627},"weekUsage":{"type":"object","properties":{"carrierName":{"type":"string","example":"Verizon"},"deviceList":{"type":"array","items":{"type":"object","properties":{"activeSim":{"type":"string","example":"0"},"carrier":{"type":"string","example":"vedge"},"deviceType":{"type":"string","example":"vedge"},"hostName":{"type":"string","example":"vedge"},"ifName":{"type":"string","example":"vedge"},"linkUpTime":{"type":"string","example":"0"},"localSystemIp":{"type":"string","example":"0"},"model":{"type":"string","example":"vedge"},"product":{"type":"string","example":"0"},"rat":{"type":"string","example":"vedge"},"slot":{"type":"string","example":"0"},"systemIp":{"type":"string","example":"0"},"totalKbs":{"type":"integer","format":"int32","example":0},"uuid":{"type":"string","example":"vedge"}},"$$ref":"#/components/schemas/CellularDeviceDetail"}},"totalUsage":{"type":"integer","format":"int32","example":2262628}},"$$ref":"#/components/schemas/CellularDataUsageDetailsItem"}},"$$ref":"#/components/schemas/CellularDataUsageDetails"},"details":{"type":"array","items":{"type":"object","properties":{"carrierName":{"type":"string","example":"Verizon"},"totalUsage":{"type":"integer","format":"int32","example":2262627}},"$$ref":"#/components/schemas/CellularDataUsageBasicItem"}}},"$$ref":"#/components/schemas/CellularDataUsage"}},"examples":{"Cellular dataUsage basic":{"description":"Cellular dataUsage basic","value":{"details":[{"carrierName":"ATT","totalUsage":0},{"carrierName":"Verizon","totalUsage":60}]},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellulardatausagebasic"},"Cellular dataUsage detail":{"description":"Cellular dataUsage detail","value":{"ATT":{"monthUsage":{"carrierName":"ATT","deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot1","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"4679","ifName":"Cellular0/1/0","slot":"1","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":0,"carrier":"ATT","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"totalUsage":0},"carrierName":"ATT","weekUsage":{"carrierName":"ATT","deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot1","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"4679","ifName":"Cellular0/1/0","slot":"1","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":0,"carrier":"ATT","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"totalUsage":0},"deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot1","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"4679","ifName":"Cellular0/1/0","slot":"1","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":0,"carrier":"ATT","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"oneDayUsage":{"carrierName":"ATT","deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot1","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"4679","ifName":"Cellular0/1/0","slot":"1","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":0,"carrier":"ATT","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"totalUsage":0},"totalUsage":0,"threeMonthUsage":{"carrierName":"ATT","deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot1","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"4679","ifName":"Cellular0/1/0","slot":"1","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":0,"carrier":"ATT","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"totalUsage":0}},"Verizon":{"monthUsage":{"carrierName":"Verizon","deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot2","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"9530","ifName":"Cellular0/2/0","slot":"2","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":65811,"carrier":"Verizon","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"totalUsage":65811},"carrierName":"Verizon","weekUsage":{"carrierName":"Verizon","deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot2","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"9530","ifName":"Cellular0/2/0","slot":"2","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":15244,"carrier":"Verizon","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"totalUsage":15244},"deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot2","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"14210","ifName":"Cellular0/2/0","slot":"2","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":62,"carrier":"Verizon","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"oneDayUsage":{"carrierName":"Verizon","deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot2","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"14210","ifName":"Cellular0/2/0","slot":"2","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":1855,"carrier":"Verizon","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"totalUsage":1855},"totalUsage":62,"threeMonthUsage":{"carrierName":"Verizon","deviceList":[{"deviceType":"vedge","activeSim":"0","hostName":"C8300-Vivek1-Slot2","product":"Network Interface Modules (NIMs)","rat":"4G","linkUpTime":"9530","ifName":"Cellular0/2/0","slot":"2","uuid":"C8300-1N1S-6T-FDO2402A01W","totalKbs":187349,"carrier":"Verizon","localSystemIp":"1.1.1.218","model":"C8300-1N1S-6T","systemIp":"1.1.1.218"}],"totalUsage":187349}}},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceCellularCellularrestfulresourceResponseExampleCellulardatausagedrilldown"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write","method":"get","path":"/device/cellular/dataUsage"}}