Battery Health

A vehicle's 12V battery can fail. The following request can help to determine an upcoming failure.

GetBatteryHealth

Get a list of reports from your vehicle's 12V battery.

Request

curl -L -X POST 'https://{DOMAIN}/voyorequest/GetBatteryHealth

-d 'serial={SERIAL}'
-H 'Accept: application/json'
-H 'Authorization: Bearer {APIKEY}'

Parameter	Description
serial	VOYO Device serial number

Error Responses

    HTTP/1.1 400 Bad Request
    HTTP/1.1 401 Unauthorized

/// Request requires "serial"
{ "error":"Requires Device Identifier!" }

/// "serial" is not registered to provided "apikey"
{ "error":"Unauthorized Device Requested!" }

// There is no record of this device
{ "error":"Device does not exist!" }

Success Responses

Up to the last 25 reports will be returned, ordered by "reported_at" descending. "reports" can be empty if the VOYO serial requested has no reports yet.

"health" has the following return values:

1	0
Battery is healthy	Potential failure detected

{ 
    "error":"Success!", "reports":[
        {
            "reported_at":"",
            "health":""
        }
    ] 
}

Receiving a report of 0 for battery "health" does not mean a battery failure is imminent, but it can help to indicate a future failure.