SIM Management
Advanced Flows
Data Usage

Data Usage

You can retrieve a SIMs data usage in multiple ways, these are documented below.

API Flow

To get the data usage per sim the following api calls can be used. This data is refreshed every 6 hours (or every 30 minutes for IOT connections).

These endpoints list multiple sims and follow AutoQueryable Syntax

  • /api/sim
  • /api/company/{companyId}/sim
  • /api/company/{companyId}/account/{accountid}/sim

This endpoint shows a single sim:

  • /api/sim/{serialNumber}

All the above endpoints contain a dataUsageMb field with the sims currently known data usage.

SFTP Flow

This feed can be set up by contacting your Account Manager.

For IoT connections, we provide a CDR-like file (in CSV format) via our SFTP site.
These files are a proxy for RADIUS information received from the network. They are delivered every 30 minutes and contain all session records from the previous period.

The file name is in the format: SessionCDR_{accountId}_{date}_{lastRowId}.csv with content in the structure:

NameTypeDescriptionRestrictions / Notes
SessionRowIDintUnique identifier for the rowPrimary key
MsisdnstringMobile numberMax length 20
SIMSerialstringSIM serial numberMax length 40
SessionIdintIdentifier for the session
SessionStartUTCDateTimeSession started (UTC)
Imsistring?International Mobile Subscriber IDMax length 25
Imeistring?International Mobile Equipment IDMax length 100
RecordDateUtcDateTimeRecord created (UTC)
RecordTypestringType of recordStart, Stop, Interim
AccessPointNamestring?APN used during the sessionMax length 30
OutgoingDataVolumelongBytes sent during session
IncomingDataVolumelongBytes received during session
TotalDataVolumelongTotal data volume (sent+received)
IpAddressstring?IP addressMax length 30
MobileCountryCodestring?Country code of the mobile networkMax length 5
MobileNetworkCodestring?Network code of the mobile networkMax length 5
RatTypeint?Radio access technology type

Usage Notes

To monitor daily usage, you need to:

  1. Track all SessionIds associated with each MSISDN.
  2. Aggregate usage based on the unique SessionRowID, e.g., summing TotalDataVolume per MSISDN or per session.

This ensures accurate reporting, even if a single MSISDN has multiple sessions during the day.


Data Model

Although both the MSISDN and SessionId can be repeated multiple times in each file the hierarchy is MSISDN can have multiple SessionIds which can have multiple SessionRowIDs.