Specialized APIsHyper Precise LocationAPI EndpointsDevice Reports for Hyper Precise Feature UsageSession Usage Report
API Reference
Get Session Report for a Device
POST /report/sessions
Detailed report of session duration and number of bytes transferred per day for an individual device.
HTTP Request
POST https://thingspace.verizon.com/api/hyper-precise/v1/report/sessions
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 unique identifier for the account. |
| 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 | International Mobile Device Identifier. The unique identifier of the device. |
| durationLow | integer | The Low value of session duration. |
| durationHigh | integer | The High value of session duration. |
Request Body
Example request:
{
"accountNumber": "string",
"startDate": "string",
"endDate": "string",
"imei": "15-digit IMEI",
"durationLow": 0,
"durationHigh": 0
}Success Responses
Status 200
A successful request returns the device's session information and a Transaction ID (txid) for the report request.
Example response:
{
"id": "The 10-digit ID of the device",
"txid": "60c07fff-eeee-ffff-gggg-75e6a7c238f6",
"sessions": [
{
"startTime": "Start date of session. ISO 8601 format.",
"endTime": "End date of session. ISO 8601 format.",
"numBytes": 0
}
]
}Response Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| id | string | The 10-digit ID of the device. |
| txid | string | Transaction ID of the request. |
| sessions | array | An array containing objects detailing the start and end time of the session with the amount of data transferred. |
| startTime | string | Start date of session. ISO 8601 format. |
| endTime | string | End date of session. ISO 8601 format. |
| numBytes | integer | Amount of data transferred, measured in Bytes. |
Failure Responses
Request failures will be in this format:
{
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Device Not Found, Request will be queued"
}