Android SDK Usage Guide

Step 1: Create a Spike Connection

To set up the Spike SDK create SpikeConnectionV3 instance with your Spike application id, application user id and signature unique to each of your application users (more on generating signatures here):

val spikeConnection = SpikeConnectionAPIv3.createConnection(
    applicationId = 1000,
    signature = "signature",
    endUserId = "user-id",
    context = context
)

Step 2: Ask User for Permissions

If you want to read data from Android Health Connect, you have to ensure the user gives your app permissions. First, you have to check if Health Connect is available on users’ phone:

val hcAvailability = spikeConnection.checkHealthConnectAvailability()

where

public enum class HealthConnectAvailabilityStatus(public val value: String) {
    /**
     * The Health Connect SDK is unavailable on this device at the time. This can be due to the
     * device running a lower than required Android Version. Apps should hide any integration
     * points to Health Connect in this case.
     */
    NOT_INSTALLED("NOT_INSTALLED"),

    /**
     * The Health Connect SDK APIs are currently unavailable, the provider is either not installed
     * or needs to be updated. Apps may choose to redirect to package installers to find a suitable
     * APK.
     */
    UPDATE_REQUIRED("UPDATE_REQUIRED"),

    /**
     * The Health Connect SDK APIs are available.
     */
    INSTALLED("INSTALLED"),
}

If an update is required, you can use Spike helper to open Play Store for user to install Health Connect:

spikeConnection.openHealthConnectInstallation()

If Health Connect is installed, you can get permissions that are needed and a list of already provided permissions:

// HC integration has to be enabled in Spike SDK connection before
// using further methods for reading data or managing permissions:
spikeConnection.enableHealthConnectIntegration()

val permissionManager = spikeConnection.getHealthConnectPermissionManager()
val requiredPermissions = permissionManager.getPermissions(
    statisticsTypes = setOf(StatisticsType.STEPS, StatisticsType.DISTANCE_TOTAL)
)

val grantedPermissions = permissionManager.getGrantedPermissions()

If you have missing permissions, you can ask Android to present the user with a modal asking user for permission to read the data. Example for Compose:

val permissionLauncher = rememberLauncherForActivityResult(
    permissionManager.getRequestPermissionResultContract(),
    onResult = {
        
    }
)

Please note that users might only grant partial permissions. In such cases, it’s up to you to decide whether your app can function effectively with limited access. The Spike SDK itself will still operate even without full permissions; however, it may result in no data being returned in certain scenarios. Conversely, if your app has been granted additional permissions beyond the minimum required for specific data types, we may enhance certain entries by incorporating data sourced from other types (e.g., identifying manually entered data).

You can now use StatisticsFilter(providers = listOf(Provider.HEALTH_CONNECT)) to specifically retrieve data from Health Connect. Alternatively, you can omit the providers parameter entirely and allow Spike to choose the most suitable data source based on your request.

Step 3: Get Data

The maximum permitted query date range is 90 days

There are four types of data you can retrieve from Spike:

Statistics are calculated values derived from records.
Activities are data about user’s activities or workouts.
Sleep is data about user’s sleep.
Records consist of the raw data points collected from user devices or applications.

Statistics

Get daily statistics for steps and total distance from health Connect:

val dailyStatistics = spikeConnection.getStatistics(
    types = setOf(StatisticsType.STEPS, StatisticsType.DISTANCE_TOTAL),
    from = LocalDate.now().minusWeeks(1).atStartOfDay(ZoneId.systemDefault()).toInstant(),
    to = Instant.now(),
    interval = StatisticsInterval.DAY,
    filter = StatisticsFilter(providers = listOf(Provider.HEALTH_CONNECT))
)

Reference:

Records

Get all records we have from Garmin provider:

val records = spikeConnection.getRecords(
    types = setOf(MetricType.STEPS_TOTAL, MetricType.CALORIES_BURNED_TOTAL),
    from = LocalDate.now().minusWeeks(1).atStartOfDay(ZoneId.systemDefault()).toInstant(),
    to = Instant.now(),
    filter = StatisticsFilter(providers = listOf(Provider.HEALTH_CONNECT))
)

Reference:

About

Android SDK Documentation

Android SDK Usage Guide

Step 1: Create a Spike Connection

Step 2: Ask User for Permissions

Step 3: Get Data

Statistics

Records

​Step 1: Create a Spike Connection

​Step 2: Ask User for Permissions

​Step 3: Get Data

​Statistics

​Records

Step 1: Create a Spike Connection

Step 2: Ask User for Permissions

Step 3: Get Data

Statistics

Records