Export APIs
The IoT.live platform provides export APIs for generating operational reports and retrieving large datasets from the platform.
Export APIs support:
- Inventory exports
- Usage exports
- Audit exports
- Statistics exports
- Large operational datasets
- Async report generation workflows
[IMAGE PLACEHOLDER: Export API architecture]
Export API overview
Many operational datasets can become extremely large, especially across:
- Enterprise deployments
- Multi-provider environments
- Historical reporting periods
- High-volume operational activity
To support these workflows efficiently, the platform provides:
- Synchronous exports
- Asynchronous exports
- Downloadable report generation
The API documentation includes dedicated export APIs for:
- Connections
- Connection statistics
- Data usage
- SMS usage
- Voice usage
- Audit trail history
Synchronous vs asynchronous exports
The platform supports two export execution models.
Synchronous exports
Synchronous exports:
- Return results immediately
- Are typically used for smaller datasets
- Complete within the original request lifecycle
Asynchronous exports
Asynchronous exports:
- Queue large report generation jobs
- Continue processing in the background
- Generate downloadable reports
Async exports are recommended for:
- Large inventory exports
- Historical usage exports
- Audit reporting
- Enterprise reporting workflows
[IMAGE PLACEHOLDER: Sync vs async export flow]
Large export operations may continue processing after the initial API response is returned.
exportConnections API
The exportConnections API exports connection inventory datasets.
Typical export data may include:
- ICCIDs
- IMSIs
- MSISDNs
- Provider information
- Rate plans
- Connection status
- Operational attributes
- Customer associations
[IMAGE PLACEHOLDER: Connection export example]
Example exportConnections request
Statistics exports
The platform also supports exporting inventory statistics using:
exportConnectionStats
Typical statistics exports may include:
- Active connection counts
- Suspended connection counts
- Provider distribution
- Usage summaries
- Operational metrics
Usage export APIs
Usage export APIs support:
- Data usage exports
- SMS usage exports
- Voice usage exports
Documented export APIs include:
- exportConnectionDataUsageDetails
- exportConnectionSMSUsageDetails
- exportConnectionVoiceUsageDetails
Typical use cases include:
- Customer billing reports
- Monthly usage reporting
- BI platform integration
- Cost analysis workflows
[IMAGE PLACEHOLDER: Usage export workflow]
Audit export APIs
Audit export APIs support exporting:
- Historical operational events
- Lifecycle changes
- User activity
- Campaign operations
- Bulk update history
Primary API:
exportConnectionAuditTrail
These exports are commonly used for:
- Compliance reporting
- Operational investigations
- Historical analysis
- Security reviews
Report download APIs
Large asynchronous exports may generate downloadable reports.
The documentation references a dedicated report download API:
download/report
This workflow allows integrations to:
- Generate export reports
- Monitor export processing
- Download completed report files
[IMAGE PLACEHOLDER: Report generation and download lifecycle]
Export processing lifecycle
Typical async export flow:
- Submit export request
- Receive pending response
- Background report generation begins
- Export completes
- Report becomes downloadable
Common export statuses may include:
- Pending
- Success
- Failed
- Partially_Successful
Large dataset considerations
Large exports may:
- Take significant time to process
- Require asynchronous workflows
- Generate very large files
- Depend on provider-side reporting availability
Recommended practices include:
- Filtering datasets where possible
- Exporting smaller date ranges
- Avoiding unnecessary repeated exports
- Scheduling large exports outside peak operational windows
Incremental exports are often more efficient than repeatedly exporting full historical datasets.
Export filtering
Depending on the export API, filtering may support:
- ICCID
- IMSI
- MSISDN
- Date ranges
- Provider filters
- Tags
- Customer associations
- Operational status
[IMAGE PLACEHOLDER: Export filtering example]
Common integration scenarios
Typical export integration workflows include:
- Enterprise reporting platforms
- Customer self-service reporting
- BI and analytics systems
- Operational dashboards
- Billing reconciliation systems
- Audit and compliance tooling
Security considerations
Export APIs may generate datasets containing:
- Sensitive customer information
- Usage records
- Billing-related data
- Operational activity
- Subscription identifiers
Recommended controls include:
- Restricting export permissions
- Securing downloaded reports
- Applying retention policies
- Encrypting stored exports where appropriate
Exported operational datasets should be treated as sensitive business information.
Best practices
Recommended export integration practices include:
- Use async exports for large datasets
- Filter aggressively where possible
- Track export requests using corrId
- Monitor export completion properly
- Avoid duplicate export generation
- Archive exported datasets securely