Device Reports

An aggregated asynchronous sessions and usage report for a user specified selection of devices and date range

POST
/hyper-precise/v1/report/async/aggregate

Calculate aggregated report per day with number of sessions and usage information. User will receive an asynchronous callback for the specified list of devices (Max 10000) and date range (Max 180 days).

Authorization

thingspace_oauth VZ-M2M-Token
AuthorizationBearer <token>

This is the ThingSpace token, from Credentials and Tokens is used

In: header

VZ-M2M-Token<token>

M2M Session Token (How to generate an M2M session token?)

In: header

Request Body

application/json

Aggregated session report request.

Aggregated session report request.

accountNumber*string

The numeric ID of the account and must include leading zeroes. This value is indentical to accountName.

startDate?string

Start date of session to include. If not specified information will be shown from the earliest available (180 days). Can be either date in ISO 8601 format or predefined constants.

endDate?string

End date of session to include. If not specified information will be shown to the latest available. Can be either date in ISO 8601 format or predefined constants.

imei*array<string>

Devices for which return usage info. Could be 0, 1 or more. In case of 0 will return all devices belonging to customer (except of filtered by other parameters).

deviceGroup?string

Optional filter — only include devices matching this device group name.

dataPlan?string

Optional filter — only include devices matching this carrier rate plan code.

noSessionFlag?boolean

Optional filter — when "true", returns only devices with no sessions.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/hyper-precise/v1/report/async/aggregate" \  -H "Content-Type: application/json" \  -d '{    "accountNumber": "0000123456-00001",    "startDate": "2022-12-09T22:01:06.217Z",    "endDate": "2022-12-09T22:01:08.734Z",    "imei": [      "15-digit IMEI"    ],    "deviceGroup": "string",    "dataPlan": "string",    "noSessionFlag": false  }'
{  "txid": "60c07fff-eeee-ffff-gggg-75e6a7c238f6",  "status": "QUEUED"}