Time Series

curl --request GET \
  --url https://app-api.spikeapi.com/v3/queries/timeseries \
  --header 'Authorization: Bearer <token>'

{
  "device_types": [
    "unknown"
  ],
  "durations": [
    123
  ],
  "from_timestamp": "2006-01-02T00:00:00Z",
  "metric": "heartrate_max",
  "offsets": [
    123
  ],
  "provider_sources": [
    "apple_healthkit_sample"
  ],
  "providers": [
    "strava"
  ],
  "record_ids": [
    "33e2c227-289b-448e-8e9f-6b1fdd93bc48"
  ],
  "to_timestamp": "2006-01-02T00:00:00Z",
  "values": [
    {}
  ]
}

API Reference: Querying Data

Time Series

This endpoint returns a time series for a given metric with automatic merge strategy selection. The system chooses the optimal merge method based on metric characteristics to ensure the best data quality without manual configuration.

Request Example

{
  "from_timestamp": "2024-01-01T00:00:00Z",
  "to_timestamp": "2024-01-02T00:00:00Z",
  "metric": "heartrate"
}

Response Example

{
  "metric": "heartrate",
  "start_at": "2024-01-01T00:00:00Z",
  "offsets": [0, 60000, 120000],
  "durations": [60000, 60000, 60000],
  "values": [100, 150, 200],
  "providers": ["garmin"]
}

The arrays offsets, durations, and values will all be of the same length. This alignment is crucial for interpreting the data correctly.

Overriding the Default Merge Method

To override the default merge strategy, use the merge_method parameter.

The default merge method is automatically selected based on the metric type and provides optimal data quality for most use cases. Only override the default if you have specific requirements that cannot be met by the automatic selection. This parameter is intended for advanced users who understand the implications of different merge strategies.

Source Selection Methods

Selects data from a single best provider source based on criteria like coverage, granularity, or priority. Only one source contributes to the final result, ensuring consistency but potentially losing data from other sources.

select_best_weighted_source: Best weighted coverage score mix of time coverage and data point density
select_highest_coverage_source: Highest total time coverage (sum of all entry durations)
select_most_granular_source: Most data points (highest entry count)
select_highest_priority_source_type: Sample > Intraday > Summary > Activity priority, then weighted coverage

Coverage Optimization Methods

Maximizes time coverage by selecting non-overlapping entries from multiple sources. Prioritizes filling time gaps while avoiding overlaps, using interval scheduling algorithms.

merge_maximize_coverage: Weighted interval scheduling to maximize total time coverage
merge_maximize_granularity: Source with most data points, then greedy interval scheduling
merge_maximize_weighted_coverage: Source with best weighted coverage score, then greedy interval scheduling

Sample Merging Methods

Combines all sample data points, resolving conflicts at identical timestamps by selecting the source with the most total entries. Preserves all available data while handling timestamp collisions.

merge_all_samples: All zero-duration samples, conflicts resolved by source with most total entries

Time Series

curl --request GET \
  --url https://app-api.spikeapi.com/v3/queries/timeseries \
  --header 'Authorization: Bearer <token>'

