Retrieve device data usage reports

Retrieve the data usage reports of your devices. Partners can receive the device data usage reports of a specific organization by providing the organization ID.

Request
Security:
bearerAuth
query Parameters
organizationId
string (Organization ID as string) ^[1-9]\d*$

Filter by the ID of the organization. Obtain this from GET /organizations.

Example: organizationId=17
limit
string^[1-9]\d*$
Default: "0"

Set the maximum number of pagination results to receive.

Example: limit=1
offset
string^[0-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
imei
string

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

Example: imei=12345678
name
string

Filter by the name of the user.

Example: name=Mike
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/device-data-usage
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/device-data-usage?organizationId=17&limit=1&offset=1&imei=12345678&name=Mike' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    1 more
    500
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}