Skip to main content
GET
/
business
/
usage
/
bandwidth
Get business bandwidth usage
curl --request GET \
  --url https://api.hixbe.com/fiber/business/usage/bandwidth \
  --header 'Authorization: Bearer <token>' \
  --header 'Hixe-Version: <hixe-version>'
{
  "period": "monthly",
  "in_gb": 1250.5,
  "out_gb": 2340.8,
  "total_gb": 3591.3,
  "start_date": "2026-01-01",
  "end_date": "2026-01-31",
  "peak_usage_mbps": 850.5
}
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

Authorizations

​
Authorization
string
header
required

JWT token obtained from Hixbe account dashboard

Headers

​
Hixe-Version
string
required

API version in YYYY-MM-DD format. Current version: 2026-01-01

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-01-01"

Query Parameters

​
period
enum<string>
required

Time period for bandwidth usage. Use 'daily' for current day statistics or 'monthly' for current billing cycle.

Available options:
daily,
monthly

Response

Successfully retrieved bandwidth usage

Bandwidth usage statistics for business clients

​
period
enum<string>
required

Time period for the usage data

Available options:
daily,
monthly
Example:

"monthly"

​
in_gb
number
required

Inbound bandwidth in gigabytes

Required range: x >= 0
Example:

1250.5

​
out_gb
number
required

Outbound bandwidth in gigabytes

Required range: x >= 0
Example:

2340.8

​
total_gb
number

Total bandwidth (in + out) in gigabytes

Required range: x >= 0
Example:

3591.3

​
start_date
string<date>

Period start date

Example:

"2026-01-01"

​
end_date
string<date>

Period end date

Example:

"2026-01-31"

​
peak_usage_mbps
number

Peak bandwidth usage in Mbps during period

Example:

850.5