Usage APIs
The Usage APIs provide access to detailed subscription usage information across data, SMS, and voice services.
These APIs support:
- Usage reporting
- Operational monitoring
- Billing analysis
- Customer reporting
- Export workflows
- Historical usage retrieval
[IMAGE PLACEHOLDER: Usage API architecture]
Usage API overview
The IoT.live platform provides dedicated APIs for retrieving and exporting usage data across multiple service categories.
Supported usage areas include:
Usage Type | Description |
|---|---|
Data Usage | Mobile data consumption |
SMS Usage | SMS activity and messaging usage |
Voice Usage | Voice call usage and call records |
The platform also supports:
- Historical usage retrieval
- Export APIs
- Large dataset reporting
- Async export workflows
Data usage APIs
The primary data usage API is:
getConnectionDataUsageDetails
This API retrieves detailed mobile data usage information for subscriptions.
Typical use cases include:
- Customer reporting
- Usage dashboards
- Billing reconciliation
- Operational monitoring
- High-usage detection
[IMAGE PLACEHOLDER: Data usage workflow]
Example data usage request
Typical data usage information
Responses may include:
- Usage volume
- Billing period
- Provider information
- Connection identifiers
- Usage timestamps
- Aggregated consumption values
The exact fields returned may vary depending on:
- Provider integrations
- Subscription type
- Available usage granularity
SMS usage APIs
The platform also supports SMS usage retrieval through:
getConnectionSMSUsageDetails
Typical use cases include:
- SMS usage analysis
- Customer reporting
- Messaging cost monitoring
- Operational analytics
[IMAGE PLACEHOLDER: SMS usage reporting]
Example SMS usage request
Voice usage APIs
Voice usage reporting is available using:
getConnectionVoiceUsageDetails
Typical voice reporting information may include:
- Call durations
- Usage summaries
- Billing periods
- Call event information
- Aggregated voice usage
[IMAGE PLACEHOLDER: Voice usage reporting]
Example voice usage request
Export usage APIs
The platform supports export workflows for large usage datasets.
Export APIs include:
- exportConnectionDataUsageDetails
- exportConnectionSMSUsageDetails
- exportConnectionVoiceUsageDetails
Exports may support:
- Synchronous processing
- Asynchronous processing
- Downloadable report generation
[IMAGE PLACEHOLDER: Usage export workflow]
Large export requests may continue processing asynchronously after the initial API response is returned.
Historical usage reporting
Usage APIs may support:
- Historical billing periods
- Date-range filtering
- Aggregated reporting
- Provider-level usage retrieval
Typical reporting scenarios include:
- Monthly customer reports
- Billing reconciliation
- High-usage investigations
- Operational trend analysis
Usage filtering
Depending on the API, filtering may support:
- ICCID
- IMSI
- MSISDN
- Date ranges
- Provider filters
- Customer associations
- Tags
[IMAGE PLACEHOLDER: Usage filtering examples]
Common operational use cases
Typical integration scenarios include:
- Building customer usage dashboards
- Generating monthly reports
- Monitoring high-usage subscriptions
- Detecting abnormal consumption
- Synchronising usage into BI platforms
- Billing analysis workflows
Pagination and large datasets
Large usage datasets may require:
- Pagination
- Export workflows
- Async processing
- Incremental retrieval strategies
Recommended practices include:
- Retrieving smaller time ranges
- Paginating large requests
- Exporting large datasets asynchronously
Large-scale usage integrations should avoid repeatedly polling large real-time datasets unnecessarily.
Usage data considerations
Usage information may vary depending on:
- Provider reporting delays
- Billing cycle timing
- Network synchronisation
- Roaming processing
- Data aggregation windows
Usage reporting timing and granularity may differ between providers and connectivity platforms.
Security considerations
Usage records may contain:
- Sensitive customer information
- Billing-related data
- Operational activity details
Recommended controls include:
- Restricting export permissions
- Limiting report access
- Protecting stored usage datasets
- Applying data governance policies