Specialized APIsSensor InsightsAPI Reference
Query sensors on an account
POST /dm/v1/devices/sensors/actions/query
Use this endpoint to retrieve sensors and their details.
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. |
HTTP Request
POST https://thingspace.verizon.com/api/dm/v1/devices/sensors/actions/query
Request Parameters
Note: All parameters are required unless marked (optional)
| Parameter | Data Type | Description |
|---|---|---|
| accountname | string | The numeric name of the account and must include leading zeros. |
| filter | object | Optional filter data to narrow the search. |
| $expand (optional) | string | Use to provide device details to filter on. |
| $limitnumber (optional) | integer | Limits the number of results returned. |
| $nopagination (optional) | boolean | A flag to indicate if pagination is requested ( false ) or not ( true ). |
| $page (optional) | string | The number of pages in the response. |
| $pagenumber (optional) | integer | The page number requested (if known). |
| $projection (optional) | array | Limits results to the fields of the device that the user is interested in rather than all of the fields. |
| $selection (optional) | object | Filters results based on user defined criteria. |
| resourceidentifier | object | Details about the device being queried. |
| deveui | string | The unique EUI64 address of the device. |
| deviceid | string | The UUID of the device. This is assigned to the device at Onboarding. |
| esn | integer | The Electronic Serial Number of the device and is a 64-bit integer. |
| iccid | string | The 20-digit Integrated Circuit Card ID (SIM card ID). |
| imei | integer | The 15-digit International Mobile Equipment Identifier. |
| imsi | integer | The International Mobile Subscriber Identifier and is a 64-bit integer. |
| mac | string | The Media Access Control address of the device, listed on the device in the format XX-XX-XX-XX-XX-XX or XX:XX:XX:XX:XX:XX. |
| manufacturer | string | The name of the manufacturer of the device. |
| meid | string | The 56-bit Mobile Equipment ID. |
| msisdn | string | The Mobile Station International Subscriber Directory Number. In the USA, this is 1+ a 10-digit phone number. |
| node_uuid | string | The UUID of the node the device is associated with. This is a 34 or 36-bit alphanumeric value. |
| qrcode | string | The numeric value of the Quick Response (QR) code on the device. |
| serial | string | The device's serial number. |
Request Body
Example Request:
{
"accountname": "0000123456-00001",
"filter": {
"$expand": "Expand",
"$limitnumber": 100,
"$nopagination": true,
"$page": "The number of pages",
"$pagenumber": 1,
"$projection": [
"j7eZks2ZMj9DiIIwp2SUUF8xgmPGqpB4IGJdh"
],
"$selection": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"resourceidentifier": {
"deveui": "The EUI64 address",
"deviceid": "The UUID of the device",
"esn": 223372036854775800,
"iccid": "The 20-digit ICCID",
"imei": 223372036854775,
"imsi": 223372036854775800,
"mac": "The Media Access Control address of the device",
"manufacturer": "REOLINK",
"meid": "The 56-bit Mobile Equipment ID",
"msisdn": "The Mobile Station International Subscriber Directory Number",
"node_uuid": "The UUID of the node",
"qrcode": "The Quick Response (QR) code",
"serial": "The device's serial number"
}
}Success Response
Status 200 This is a synchronous response, so the details of the device will be returned. Example Response:
{
"accountclientid": null,
"billingaccountid": "0000123456-00001",
"chipset": "The chipset used by the device",
"createdon": "2023-10-02T15:46:34.562Z",
"customdata": {
"additionalProp1": [
100
],
"additionalProp2": [
100
],
"additionalProp3": [
100
]
},
"description": "a short description",
"esn": 223372036854775800,
"fields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"foreignid": "c1f178d3-eeee-ffff-gggg-0d6b7ae6022a",
"hardwareversion": "1.0",
"iccid": "The 20-digit Integrated Circuit Card ID (SIM card ID)",
"id": "string",
"imei": 223372036854775,
"imsi": 223372036854775800,
"lastupdated": "2023-10-02T15:46:34.562Z",
"licenses": [
"licenses assigned to the device"
],
"mac": "The Media Access Control address of the device, listed on the device in the format XX-XX-XX-XX-XX-XX or XX:XX:XX:XX:XX:XX",
"manufacturer": "REOLINK",
"meid": "The 56-bit Mobile Equipment ID",
"msisdn": "The Mobile Station International Subscriber Directory Number. In the USA, this is 1+ a 10-digit phone number",
"name": "name of the record",
"parentdeviceid": "string",
"productmodel": "Model name of the device",
"providerid": "Verizon Wireless",
"qrcode": "The Quick Response (QR) code",
"refid": "P3730-1422323050860",
"refidtype": "The type of value represented by `refid`",
"serial": "The device's serial number",
"services": [
"configuration"
],
"sku": "The Stock Keeping Unit (SKU) number",
"softwareversion": "the current device software version",
"state": "success",
"version": "1.0",
"versionid": "337bd2e8-eeee-ffff-gggg-5207992fd395"
}Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountclientid | string | Future functionality. This value will be "null". |
| billingaccountid | string | The numeric name of the account and must include leading zeros. This value matches the accountname. |
| chipset | string | The chipset used by the device. |
| createdon | string ($date-time) | The timestamp of when the record was created. |
| customdata | object | This is free form JSON, any thing in the form of JSON can be stored. |
| description | string | A brief description of the record. |
| esn | integer | The Electronic Serial Number of the device and is a 64-bit integer. |
| fields | object | Contains the device configuration details as well as device identifier details. |
| foreignid | string | The UUID value of the user's Enterprise Customer Profile Database (ECPD) account. A UUID is a 32 to 36-bit alphanumeric string. |
| hardwareversion | string | The hardware version of the device. This varies by device and manufacturer. |
| iccid | string | The 20-digit Integrated Circuit Card ID (SIM card ID). |
| id | string | The UUID of the resource. A UUID is a 34 or 36-bit alphanumeric value. |
| imei | integer | The 15-digit International Mobile Equipment Identifier. |
| imsi | integer | The International Mobile Subscriber Identifier and is a 64-bit integer. |
| lastupdated | string ($date-time) | The timestamp of when the last update to the record was made. |
| licenses | array | Licenses assigned to the record. |
| mac | string | The Media Access Control address of the device, listed on the device in the format XX-XX-XX-XX-XX-XX or XX:XX:XX:XX:XX:XX. |
| manufacturer | string | The name of the manufacturer of the device. |
| meid | string | The 56-bit Mobile Equipment ID. |
| msisdn | string | The Mobile Station International Subscriber Directory Number. In the USA, this is 1+ a 10-digit phone number. |
| name | string | The user defined name of the record. |
| parentdeviceid | string | This field is applicable for BLE sensors. This represents the value of the parent gateway device. |
| productmodel | string | The model name of the device. |
| providerid | string | The name of the cellular service provider. |
| qrcode | string | The numeric value of the Quick Response (QR) code on the device. |
| refid | string | A reference ID for the device. |
| refidtype | string | The type of value represented by refid . |
| serial | string | The device's serial number. |
| services | array | Services associated with the record. |
| sku | string | The Stock Keeping Unit (SKU) number of the device. |
| softwareversion | string | the current device software version. |
| state | string | The status of the request made. |
| version | string | The resource version. |
| versionid | string | The UUID of the resource version. A UUID is a 32 to 36-bit alphanumeric string. |
Failure Responses
Example Response:
{
"error": "Error name or code",
"error_description": "A longer error description.",
"cause": "A cause for the error"
}