Specialized APIsSensor InsightsAPI Reference
Get a summary of device health scores
Get the Health Score Summary
Use this endpoint to retrieve the overall health of devices.
POST /dm/v1/healthscore/summary
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/healthscore/summary
Request Parameters
None
Request Body
None
Success Response
Status 200 This is a synchronous response, so the health summary will be returned. Example Response:
{
"overallsummary": [
{
"metrictype": "overallscore",
"metricvalue": "string"
}
]
}Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| overallsummary | array | An array of metrics objects indicating the health of the devices. |
| metrictype | string | The type of metric maesured. This can be overallscore, gatewayscore, sensorscore or averagesignalstrength. |
| metricvalue | string | The score as a percentage. |
Failure Responses
Example Response:
{
"error": "Error name or code",
"error_description": "A longer error description.",
"cause": "A cause for the error"
}