Mobile SDKs
SpikeSDK iOS (v3)

Current Swift SDK Version: 4.0.11
Swift Package can be found here﻿
Requirements
iOS 13.0+
iOS Setup Guide
iOS Signing & Capabilities
To add HealthKit support to your application's Capabilities.
Open the iOS/ folder of your project in Xcode
Select the project name in the left sidebar
Open Signing & Capabilities section
In the main view select '+ Capability' and double click HealthKit
More details you can find here.
Info.plist
Add Health Kit permissions descriptions to your Info.plist file.
Text
<key>NSHealthShareUsageDescription</key>
<string>We will use your health information to better track workouts.</string>

<key>NSHealthUpdateUsageDescription</key>
<string>We will update your health information to better track workouts.</string>
<key>NSHealthShareUsageDescription</key>
<string>We will use your health information to better track workouts.</string>

<key>NSHealthUpdateUsageDescription</key>
<string>We will update your health information to better track workouts.</string>
﻿
SDK instalation
﻿
CocoaPods
CocoaPods is a dependency manager for Cocoa projects. To integrate SpikeSDK into your Xcode project using CocoaPods, specify it in your Podfile:
pod 'SpikeSDK'
Use pod install and pod update commands to install/update pods afterward.
Swift Package Manager
To integrate SpikeSDK into your Xcode project using Swift Package Manager, add it in your Package.swift or through the Project's Package Dependencies tab:
Text
dependencies: [
    .package(url: "https://gitlab.com/spike_api/spike-ios-sdk", .upToNextMinor(from: "2.3.0"))
]
dependencies: [
    .package(url: "https://gitlab.com/spike_api/spike-ios-sdk", .upToNextMinor(from: "2.3.0"))
]
﻿
Spike SDK Usage
Start getting Spike data in 3 steps. All Spike SDK async method calls should be wrapped into try catch block.
Step 1 - Create Spike connection
To set up the Spike SDK create SpikeConnectionV3 instance with your Spike application id, auth token and user id unique to each of your users:
Swift
import SpikeSDK

let spikeConnection = try await Spike.createConnectionV3(
    appId: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    authToken: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    customerEndUserId: userId
)

import SpikeSDK

let spikeConnection = try await Spike.createConnectionV3(
    appId: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    authToken: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    customerEndUserId: userId
)
﻿
Step 2 - Ask user for permissions
Provide permissions to access iOS HealthKit data. Spike SDK method will check required permissions and request them if needed. Permission dialog may not be shown according on iOS permissions rules.
Swift
try await spikeConnectionTemp.requestPermissions(forStatistics: [
        .stepsTotal,
        .distanceWalking,
    ]
)
try await spikeConnectionTemp.requestPermissions(forStatistics: [
        .stepsTotal,
        .distanceWalking,
    ]
)
﻿
Step 3 - Get data
Info: The maximum permitted date range is 90 days

There are two types of data you can retrieve from Spike:
Records consist of the raw data points collected from user devices or applications.
Statistics, on the other hand, are calculated values derived from records.
Statistics
Get daily statistics for steps and total distance from Apple Health:
Swift
func getStatistics(
    ofTypes types: [StatisticsType.steps],
    from: Date.now.addingTimeInterval(-60 * 60 * 24),
    to: Date.now,
    interval: StatisticsInterval.hour,
    filter: StatisticsFilter(providers: [.apple])
) async throws -> [Statistic]
func getStatistics(
    ofTypes types: [StatisticsType.steps],
    from: Date.now.addingTimeInterval(-60 * 60 * 24),
    to: Date.now,
    interval: StatisticsInterval.hour,
    filter: StatisticsFilter(providers: [.apple])
) async throws -> [Statistic]
﻿
where:
Swift
public enum StatisticsType: String {
    case steps
    case distanceTotal = "distance_total"
    case distanceWalking = "distance_walking"
    case distanceCycling = "distance_cycling"
    case distanceRunning = "distance_running"
    case caloriesBurnedTotal = "calories_burned_total"
    case caloriesBurnedBasal = "calories_burned_basal"
    case caloriesBurnedActive = "calories_burned_active"
}

