Device Experience - 30 Days History
Device Experience - 30 Day History
POST /v1/intelligence/device-experience/history/30-days
Run a report to view the device experience score over the last 30 days for a specific device.
HTTP Request
POST https://thingspace.verizon.com/api/m2m/v1/intelligence/device-experience/history/30-days
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 Body
{
"accountName": "0000123456-00003",
"deviceId": {
"kind": "iccid",
"id": "20-digit ICCID"
}
}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. |
| deviceId | object | A deviceId object contains: id and kind . |
| 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": {
"deviceExperienceScoreHistory": {
"device": [
{
"id": "20-digit ICCID",
"kind": "ICCID"
}
],
"scores": [
{
"date": "2022-07-06",
"averageScore": "50"
},
{
"date": "2022-07-07",
"averageScore": "50"
},
{
"date": "2022-07-08",
"averageScore": "50"
}
]
}
},
"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. |
| deviceExperienceScoreHistory | object | Contains the details of network service history. |
| device | array | An array of device identifiers 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 | 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"
}