List the device experience

List the Device Experience

`POST /dm/v1/devices/experience/actions/query`

Use this endpoint to retrive an overview of sensors communicating with the gateway.

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

PATCH https://thingspace.verizon.com/api/dm/v1/devices/experience/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.

Request Body

Example Request:

{  "accountname": "0000123456-00001",  "filter": {    "$expand": "device detail(s)",    "$limitnumber": 100,    "$nopagination": true,    "$page": "The number of pages",    "$pagenumber": 100,    "$projection": [      "details requested"    ],    "$selection": {      "additionalProp1": "string",      "additionalProp2": "string",      "additionalProp3": "string"    }  }}

Success Response

Status 200 This is a synchronous response, so the connection statistics will be returned. Example Response:

{    "billingaccountid": "The billing account ID",    "createdon": "2023-10-02T15:46:34.562Z",    "date": "2023-10-02T15:46:34.562Z",    "devicesbad": 2,    "devicesfair": 2,    "devicesgood": 8,    "devicestotal": 12,    "foreignid": "c1f178d3-eeee-ffff-gggg-0d6b7ae6022a",    "id": "string",    "lastupdated": "2023-10-02T15:46:34.562Z",    "version": "1.0",    "versionid": "337bd2e8-eeee-ffff-gggg-5207992fd395"  }

Success Parameters

Parameter	Data Type	Description
billingaccountid	string	The numeric name of the account and must include leading zeros. This value matches the `accountname`.
createdon	string ($date-time)	The timestamp of when the record was created.
date	string ($date-time)	The date the data was requested.
devicesbad	integer	This is a score based on combination of network coverage and network outages affecting the device's ability to connect to the network. This is a count of devices that have failed.
devicesfair	integer	This is a score based on combination of network coverage and network outages affecting the device's ability to connect to the network. This is a count of devices that are impaired.
devicesgood	integer	This is a score based on combination of network coverage and network outages affecting the device's ability to connect to the network. This is a count of devices that have no issues.
devicestotal	integer	A count of all devices.
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.
id	string	The UUID of the resource record. A UUID is a 32 to 36-bit alphanumeric string.
lastupdated	string ($date-time)	The timestamp of when the last update to the record was 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"}

# List the Device Experience ### `POST /dm/v1/devices/experience/actions/query` Use this endpoint to retrive an overview of sensors communicating with the gateway. ## 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](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/getting-started/introduction-to-the-connectivity-management-api). |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 [PATCH https://thingspace.verizon.com/api/dm/v1/devices/experience/actions/query](/docs/specialized-apis/sensor-insights/api-endpoints/devices/sensorinsightslistdeviceexperiencehistoryrequest) ## 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. | ## Request Body Example Request: ```json { "accountname": "0000123456-00001", "filter": { "$expand": "device detail(s)", "$limitnumber": 100, "$nopagination": true, "$page": "The number of pages", "$pagenumber": 100, "$projection": [ "details requested" ], "$selection": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } ``` ## Success Response **Status 200** This is a synchronous response, so the connection statistics will be returned. Example Response: ```json { "billingaccountid": "The billing account ID", "createdon": "2023-10-02T15:46:34.562Z", "date": "2023-10-02T15:46:34.562Z", "devicesbad": 2, "devicesfair": 2, "devicesgood": 8, "devicestotal": 12, "foreignid": "c1f178d3-eeee-ffff-gggg-0d6b7ae6022a", "id": "string", "lastupdated": "2023-10-02T15:46:34.562Z", "version": "1.0", "versionid": "337bd2e8-eeee-ffff-gggg-5207992fd395" } ``` ## Success Parameters | Parameter | Data Type | Description | | ---------- | -------- | ----------- | | **billingaccountid** |string| The numeric name of the account and must include leading zeros. This value matches the `accountname`. | | **createdon** |string ($date-time)| The timestamp of when the record was created.| | **date** |string ($date-time)| The date the data was requested. | | **devicesbad** |integer| This is a score based on combination of network coverage and network outages affecting the device's ability to connect to the network. This is a count of devices that have failed. | | **devicesfair** |integer| This is a score based on combination of network coverage and network outages affecting the device's ability to connect to the network. This is a count of devices that are impaired. | | **devicesgood** |integer| This is a score based on combination of network coverage and network outages affecting the device's ability to connect to the network. This is a count of devices that have no issues. | | **devicestotal** |integer| A count of all devices. | | **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. | | **id** |string| The UUID of the resource record. A UUID is a 32 to 36-bit alphanumeric string. | | **lastupdated** |string ($date-time)| The timestamp of when the last update to the record was 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: ```json { "error": "Error name or code", "error_description": "A longer error description.", "cause": "A cause for the error" } ```

Verizon 5G Edge API Portal

List the device experience