Retrieve device data usage

Retrieve the data usage of the device.

Request

Security:

bearerAuth

path Parameters

imei

required

string (IMEI)

The IMEI of the device. The IMEI number can be found on a sticker on the device itself or on the back of the device box.

Example: 357660101000198

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/devices/{imei}/data-usage

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  https://api-prod.surfsight.net/v2/devices/:imei/data-usage \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"data": {"mobileTx": 1742802650,
"mobileRx": 105125084,
"liveStreamingUsage": 1509793264,
"eventsUsage": 49707444,
"liveStreamUsageMilli": 25026908,
"recordStreamingUsage": 14869072,
"recordingsUploadUsage": 0,
"usageEventsTodayDay": 3,
"usageEventsTodayMonth": 44,
"recordStreamUsageMilli": 25026908,
"receivedAt": "2020-01-01T14:48:00.000Z",
"billingDayOfMonth": 1,
"mobileProvider": {"carrier": "twilio",
"uniqueName": "Lytx Fleet 2 GB Limit",
"dataLimit": 1000,
"dataUsage": {"dataTotal": 100,
"dataUpload": 90,
"dataDownload": 10,
"period": {"startTime": "2020-01-01T14:48:00.000Z",
"endTime": "2020-01-01T14:48:00.000Z"
}
}
}
}
}