{"type":"api","title":"Get Device 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":["Secure Device OnBoarding - Provider Credentials"],"description":"Get device data usage using device uuid","operationId":"getDeviceDataUsage","parameters":[{"name":"deviceUUID","in":"path","description":"DeviceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["carrierName","communicationPlan","controllerId","currentDataUsage","iccid","ratePlan","ratePlanType","slotId"],"type":"object","properties":{"carrierName":{"type":"string","description":"Name of the service provider.","example":"Singtel"},"communicationPlan":{"type":"string","description":"Name of the communication plan.","example":"vm cp sms data share"},"controllerId":{"type":"string","description":"Controller Id","example":"1"},"currentDataUsage":{"type":"string","description":"Current Data Usage.","example":"10MB"},"errorDetails":{"type":"string","description":"Details of any error encountered while retrieving device data usage","example":"No eSIM ICCIDs found"},"esimStatus":{"type":"string","description":"Bootstrap eSim Status","example":"ACTIVATED"},"iccid":{"type":"string","description":"Identifier of the eSIM device.","example":"8988216716970004975"},"isBootstrap":{"type":"boolean","description":"Boolean flag that indicated if ICCID is on bootstrap account"},"otherEsimsDataUsage":{"type":"string","description":"Total data used by other eSIM devices.","example":"20MB"},"ratePlan":{"type":"string","description":"Name of the rate plan.","example":"vm fixed pool rp"},"ratePlanDataUsageLimit":{"type":"string","description":"Rate plan usage limit.","example":"50MB"},"ratePlanType":{"type":"string","description":"Rate plan type.","example":"Monthly - Pooled Subscriber"},"slotId":{"type":"integer","description":"Slot Id","format":"int32"},"totalDataUsage":{"type":"string","description":"Total data usage","example":"30MB"},"usageThresholdWarning":{"type":"array","description":"Total value of current data usage and data used by other eSIM devices","example":"Data Usage has reached or exceeded the threshold limit of 90%.","items":{"type":"string","description":"Total value of current data usage and data used by other eSIM devices","example":"Data Usage has reached or exceeded the threshold limit of 90%."}}},"$$ref":"#/components/schemas/DeviceUsageDetails"},"examples":{"Device Usage Response Example":{"description":"Device Usage Response Example","value":"[{\n \"iccid\": \"8988216716970004975\",\n \"carrierName\": \"Singtel\",\n \"ratePlan\":\"hphlr rp1\" ,\n \"communicationPlan\": \"vm cp sms data shared\",\n \"ratePlanType\":\"Monthly - Pooled Subscriber\",\n \"currentDataUsage\":\"10MB\",\n \"ratePlanUsageLimit\": \"50MB\",\n \"otherEsimsDataUsage\": \"20MB\",\n }]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read","method":"get","path":"/v1/securedeviceonboarding/{deviceUUID}/deviceusage"}}