Specialized APIsHyper Precise LocationAPI EndpointsDevice Reports for Hyper Precise Feature UsageAggregate Usage Report (Asynchronous)
API Reference
Get Aggregated Usage Report (Asynchronous)
POST /report/async/aggregate
Calculate an aggregated report by 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).
HTTP Request
POST https://thingspace.verizon.com/api/hyper-precise/v1/report/async/aggregate
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
Request Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountNumber (required) | string | The numeric name of the account, including leading zeros. |
| startDate | string | Start date of session to include. If not specified information will be shown from the earliest available (180 days). ISO 8601 format. |
| endDate | string | End date of session to include. If not specified information will be shown to the latest available. ISO 8601 format. |
| imei (required) | string | ID number of devices queried for usage info. Could be 0, 1 ID or more (up to 10). If 0 the query will return all devices belonging to customer. |
| deviceGroup | string | Optional filter — only include devices matching this user-assigned 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. |
Request Body
Example request:
{
"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
}Success Responses
Status 200
A successful request returns a Transaction ID (txid) and the status of "Queued".
Example response:
{
"txid": "UUID value",
"status": "QUEUED"
}Response Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| txid | string | Transaction ID. The unique ID (UUID) of the report request. |
| status | string | Since this response is only for successful requests, this value will always be QUEUED. |
Failure Responses
Request failures will be in this format:
{
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Device Not Found, Request will be queued"
}