Get consumer usage stats
Returns data usage statistics including daily and monthly consumption. Usage data is updated approximately every 15 minutes.
Use Cases:
- Monitor data consumption
- Display usage graphs in customer portal
- Check against data caps (if applicable)
GET
Get consumer usage stats
Returns data usage statistics including daily and monthly consumption. Usage data is updated approximately every 15 minutes.
Use Cases:
- Monitor data consumption
- Display usage graphs in customer portal
- Check against data caps (if applicable)
Authorizations
JWT token obtained from Xerobi account dashboard
Headers
API version in YYYY-MM-DD format. Current version: 2026-01-01
Pattern:
^\d{4}-\d{2}-\d{2}$Example:
"2026-01-01"
Response
Successfully retrieved usage statistics
Data usage statistics for consumer account
Data used today in gigabytes
Required range:
x >= 0Example:
12.5
Data used this billing cycle in gigabytes
Required range:
x >= 0Example:
387.2
Monthly data cap in gigabytes (null if unlimited)
Example:
null
Timestamp of last usage update (ISO 8601 format)
Example:
"2026-01-15T14:30:00Z"