{
  "device_types": [
    "unknown"
  ],
  "durations": [
    123
  ],
  "from_timestamp": "2006-01-02T00:00:00Z",
  "metric": "heartrate_max",
  "offsets": [
    123
  ],
  "provider_sources": [
    "apple_healthkit_sample"
  ],
  "providers": [
    "strava"
  ],
  "record_ids": [
    "33e2c227-289b-448e-8e9f-6b1fdd93bc48"
  ],
  "to_timestamp": "2006-01-02T00:00:00Z",
  "values": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from_timestamp

string<date-time>

Start time of the query range in UTC

Examples:

"2006-01-02T15:04:05"

"2006-01-02T15:04:05Z"

to_timestamp

string<date-time>

End time of the query range in UTC

Examples:

"2006-01-02T15:04:05"

"2006-01-02T15:04:05Z"

metric

enum<string>

required

The metric you want to query

Available options:

heartrate_max,

heartrate_min,

heartrate_zone0_duration,

heartrate_zone1_duration,

heartrate_zone2_duration,

heartrate_zone3_duration,

heartrate_zone4_duration,

heartrate_zone5_duration,

heartrate,

heartrate_resting,

heartrate_resting_min,

heartrate_resting_max,

hrv_rmssd,

hrv_sdnn,

elevation_max,

elevation_min,

elevation_gain,

elevation_loss,

ascent,

descent,

calories_burned_active,

calories_burned_basal,

calories_burned,

calories_intake,

steps,

floors_climbed,

distance,

distance_walking,

distance_cycling,

distance_running,

distance_wheelchair,

distance_swimming,

speed,

speed_max,

speed_min,

air_temperature_max,

air_temperature,

air_temperature_min,

spo2,

spo2_max,

spo2_min,

breathing_rate,

breathing_rate_min,

breathing_rate_max,

longitude,

latitude,

elevation,

duration_active,

swimming_lengths,

swimming_distance_per_stroke,

sleep_efficiency,

sleep_duration,

sleep_duration_deep,

sleep_duration_light,

sleep_duration_rem,

sleep_duration_awake,

bedtime_duration,

sleep_interruptions,

sleep_duration_nap,

sleep_score,

sleep_breathing_rate,

sleep_breathing_rate_min,

sleep_breathing_rate_max,

sleep_latency,

wakeup_latency,

cadence,

cadence_min,

cadence_max,

pace,

body_mass_index,

weight,

height,

vo2max,

body_temperature,

body_temperature_max,

body_temperature_min,

basal_body_temperature,

basal_body_temperature_max,

basal_body_temperature_min,

skin_temperature,

skin_temperature_max,

skin_temperature_min,

sleep_skin_temperature_deviation,

ecg_voltage,

ecg_rri,

body_fat,

body_fat_min,

body_fat_max,

blood_pressure_systolic,

blood_pressure_systolic_min,

blood_pressure_systolic_max,

blood_pressure_diastolic,

blood_pressure_diastolic_min,

blood_pressure_diastolic_max,

body_bone_mass,

glucose

providers

enum<string>[]

Show child attributes

include_record_ids

boolean

Whether to include the record IDs in the response

merge_method

enum<string>

Method to merge data

Available options:

select_best_weighted_source,

select_highest_coverage_source,

select_most_granular_source,

select_highest_priority_source_type,

merge_maximize_coverage,

merge_maximize_granularity,

merge_maximize_weighted_coverage,

merge_all_samples

device_types

enum<string>[]

Device types to include

Show child attributes

Response

metric

enum<string>

required

The metric type for these timeseries

Available options:

heartrate_max,

heartrate_min,

heartrate_zone0_duration,

heartrate_zone1_duration,

heartrate_zone2_duration,

heartrate_zone3_duration,

heartrate_zone4_duration,

heartrate_zone5_duration,

heartrate,

heartrate_resting,

heartrate_resting_min,

heartrate_resting_max,

hrv_rmssd,

hrv_sdnn,

elevation_max,

elevation_min,

elevation_gain,

elevation_loss,

ascent,

descent,

calories_burned_active,

calories_burned_basal,

calories_burned,

calories_intake,

steps,

floors_climbed,

distance,

distance_walking,

distance_cycling,

distance_running,

distance_wheelchair,

distance_swimming,

speed,

speed_max,

speed_min,

air_temperature_max,

air_temperature,

air_temperature_min,

spo2,

spo2_max,

spo2_min,

breathing_rate,

breathing_rate_min,

breathing_rate_max,

longitude,

latitude,

elevation,

duration_active,

swimming_lengths,

swimming_distance_per_stroke,

sleep_efficiency,

sleep_duration,

sleep_duration_deep,

sleep_duration_light,

sleep_duration_rem,

sleep_duration_awake,

bedtime_duration,

sleep_interruptions,

sleep_duration_nap,

sleep_score,

sleep_breathing_rate,

sleep_breathing_rate_min,

sleep_breathing_rate_max,

sleep_latency,

wakeup_latency,

cadence,

cadence_min,

cadence_max,

pace,

body_mass_index,

weight,

height,

vo2max,

body_temperature,

body_temperature_max,

body_temperature_min,

basal_body_temperature,

basal_body_temperature_max,

basal_body_temperature_min,

skin_temperature,

skin_temperature_max,

skin_temperature_min,

sleep_skin_temperature_deviation,

ecg_voltage,

ecg_rri,

body_fat,

body_fat_min,

body_fat_max,

blood_pressure_systolic,

blood_pressure_systolic_min,

blood_pressure_systolic_max,

blood_pressure_diastolic,

blood_pressure_diastolic_min,

blood_pressure_diastolic_max,

body_bone_mass,

glucose

device_types

enum<string>[]

Device types involved for these timeseries

Show child attributes

durations

integer[] | null

Duration of each timeseries entry in milliseconds

from_timestamp

string<date-time>

Examples:

"2006-01-02T00:00:00Z"

offsets

integer[] | null

Millisecond offsets from the start_at timestamp

provider_sources

enum<string>[]

Provider sources involved for these timeseries

Show child attributes

providers

string[]

Providers involved for these timeseries

Provider slugs

record_ids

string<uuid>[] | null

IDs of the records containing these timeseries

Unique identifier for a record.

to_timestamp

string<date-time>

Examples:

"2006-01-02T00:00:00Z"

values

object[] | null

The actual metric values for each timeseries entry

Daily Statistics

Supported Providers

Integrating with SpikeAPI

API Reference: User Management

API Reference: Querying Data

Types and Definitions

Release Notes

Time Series

Request Example

Response Example

Overriding the Default Merge Method

Source Selection Methods

Coverage Optimization Methods

Sample Merging Methods

Authorizations

Query Parameters

Response