API Docs

Device Experience - Bulk Latest

`POST /v1/intelligence/device-experience/bulk/latest`

Run a report to view the latest device experience score for specific devices.

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/intelligence/device-experience/bulk/latest

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 Body

{  "accountName": "0000123456-00001",  "deviceList":[      {         "id":"10-digit MDN",         "kind":"mdn"      },      {         "id":"20-digit ICCID",         "kind":"iccId"      },      {         "id":"15-digit IMEI",         "kind":"imei"      },      {         "id":"20-digit ICCID",         "kind":"iccId"      },      {         "id":"32-digit EID",         "kind":"eid"      }   ]}

Request Body Parameters

All parameters are required unless marked optional .

Parameter	Data Type	Description
accountName	string	The numeric name of the account, including leading zeros.
deviceList	object	A list of individual device identifiers to query.
id	string	The numeric value of the device ID type.
kind	string	The type of device ID represented by the ID value. Only the following are supported by the request and two values must be present: iccid - integrated circuit card ID (SIM card) eid - electronic ID, a 32-digit unique ID of the device imei - International Mobile Equipment Identifier mdn - Mobile Directory Number (a 10-digit phone number)

Success Responses

Status 200

A successful response shows a system generated request ID to track the request.

Example Response:

{  "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8"}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit About Callback Services. The callback service to subscribe to is IntelligenceService.

Example callback response:

{  "username" : "the user's login information",  "password" : "the user's password",  "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8",  "intelligenceResponse": {    "deviceExperienceScoreBulk": {      "deviceExperienceScores": [        {          "device": [            {              "id": "20-digit ICCID",              "kind": "ICCID"            }          ],          "date": "2022-07-06",          "averageScore": "50",          "status" : "SUCCESS",          "reason" : "Device Data Found"         },        {          "device": [            {              "id": "10-digit phone number",              "kind": "MDN"            }          ],          "date": "2022-07-06",          "averageScore": "50",          "status" : "SUCCESS",          "reason" : "Device Data Found"         }      ]    }  },  "status": "SUCCESS",  "callbackCount": 1,  "maxCallbackThreshold": 4}

Callback Parameters

Parameter	Data Type	Description
username	string	The user's login information.
password	object	The user's password.
requestId	string	The `requestId` being viewed. This is a system generated value from the request above.
intelligenceResponse	object	Contains the response details of the request.
deviceExperienceScoreBulk	object	Contains the details of network service history.
device	array	Device identifier objects responding to the query.
id	string	The numeric value of the device ID type.
kind	string	The type of device ID represented by the ID value: ICCID - integrated circuit card ID (SIM card) EID - electronic ID, a 32-digit unique ID of the device IMEI - International Mobile Equipment Identifier MDN - Mobile Directory Number (a 10-digit phone number)
scores	array	A list of date and score objects for the 30 day period queried.
date	string	Year, month and day of the 24-hour period recorded.
averageScore	string	A score assigned, out of 100, for that 24-hour period.
status	string	Status of the device's reply. This will be either: SUCCESS or FAILED .
reason	string	Additional information about the status.
status	string	The status of the intelligenceResponse.
callbackCount	string	The number of responses for intelligenceResponse found.
maxCallbackThreshold	string	The maximum number of responses for intelligenceResponse allowed.

Failure Responses

All error messages are returned in this format:

{  "errorCode": "The 3-digit HTML error code",  "errorMessage": "string"}

# Device Experience - Bulk Latest ### `POST /v1/intelligence/device-experience/bulk/latest` Run a report to view the latest device experience score for specific devices. ## HTTP Request [POST https://thingspace.verizon.com/api/m2m/v1/intelligence/device-experience/bulk/latest](/docs/premium-apis/thingspace-intelligence/api-endpoints/wireless-network-performance/deviceexperiencebulklatest) ## 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/session-management/guides/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 Body ``` json { "accountName": "0000123456-00001", "deviceList":[ { "id":"10-digit MDN", "kind":"mdn" }, { "id":"20-digit ICCID", "kind":"iccId" }, { "id":"15-digit IMEI", "kind":"imei" }, { "id":"20-digit ICCID", "kind":"iccId" }, { "id":"32-digit EID", "kind":"eid" } ] } ``` ## Request Body Parameters All parameters are required unless marked *optional* . |Parameter|Data Type|Description| |-----|-----|-----| | **accountName** |string| The numeric name of the account, including leading zeros.| | **deviceList** |object| A list of individual device identifiers to query.| | **id** |string| The numeric value of the device ID type.| | **kind** |string| The type of device ID represented by the ID value. Only the following are supported by the request and two values must be present: **iccid** - integrated circuit card ID (SIM card) **eid** - electronic ID, a 32-digit unique ID of the device **imei** - International Mobile Equipment Identifier **mdn** - Mobile Directory Number (a 10-digit phone number) | ## Success Responses **Status 200** A successful response shows a system generated request ID to track the request. Example Response: ``` json { "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8" } ``` ## Callback Response These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit [About Callback Services](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/guides/callbacks/about-callback-services). The callback service to subscribe to is [IntelligenceService](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/guides/callbacks/about-callback-services/request-body-format). Example callback response: ``` json { "username" : "the user's login information", "password" : "the user's password", "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8", "intelligenceResponse": { "deviceExperienceScoreBulk": { "deviceExperienceScores": [ { "device": [ { "id": "20-digit ICCID", "kind": "ICCID" } ], "date": "2022-07-06", "averageScore": "50", "status" : "SUCCESS", "reason" : "Device Data Found" }, { "device": [ { "id": "10-digit phone number", "kind": "MDN" } ], "date": "2022-07-06", "averageScore": "50", "status" : "SUCCESS", "reason" : "Device Data Found" } ] } }, "status": "SUCCESS", "callbackCount": 1, "maxCallbackThreshold": 4 } ``` ## Callback Parameters |Parameter|Data Type|Description| |-----|-----|-----| | **username** |string| The user's login information.| | **password** |object| The user's password.| | **requestId** |string|The `requestId` being viewed. This is a system generated value from the request above.| | **intelligenceResponse** |object| Contains the response details of the request.| | **deviceExperienceScoreBulk** |object| Contains the details of network service history.| | **device** |array| Device identifier objects responding to the query.| | **id** |string| The numeric value of the device ID type.| | **kind** |string|The type of device ID represented by the ID value: **ICCID** - integrated circuit card ID (SIM card) **EID** - electronic ID, a 32-digit unique ID of the device **IMEI** - International Mobile Equipment Identifier **MDN** - Mobile Directory Number (a 10-digit phone number) | | **scores** |array| A list of date and score objects for the 30 day period queried.| | **date** |string| Year, month and day of the 24-hour period recorded.| | **averageScore** |string| A score assigned, out of 100, for that 24-hour period.| | **status** |string| Status of the device's reply. This will be either: **SUCCESS** or **FAILED** .| | **reason** |string| Additional information about the status.| | **status** |string| The status of the **intelligenceResponse**.| | **callbackCount** |string| The number of responses for **intelligenceResponse** found.| | **maxCallbackThreshold** |string| The maximum number of responses for **intelligenceResponse** allowed.| ## Failure Responses All error messages are returned in this format: ``` json { "errorCode": "The 3-digit HTML error code", "errorMessage": "string" } ```