> ## Documentation Index > Fetch the complete documentation index at: https://docs.xerobi.com/llms.txt > Use this file to discover all available pages before exploring further. # 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 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 ## OpenAPI ````yaml GET /business/usage/bandwidth openapi: 3.1.0 info: title: Xerobi Fiber API description: >- API for Xerobi Fiber customers and business clients. ## Overview The Xerobi Fiber API provides two distinct interfaces: - **Consumer API**: Simple, user-friendly endpoints for residential customers to check their network status, account details, usage statistics, and run speed tests. - **Business API**: Advanced endpoints for enterprise clients to manage IP assignments, monitor bandwidth usage, and automate network operations. ## Authentication All endpoints require Bearer token authentication. Include your JWT token in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` Tokens can be obtained from your Xerobi account dashboard. ## Versioning All requests must include the `Hixe-Version` header with the API version date (format: YYYY-MM-DD). Current version: `2026-01-01` ## Rate Limiting - Consumer endpoints: 100 requests per minute - Business endpoints: 1000 requests per minute Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests allowed - `X-RateLimit-Remaining`: Requests remaining in current window - `X-RateLimit-Reset`: Unix timestamp when the limit resets version: '2026-01-01' contact: name: Xerobi API Support email: support@xerobi.com url: https://support.hixbe.com license: name: Proprietary url: https://hixbe.com/terms servers: - url: https://api.hixbe.com/fiber description: Production API security: - bearerAuth: [] tags: - name: Consumer description: Endpoints for residential customers - name: Business description: Endpoints for enterprise clients paths: /business/usage/bandwidth: get: tags: - Business summary: Get business bandwidth usage description: >- 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 operationId: getBusinessBandwidthUsage parameters: - $ref: '#/components/parameters/hixeVersionHeader' - name: period in: query required: true description: >- Time period for bandwidth usage. Use 'daily' for current day statistics or 'monthly' for current billing cycle. schema: type: string enum: - daily - monthly example: monthly responses: '200': description: Successfully retrieved bandwidth usage content: application/json: schema: $ref: '#/components/schemas/BandwidthUsage' examples: monthly: summary: Monthly bandwidth usage value: 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 daily: summary: Daily bandwidth usage value: period: daily in_gb: 45.2 out_gb: 78.3 total_gb: 123.5 start_date: '2026-01-15' end_date: '2026-01-15' peak_usage_mbps: 650.2 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '429': $ref: '#/components/responses/RateLimitError' components: parameters: hixeVersionHeader: name: Hixe-Version in: header description: 'API version in YYYY-MM-DD format. Current version: 2026-01-01' required: true schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ example: '2026-01-01' schemas: BandwidthUsage: type: object description: Bandwidth usage statistics for business clients properties: period: type: string description: Time period for the usage data enum: - daily - monthly example: monthly in_gb: type: number description: Inbound bandwidth in gigabytes example: 1250.5 minimum: 0 out_gb: type: number description: Outbound bandwidth in gigabytes example: 2340.8 minimum: 0 total_gb: type: number description: Total bandwidth (in + out) in gigabytes example: 3591.3 minimum: 0 start_date: type: string format: date description: Period start date example: '2026-01-01' end_date: type: string format: date description: Period end date example: '2026-01-31' peak_usage_mbps: type: number description: Peak bandwidth usage in Mbps during period example: 850.5 required: - period - in_gb - out_gb Error: type: object description: Standard error response properties: error: type: object properties: code: type: string description: Error code for programmatic handling example: invalid_request message: type: string description: Human-readable error message example: The Hixe-Version header is required details: type: object description: Additional error details nullable: true required: - code - message required: - error responses: ValidationError: description: Request validation failed content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: validation_error message: Invalid request parameters details: period: Must be either 'daily' or 'monthly' UnauthorizedError: description: Authentication failed - invalid or missing token content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: unauthorized message: Invalid or expired authentication token ForbiddenError: description: Access denied - token valid but lacks required permissions content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: forbidden message: Your account does not have access to this resource RateLimitError: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: rate_limit_exceeded message: Too many requests. Please retry after 60 seconds headers: X-RateLimit-Limit: schema: type: integer description: Maximum requests allowed per window X-RateLimit-Remaining: schema: type: integer description: Requests remaining in current window X-RateLimit-Reset: schema: type: integer description: Unix timestamp when rate limit resets Retry-After: schema: type: integer description: Seconds to wait before retrying securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT token obtained from Xerobi account dashboard ```` ## Related topics - [Get JSON Delta](https://docs.xerobi.com/rpki-api/endpoint/get-json-delta.md) - [Get usage report](https://docs.xerobi.com/sms-api/endpoint/get-usage-report.md) - [Get consumer usage stats](https://docs.xerobi.com/network-api/endpoint/get-consumer-usage.md) - [Xerobi Fiber API](https://docs.xerobi.com/network-api/introduction.md) - [Xerobi Developer Documentation](https://docs.xerobi.com/index.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.