Get business bandwidth usage
Returns bandwidth usage statistics for the specified time period, including inbound, outbound, and peak usage metrics.
Use Cases:
- Monitor bandwidth consumption
- Capacity planning
- Billing validation
- Performance analysis
- Generate usage reports
Data Accuracy:
- Daily data: Updated every hour
- Monthly data: Aggregated from daily statistics
- Peak usage tracked at 5-minute intervals
- Monitor bandwidth consumption
- Capacity planning
- Billing validation
- Performance analysis
- Generate usage reports
- Daily data: Updated every hour
- Monthly data: Aggregated from daily statistics
- Peak usage tracked at 5-minute intervals
Authorizations
JWT token obtained from Xerobi account dashboard
Headers
API version in YYYY-MM-DD format. Current version: 2026-01-01
^\d{4}-\d{2}-\d{2}$"2026-01-01"
Query Parameters
Time period for bandwidth usage. Use 'daily' for current day statistics or 'monthly' for current billing cycle.
daily, monthly Response
Successfully retrieved bandwidth usage
Bandwidth usage statistics for business clients
Time period for the usage data
daily, monthly "monthly"
Inbound bandwidth in gigabytes
x >= 01250.5
Outbound bandwidth in gigabytes
x >= 02340.8
Total bandwidth (in + out) in gigabytes
x >= 03591.3
Period start date
"2026-01-01"
Period end date
"2026-01-31"
Peak bandwidth usage in Mbps during period
850.5