public enum StatisticsInterval: String, Codable {
    case hour
    case day
}

public struct StatisticsFilter {
    public var excludeManual: Bool = false
    public var providers: [Provider]? = nil
}

// Result:

public struct Statistic: Codable, Hashable {
    public var start: Date
    public var end: Date
    public var duration: Int
    public var type: StatisticsType
    public var value: Double
    public var unit: Unit
    public var rowCount: Int?
    public var recordIds: [UUID]?
}
public enum StatisticsType: String {
    case steps
    case distanceTotal = "distance_total"
    case distanceWalking = "distance_walking"
    case distanceCycling = "distance_cycling"
    case distanceRunning = "distance_running"
    case caloriesBurnedTotal = "calories_burned_total"
    case caloriesBurnedBasal = "calories_burned_basal"
    case caloriesBurnedActive = "calories_burned_active"
}

public enum StatisticsInterval: String, Codable {
    case hour
    case day
}

public struct StatisticsFilter {
    public var excludeManual: Bool = false
    public var providers: [Provider]? = nil
}

// Result:

public struct Statistic: Codable, Hashable {
    public var start: Date
    public var end: Date
    public var duration: Int
    public var type: StatisticsType
    public var value: Double
    public var unit: Unit
    public var rowCount: Int?
    public var recordIds: [UUID]?
}
﻿
Records
Swift
func getRecords(
    ofTypes types: [MetricType.stepsTotal],
    from: Date.now.addingTimeInterval(-60 * 60 * 24),
    to: Date.now,
    filter: StatisticsFilter(providers: [.apple])
) async throws -> [Record]
func getRecords(
    ofTypes types: [MetricType.stepsTotal],
    from: Date.now.addingTimeInterval(-60 * 60 * 24),
    to: Date.now,
    filter: StatisticsFilter(providers: [.apple])
) async throws -> [Record]
﻿
where:
Swift
public enum MetricType: String, Codable, Hashable {
    case stepsTotal
    case distanceTotal
    case distanceWalking
    case distanceCycling
    case distanceRunning
    case caloriesBurnedActive
    case caloriesBurnedBasal
    case caloriesBurnedTotal
}

// Result

public struct Record: Codable, Hashable {
    public var recordId: UUID
    public var inputMethod: InputMethod?
    public var startAt: Date
    public var endAt: Date?
    public var modifiedAt: Date
    public var duration: Int?
    public var provider: Provider?
    public var providerSource: ProviderSource?
    public var isSourceAggregated: Bool?
    public var source: RecordSource?
    public var metrics: [String: Double]?
    public var activityTags: [ActivityTag]?
    public var activityType: ActivityType?
    public var sessions: [ActivityEntry]?
    public var laps: [ActivityEntry]?
    public var segments: [ActivityEntry]?
    public var splits: [ActivityEntry]?
    public var samples: [ActivitySamples]?
    public var routePoints: [ActivitySamples]?
}

public enum MetricType: String, Codable, Hashable {
    case stepsTotal
    case distanceTotal
    case distanceWalking
    case distanceCycling
    case distanceRunning
    case caloriesBurnedActive
    case caloriesBurnedBasal
    case caloriesBurnedTotal
}

// Result

public struct Record: Codable, Hashable {
    public var recordId: UUID
    public var inputMethod: InputMethod?
    public var startAt: Date
    public var endAt: Date?
    public var modifiedAt: Date
    public var duration: Int?
    public var provider: Provider?
    public var providerSource: ProviderSource?
    public var isSourceAggregated: Bool?
    public var source: RecordSource?
    public var metrics: [String: Double]?
    public var activityTags: [ActivityTag]?
    public var activityType: ActivityType?
    public var sessions: [ActivityEntry]?
    public var laps: [ActivityEntry]?
    public var segments: [ActivityEntry]?
    public var splits: [ActivityEntry]?
    public var samples: [ActivitySamples]?
    public var routePoints: [ActivitySamples]?
}
﻿
﻿
Did this page help you?
Statistics
SpikeSDK Android (v3)