Traffic history
Provide an aggregated view of the session history of the subscription. Max history depth is 30 days.
Request
Endpoint:
GET /api/v1/networks/cellular/subscriptions/{subscriptionId}/traffic/history
HTTP Headers:
X-API-Key: <your API key> Content-Type: application/json Accept: application/json
Parameters:
| HTTP Params | Description |
|---|---|
limit |
(optional) limit the response to the last n elements in the "data" object. 1000> n> 0 |
interval |
(optional) requested aggregation format, "1h"(one hour), "1d"(one day) or "1w"(one week). |
timeZone |
(optional) time zone for daily or weekly aggregation, with TZ database name ("UTC", "Europe/Paris") or UTC Offset ("-02:00", "%2B04:00"). |
Example:
GET /api/v1/networks/cellular/subscriptions/06361407/location?limit=1&interval=1h&timeZone=Europe/Paris
Response
HTTP Code:
200 OK
Body:
[
{
"dataIn": 1096,
"dataOut": 1096,
"smsIn": 5,
"smsOut": 5,
"timestamp": "2024-02-01T09:00:00+01:00"
}
]| JSON Params | Description |
|---|---|
dataIn |
Sim data traffic with device as target (in Bytes) |
dataOut |
Sim data traffic device originated (in Bytes) |
smsIn |
Sim SMS count with device as target |
smsOut |
Sim SMS count device originated |
timestamp |
date time of the beginning of the bucket interval (in UTC) |
Error case:_
| HTTP Code | Error code | message |
|---|---|---|
400 |
GENERIC_INVALID_PARAMETER_ERROR |
The submitted parameter is invalid. |
403 |
FORBIDDEN |
Forbidden request |
404 |
CELLULAR_SUBSCRIPTION_NOT_FOUND |
Subscription not found |