Audit APIs
The Audit APIs provide access to historical operational activity and connection lifecycle events within the IoT.live platform.
These APIs support:
- Operational auditing
- Troubleshooting
- Historical reporting
- Change tracking
- Compliance workflows
- Investigating bulk operations
[IMAGE PLACEHOLDER: Audit API overview]
Audit API overview
The platform records operational activity and connection history across supported workflows.
Typical audit records may include:
- Status changes
- Rate plan updates
- Attribute changes
- Communication plan updates
- Bulk operational campaigns
- User-triggered actions
- System-generated events
The primary audit API is:
getConnectionAuditTrail
getConnectionAuditTrail API
The getConnectionAuditTrail API retrieves historical audit events associated with subscriptions and operational workflows.
Typical use cases include:
- Investigating operational changes
- Troubleshooting failed updates
- Reviewing lifecycle history
- Tracking user activity
- Building compliance reports
[IMAGE PLACEHOLDER: Audit trail workflow]
Example audit trail request
Typical audit information
Audit records may include:
- Event timestamps
- Operational actions
- Previous values
- Updated values
- User information
- Provider responses
- Campaign references
- Operational status
Examples include:
- Connection suspended
- Rate plan updated
- Attribute modified
- Bulk campaign executed
- Communication plan changed
[IMAGE PLACEHOLDER: Audit event examples]
Audit export APIs
The platform also supports export workflows for audit datasets.
Primary export API:
exportConnectionAuditTrail
Typical export use cases include:
- Compliance reporting
- Bulk operational analysis
- Historical investigations
- External reporting workflows
[IMAGE PLACEHOLDER: Audit export workflow]
Historical operational analysis
Audit APIs can help identify:
- Failed operations
- Unexpected changes
- User activity
- Synchronisation issues
- Bulk campaign behaviour
- Operational anomalies
Common troubleshooting scenarios include:
- Investigating service suspension
- Identifying failed updates
- Reviewing asynchronous campaign results
- Tracking operational history
Filtering audit records
Depending on the API implementation, audit filtering may support:
- ICCID
- IMSI
- MSISDN
- Date ranges
- Operation types
- User activity
- Campaign identifiers
[IMAGE PLACEHOLDER: Audit filtering examples]
Audit timestamps
Audit APIs typically return:
- UTC timestamps
- Historical event sequencing
- Operational timing information
This information can support:
- Compliance analysis
- Operational reconstruction
- Synchronisation investigations
- Event correlation
Use corrId values consistently across integrations to simplify audit correlation and troubleshooting.
Async operational tracking
Audit APIs are especially valuable when working with:
- Asynchronous campaigns
- Bulk operational updates
- Large exports
- Multi-stage workflows
Audit records can help determine:
- Which operations succeeded
- Which records failed
- When updates occurred
- Which user or workflow initiated the action
[IMAGE PLACEHOLDER: Async audit lifecycle]
Common audit use cases
Typical integration scenarios include:
- Compliance reporting
- Customer operational history
- Bulk campaign validation
- Troubleshooting failed changes
- Monitoring operational workflows
- Building activity dashboards
Security and compliance considerations
Audit records may contain:
- Sensitive operational activity
- User identifiers
- Customer information
- Historical subscription changes
Recommended controls include:
- Restricting audit visibility
- Protecting exported reports
- Limiting administrative access
- Applying retention policies
Audit exports may contain sensitive operational history and should be handled securely.
Best practices
Recommended audit integration practices include:
- Export audit datasets asynchronously for large requests
- Use correlation IDs consistently
- Retain operational logs externally where appropriate
- Monitor bulk operations closely
- Filter audit requests where possible