The Heartbeat Service

What is Heartbeat?

Zendrive SDK can automatically track trips and driving behavior on a phone in the background. The SDK’s ability to track trips automatically is predicated on various conditions on the device, its software and its environment being optimal. Heartbeat is a periodic service within the SDK to check if it is running properly. Heartbeat logs device health information about the SDK or device periodically. This period will be configurable, but is set by Zendrive to work at least once every 3 hours in order to minimize battery and network consumption.

In addition to logging heartbeat information every 3 hours, Zendrive also collects this information every time there's a geofence breach, if more than 3 hours have passed since the last heartbeat collection.

If the periodic heartbeat collection service fails to execute, the missing heartbeat(s) will be logged as disconnected. This may happen if the phone is off or if the device restricts execution of the service in the background.Heartbeat data is saved locally and an attempt to upload will happen once every 24 hours. This feature can be configured to ensure data is uploaded over WiFi only.

Use Cases for Heartbeat

The following use cases are available for the heartbeat service:

• Device Health: Heartbeat allows you to check the health of a device and whether it is functional.

• Validation: Heartbeat allows you to validate onboarding and regular use of the SDK.

• Individual Device Tracking: Heartbeat allows you to audit trackability for users and devices with greater granularity and precision.

Access Data with API Endpoints

The heartbeatAggregates API can be used to request information about device health.

See the following page for an explanation of all the request and response fields.