Data Streamer
Compatibility Notes: The Data Streamer is under active development. It is regularly updated for performance and quality improvements so that you’re able to gain rich insights into the event and usage data when using the Event API or a data stream. If you’ve built custom integrations, you should expect that additional data may be added in the future. We recommend using mature and tested libraries designed for parsing or reading JSON for custom integrations to ensure compatibility.
Data Properties
Data types are referred to in the following sections to assist with integration or database schemas. They should be interpreted as follows:
| Type | Description |
|---|---|
| INTEGER | An integer value usually used for entity IDs, will not exceed 32-bit values. |
| LONG | For event and usage data record IDs, a 64 bit long value should be expected. |
| BOOLEAN | true or false |
| STRING | A string value enclosed in " double quotation characters. |
| DECIMAL(14,6) | Used for data volume measurements (volume.total, volume.tx, volume.rx) with 6 decimal places. |
| DECIMAL(14,10) | Cost calculation (cost property) may have up to 10 decimal places. |
| TIMESTAMP | Timestamp property in UTC enclosed in " double quotation characters. |
Event Object
See our Events Reference page.
Usage Object
The following table shows the properties in a usage data record. These properties are included in all records, independent of traffic type:
| Property | Type | Description |
|---|---|---|
| id | LONG | Unique identifier of the usage data record. |
| traffic_type | JSON Object | Type of traffic (i.e., data or SMS) (see Traffic Type Object). |
| start_timestamp | TIMESTAMP | Start time of the reported service consumption. |
| end_timestamp | TIMESTAMP | End time of the reported service consumption. |
| organisation | JSON Object | Organization associated with the usage data record (see Organization Object). |
| endpoint | JSON Object | Device details (see Endpoint Object). |
| sim | JSON Object | SIM details (see SIM Object). |
| imsi_id | INTEGER | Unique identifier of the active IMSI when service was consumed. |
| imsi | STRING | International mobile subscriber identity (IMSI). The unique number identifying the currently active IMSI of the SIM. |
| session_id | STRING | Session UUID for correlating PDP context events and usage record objects. |
| tariff | JSON Object | Information about the tariff assigned to the device (see Tariff Object). |
| operator | JSON Object | Mobile network operator (MNO) details (see Operator Object). |
| volume | JSON Object | Volume consumed in a PDP context (see Volume Object). |
| cost | DECIMAL(14,10) | Estimated cost calculation with up to 10 decimal places. This value represents either excess costs accrued or an estimation based on the assigned pay-as-you-go tariff (cost per MB). |
| currency | JSON Object | Cost currency details. |
Traffic Type Object
| Property | Type | Description |
|---|---|---|
| id | INTEGER | Unique identifier of the traffic type, either 5 (Data) or 6 (SMS). |
| description | STRING | String representation of the traffic type, either "Data" or "SMS" |
Tariff Object
| Property | Type | Description |
|---|---|---|
| id | INTEGER | Unique identifier of the tariff used by the device. |
| name | STRING | Name of the tariff. |
| ratezone | JSON Object | Details of the ratezone used by the device. |
Operator Object
| Property | Type | Description |
|---|---|---|
| id | LONG | Unique identifier of the mobile network operator (MNO) used. |
| name | STRING | Name of the MNO. |
| country | JSON Object | Country of the MNO (see Country Object). |
| mnc | JSON Array | List of mobile network codes (MNC) of the MNO used (see MNC Array) |