Device Management

Returns the total amount of data sent and the total number of SMS messages sent or received by a set of devices in a specified timeframe.

POST
/m2m/v1/devices/usage/actions/list/aggregate

The information is returned in a callback response, so you must register a URL for DeviceUsage callback messages using the POST /callbacks API.

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

A request to retrieve aggregated device usage history information.

A request to retrieve aggregated device usage history information.

startTime*string

The beginning of the reporting period. The startTime cannot be more than 6 months before the current date.

endTime*string

The end of the reporting period. The endTime date must be within on month of the startTime date.

deviceIds?array<>

One or more devices for which you want aggregate data, specified by device ID.

accountName?string

The name of a billing account.

groupName?string

The name of a device group, if you want to only include devices in that group.

label?array<>
Itemsitems <= 50

Response Body

application/json

application/json

curl -X POST "https://example.com/m2m/v1/devices/usage/actions/list/aggregate" \  -H "Content-Type: application/json" \  -d '{    "deviceIds": [      {        "id": "84258000000891490087",        "kind": "ICCID"      }    ],    "accountName": "9992330389-00001",    "endTime": "2021-08-30T00:00:00-06:00",    "startTime": "2021-08-01T00:00:00-06:00"  }'
{  "requestId": "1631e200-7398-4609-b1f8-398341229176"}