Get Workout
curl --request GET \
--url https://app-api.spikeapi.com/v3/queries/workouts/{workout_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"modified_at": "2023-11-07T05:31:56Z",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_at_timestamp": "2023-11-07T05:31:56Z",
"duration": 123,
"end_at_timestamp": "2023-11-07T05:31:56Z",
"is_source_aggregated": true,
"laps": [
{
"duration": 123,
"end_at": "2023-11-07T05:31:56Z",
"lap": 123,
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"start_at": "2023-11-07T05:31:56Z"
}
],
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"provider_local_date": "2023-12-25",
"provider_slug": "<string>",
"route_points": {
"durations": [
123
],
"offsets": [
123
],
"values": {
"air_temperature": [
123
],
"air_temperature_max": [
123
],
"air_temperature_min": [
123
],
"ascent": [
123
],
"basal_body_temperature": [
123
],
"basal_body_temperature_max": [
123
],
"basal_body_temperature_min": [
123
],
"bedtime_duration": [
123
],
"blood_pressure_diastolic": [
123
],
"blood_pressure_diastolic_max": [
123
],
"blood_pressure_diastolic_min": [
123
],
"blood_pressure_systolic": [
123
],
"blood_pressure_systolic_max": [
123
],
"blood_pressure_systolic_min": [
123
],
"body_bone_mass": [
123
],
"body_fat": [
123
],
"body_fat_max": [
123
],
"body_fat_min": [
123
],
"body_mass_index": [
123
],
"body_temperature": [
123
],
"body_temperature_max": [
123
],
"body_temperature_min": [
123
],
"breathing_rate": [
123
],
"breathing_rate_max": [
123
],
"breathing_rate_min": [
123
],
"cadence": [
123
],
"cadence_max": [
123
],
"cadence_min": [
123
],
"calories_burned": [
123
],
"calories_burned_active": [
123
],
"calories_burned_basal": [
123
],
"calories_intake": [
123
],
"descent": [
123
],
"distance": [
123
],
"distance_cycling": [
123
],
"distance_running": [
123
],
"distance_swimming": [
123
],
"distance_walking": [
123
],
"distance_wheelchair": [
123
],
"duration_active": [
123
],
"duration_high_intensity": [
123
],
"duration_low_intensity": [
123
],
"duration_moderate_intensity": [
123
],
"ecg_rri": [
123
],
"ecg_voltage": [
123
],
"elevation": [
123
],
"elevation_gain": [
123
],
"elevation_loss": [
123
],
"elevation_max": [
123
],
"elevation_min": [
123
],
"floors_climbed": [
123
],
"glucose": [
123
],
"heartrate": [
123
],
"heartrate_max": [
123
],
"heartrate_min": [
123
],
"heartrate_resting": [
123
],
"heartrate_resting_max": [
123
],
"heartrate_resting_min": [
123
],
"heartrate_zone0_duration": [
123
],
"heartrate_zone1_duration": [
123
],
"heartrate_zone2_duration": [
123
],
"heartrate_zone3_duration": [
123
],
"heartrate_zone4_duration": [
123
],
"heartrate_zone5_duration": [
123
],
"height": [
123
],
"hrv_rmssd": [
123
],
"hrv_sdnn": [
123
],
"latitude": [
123
],
"longitude": [
123
],
"pace": [
123
],
"power": [
123
],
"power_max": [
123
],
"skin_temperature": [
123
],
"skin_temperature_max": [
123
],
"skin_temperature_min": [
123
],
"sleep_breathing_rate": [
123
],
"sleep_breathing_rate_max": [
123
],
"sleep_breathing_rate_min": [
123
],
"sleep_duration": [
123
],
"sleep_duration_awake": [
123
],
"sleep_duration_deep": [
123
],
"sleep_duration_light": [
123
],
"sleep_duration_nap": [
123
],
"sleep_duration_rem": [
123
],
"sleep_efficiency": [
123
],
"sleep_interruptions": [
123
],
"sleep_latency": [
123
],
"sleep_score": [
123
],
"sleep_skin_temperature_deviation": [
123
],
"speed": [
123
],
"speed_max": [
123
],
"speed_min": [
123
],
"spo2": [
123
],
"spo2_max": [
123
],
"spo2_min": [
123
],
"steps": [
123
],
"swimming_distance_per_stroke": [
123
],
"swimming_lengths": [
123
],
"vo2max": [
123
],
"wakeup_latency": [
123
],
"weight": [
123
]
}
},
"samples": {
"durations": [
123
],
"offsets": [
123
],
"values": {
"air_temperature": [
123
],
"air_temperature_max": [
123
],
"air_temperature_min": [
123
],
"ascent": [
123
],
"basal_body_temperature": [
123
],
"basal_body_temperature_max": [
123
],
"basal_body_temperature_min": [
123
],
"bedtime_duration": [
123
],
"blood_pressure_diastolic": [
123
],
"blood_pressure_diastolic_max": [
123
],
"blood_pressure_diastolic_min": [
123
],
"blood_pressure_systolic": [
123
],
"blood_pressure_systolic_max": [
123
],
"blood_pressure_systolic_min": [
123
],
"body_bone_mass": [
123
],
"body_fat": [
123
],
"body_fat_max": [
123
],
"body_fat_min": [
123
],
"body_mass_index": [
123
],
"body_temperature": [
123
],
"body_temperature_max": [
123
],
"body_temperature_min": [
123
],
"breathing_rate": [
123
],
"breathing_rate_max": [
123
],
"breathing_rate_min": [
123
],
"cadence": [
123
],
"cadence_max": [
123
],
"cadence_min": [
123
],
"calories_burned": [
123
],
"calories_burned_active": [
123
],
"calories_burned_basal": [
123
],
"calories_intake": [
123
],
"descent": [
123
],
"distance": [
123
],
"distance_cycling": [
123
],
"distance_running": [
123
],
"distance_swimming": [
123
],
"distance_walking": [
123
],
"distance_wheelchair": [
123
],
"duration_active": [
123
],
"duration_high_intensity": [
123
],
"duration_low_intensity": [
123
],
"duration_moderate_intensity": [
123
],
"ecg_rri": [
123
],
"ecg_voltage": [
123
],
"elevation": [
123
],
"elevation_gain": [
123
],
"elevation_loss": [
123
],
"elevation_max": [
123
],
"elevation_min": [
123
],
"floors_climbed": [
123
],
"glucose": [
123
],
"heartrate": [
123
],
"heartrate_max": [
123
],
"heartrate_min": [
123
],
"heartrate_resting": [
123
],
"heartrate_resting_max": [
123
],
"heartrate_resting_min": [
123
],
"heartrate_zone0_duration": [
123
],
"heartrate_zone1_duration": [
123
],
"heartrate_zone2_duration": [
123
],
"heartrate_zone3_duration": [
123
],
"heartrate_zone4_duration": [
123
],
"heartrate_zone5_duration": [
123
],
"height": [
123
],
"hrv_rmssd": [
123
],
"hrv_sdnn": [
123
],
"latitude": [
123
],
"longitude": [
123
],
"pace": [
123
],
"power": [
123
],
"power_max": [
123
],
"skin_temperature": [
123
],
"skin_temperature_max": [
123
],
"skin_temperature_min": [
123
],
"sleep_breathing_rate": [
123
],
"sleep_breathing_rate_max": [
123
],
"sleep_breathing_rate_min": [
123
],
"sleep_duration": [
123
],
"sleep_duration_awake": [
123
],
"sleep_duration_deep": [
123
],
"sleep_duration_light": [
123
],
"sleep_duration_nap": [
123
],
"sleep_duration_rem": [
123
],
"sleep_efficiency": [
123
],
"sleep_interruptions": [
123
],
"sleep_latency": [
123
],
"sleep_score": [
123
],
"sleep_skin_temperature_deviation": [
123
],
"speed": [
123
],
"speed_max": [
123
],
"speed_min": [
123
],
"spo2": [
123
],
"spo2_max": [
123
],
"spo2_min": [
123
],
"steps": [
123
],
"swimming_distance_per_stroke": [
123
],
"swimming_lengths": [
123
],
"vo2max": [
123
],
"wakeup_latency": [
123
],
"weight": [
123
]
}
},
"segments": [
{
"duration": 123,
"end_at": "2023-11-07T05:31:56Z",
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"start_at": "2023-11-07T05:31:56Z"
}
],
"sessions": [
{
"duration": 123,
"end_at": "2023-11-07T05:31:56Z",
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"start_at": "2023-11-07T05:31:56Z"
}
],
"source": {
"device_manufacturer": "<string>",
"device_model": "<string>",
"device_product": "<string>",
"device_version": "<string>",
"source_bundle_identifier": "<string>",
"source_os_version": "<string>",
"source_product": "<string>",
"source_version": "<string>"
},
"splits": [
{
"duration": 123,
"end_at": "2023-11-07T05:31:56Z",
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"start_at": "2023-11-07T05:31:56Z"
}
],
"user_time_offset_minutes": 123,
"workout_id": "<string>",
"workout_name": "<string>",
"workout_tags": []
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Get Workout
This endpoint returns detailed information about a single workout by its activity ID. It provides comprehensive workout data including all available metrics, breakdowns, and associated data points for the specified activity.
Workout Details
A single workout contains complete information about the activity:
- Base Information: Start time, end time, duration, user time offset, input method, and source provider
- Activity Metadata: Workout ID, name, type, and associated tags
- Metrics: Base metrics (distance, calories, duration) and provider-specific metrics
- Detailed Breakdowns: Sessions, laps, splits, segments, and route information
- Sample Data: Time-series data points with offsets, durations, and values
Data Components
The endpoint supports various inclusion parameters to customize the response:
- Sessions: Include workout session breakdowns with detailed metrics
- Laps: Include lap-by-lap data for structured activities with lap numbers
- Samples: Include detailed time-series data points with metric values
- Route Points: Include GPS coordinates and elevation data for route visualization
- Splits: Include split times and metrics for timed activities
- Segments: Include segment breakdowns for complex workouts
Sample Data Structure
When samples are included, the response contains time-series data with:
- Offsets: Time offsets from the workout start in milliseconds
- Durations: Duration of each data point in milliseconds
- Values: Metric values organized by metric type (heart rate, pace, etc.)
Route Information
Route points provide GPS and location data:
- Latitude/Longitude: Geographic coordinates for route visualization
- Elevation: Altitude data when available
- Timing: Precise timing information for each route point
Activity Breakdowns
Complex workouts may include multiple breakdowns:
- Sessions: Different phases or segments of the workout
- Laps: Individual laps for track or structured activities
- Splits: Time splits for performance analysis
- Segments: Custom segments defined by the activity
All timestamps in the response are in the UTC timezone.
Get Workout
curl --request GET \
--url https://app-api.spikeapi.com/v3/queries/workouts/{workout_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app-api.spikeapi.com/v3/queries/workouts/{workout_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"modified_at": "2023-11-07T05:31:56Z",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_at_timestamp": "2023-11-07T05:31:56Z",
"duration": 123,
"end_at_timestamp": "2023-11-07T05:31:56Z",
"is_source_aggregated": true,
"laps": [
{
"duration": 123,
"end_at": "2023-11-07T05:31:56Z",
"lap": 123,
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"start_at": "2023-11-07T05:31:56Z"
}
],
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"provider_local_date": "2023-12-25",
"provider_slug": "<string>",
"route_points": {
"durations": [
123
],
"offsets": [
123
],
"values": {
"air_temperature": [
123
],
"air_temperature_max": [
123
],
"air_temperature_min": [
123
],
"ascent": [
123
],
"basal_body_temperature": [
123
],
"basal_body_temperature_max": [
123
],
"basal_body_temperature_min": [
123
],
"bedtime_duration": [
123
],
"blood_pressure_diastolic": [
123
],
"blood_pressure_diastolic_max": [
123
],
"blood_pressure_diastolic_min": [
123
],
"blood_pressure_systolic": [
123
],
"blood_pressure_systolic_max": [
123
],
"blood_pressure_systolic_min": [
123
],
"body_bone_mass": [
123
],
"body_fat": [
123
],
"body_fat_max": [
123
],
"body_fat_min": [
123
],
"body_mass_index": [
123
],
"body_temperature": [
123
],
"body_temperature_max": [
123
],
"body_temperature_min": [
123
],
"breathing_rate": [
123
],
"breathing_rate_max": [
123
],
"breathing_rate_min": [
123
],
"cadence": [
123
],
"cadence_max": [
123
],
"cadence_min": [
123
],
"calories_burned": [
123
],
"calories_burned_active": [
123
],
"calories_burned_basal": [
123
],
"calories_intake": [
123
],
"descent": [
123
],
"distance": [
123
],
"distance_cycling": [
123
],
"distance_running": [
123
],
"distance_swimming": [
123
],
"distance_walking": [
123
],
"distance_wheelchair": [
123
],
"duration_active": [
123
],
"duration_high_intensity": [
123
],
"duration_low_intensity": [
123
],
"duration_moderate_intensity": [
123
],
"ecg_rri": [
123
],
"ecg_voltage": [
123
],
"elevation": [
123
],
"elevation_gain": [
123
],
"elevation_loss": [
123
],
"elevation_max": [
123
],
"elevation_min": [
123
],
"floors_climbed": [
123
],
"glucose": [
123
],
"heartrate": [
123
],
"heartrate_max": [
123
],
"heartrate_min": [
123
],
"heartrate_resting": [
123
],
"heartrate_resting_max": [
123
],
"heartrate_resting_min": [
123
],
"heartrate_zone0_duration": [
123
],
"heartrate_zone1_duration": [
123
],
"heartrate_zone2_duration": [
123
],
"heartrate_zone3_duration": [
123
],
"heartrate_zone4_duration": [
123
],
"heartrate_zone5_duration": [
123
],
"height": [
123
],
"hrv_rmssd": [
123
],
"hrv_sdnn": [
123
],
"latitude": [
123
],
"longitude": [
123
],
"pace": [
123
],
"power": [
123
],
"power_max": [
123
],
"skin_temperature": [
123
],
"skin_temperature_max": [
123
],
"skin_temperature_min": [
123
],
"sleep_breathing_rate": [
123
],
"sleep_breathing_rate_max": [
123
],
"sleep_breathing_rate_min": [
123
],
"sleep_duration": [
123
],
"sleep_duration_awake": [
123
],
"sleep_duration_deep": [
123
],
"sleep_duration_light": [
123
],
"sleep_duration_nap": [
123
],
"sleep_duration_rem": [
123
],
"sleep_efficiency": [
123
],
"sleep_interruptions": [
123
],
"sleep_latency": [
123
],
"sleep_score": [
123
],
"sleep_skin_temperature_deviation": [
123
],
"speed": [
123
],
"speed_max": [
123
],
"speed_min": [
123
],
"spo2": [
123
],
"spo2_max": [
123
],
"spo2_min": [
123
],
"steps": [
123
],
"swimming_distance_per_stroke": [
123
],
"swimming_lengths": [
123
],
"vo2max": [
123
],
"wakeup_latency": [
123
],
"weight": [
123
]
}
},
"samples": {
"durations": [
123
],
"offsets": [
123
],
"values": {
"air_temperature": [
123
],
"air_temperature_max": [
123
],
"air_temperature_min": [
123
],
"ascent": [
123
],
"basal_body_temperature": [
123
],
"basal_body_temperature_max": [
123
],
"basal_body_temperature_min": [
123
],
"bedtime_duration": [
123
],
"blood_pressure_diastolic": [
123
],
"blood_pressure_diastolic_max": [
123
],
"blood_pressure_diastolic_min": [
123
],
"blood_pressure_systolic": [
123
],
"blood_pressure_systolic_max": [
123
],
"blood_pressure_systolic_min": [
123
],
"body_bone_mass": [
123
],
"body_fat": [
123
],
"body_fat_max": [
123
],
"body_fat_min": [
123
],
"body_mass_index": [
123
],
"body_temperature": [
123
],
"body_temperature_max": [
123
],
"body_temperature_min": [
123
],
"breathing_rate": [
123
],
"breathing_rate_max": [
123
],
"breathing_rate_min": [
123
],
"cadence": [
123
],
"cadence_max": [
123
],
"cadence_min": [
123
],
"calories_burned": [
123
],
"calories_burned_active": [
123
],
"calories_burned_basal": [
123
],
"calories_intake": [
123
],
"descent": [
123
],
"distance": [
123
],
"distance_cycling": [
123
],
"distance_running": [
123
],
"distance_swimming": [
123
],
"distance_walking": [
123
],
"distance_wheelchair": [
123
],
"duration_active": [
123
],
"duration_high_intensity": [
123
],
"duration_low_intensity": [
123
],
"duration_moderate_intensity": [
123
],
"ecg_rri": [
123
],
"ecg_voltage": [
123
],
"elevation": [
123
],
"elevation_gain": [
123
],
"elevation_loss": [
123
],
"elevation_max": [
123
],
"elevation_min": [
123
],
"floors_climbed": [
123
],
"glucose": [
123
],
"heartrate": [
123
],
"heartrate_max": [
123
],
"heartrate_min": [
123
],
"heartrate_resting": [
123
],
"heartrate_resting_max": [
123
],
"heartrate_resting_min": [
123
],
"heartrate_zone0_duration": [
123
],
"heartrate_zone1_duration": [
123
],
"heartrate_zone2_duration": [
123
],
"heartrate_zone3_duration": [
123
],
"heartrate_zone4_duration": [
123
],
"heartrate_zone5_duration": [
123
],
"height": [
123
],
"hrv_rmssd": [
123
],
"hrv_sdnn": [
123
],
"latitude": [
123
],
"longitude": [
123
],
"pace": [
123
],
"power": [
123
],
"power_max": [
123
],
"skin_temperature": [
123
],
"skin_temperature_max": [
123
],
"skin_temperature_min": [
123
],
"sleep_breathing_rate": [
123
],
"sleep_breathing_rate_max": [
123
],
"sleep_breathing_rate_min": [
123
],
"sleep_duration": [
123
],
"sleep_duration_awake": [
123
],
"sleep_duration_deep": [
123
],
"sleep_duration_light": [
123
],
"sleep_duration_nap": [
123
],
"sleep_duration_rem": [
123
],
"sleep_efficiency": [
123
],
"sleep_interruptions": [
123
],
"sleep_latency": [
123
],
"sleep_score": [
123
],
"sleep_skin_temperature_deviation": [
123
],
"speed": [
123
],
"speed_max": [
123
],
"speed_min": [
123
],
"spo2": [
123
],
"spo2_max": [
123
],
"spo2_min": [
123
],
"steps": [
123
],
"swimming_distance_per_stroke": [
123
],
"swimming_lengths": [
123
],
"vo2max": [
123
],
"wakeup_latency": [
123
],
"weight": [
123
]
}
},
"segments": [
{
"duration": 123,
"end_at": "2023-11-07T05:31:56Z",
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"start_at": "2023-11-07T05:31:56Z"
}
],
"sessions": [
{
"duration": 123,
"end_at": "2023-11-07T05:31:56Z",
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"start_at": "2023-11-07T05:31:56Z"
}
],
"source": {
"device_manufacturer": "<string>",
"device_model": "<string>",
"device_product": "<string>",
"device_version": "<string>",
"source_bundle_identifier": "<string>",
"source_os_version": "<string>",
"source_product": "<string>",
"source_version": "<string>"
},
"splits": [
{
"duration": 123,
"end_at": "2023-11-07T05:31:56Z",
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"duration_high_intensity": 123,
"duration_low_intensity": 123,
"duration_moderate_intensity": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"power": 123,
"power_max": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"start_at": "2023-11-07T05:31:56Z"
}
],
"user_time_offset_minutes": 123,
"workout_id": "<string>",
"workout_name": "<string>",
"workout_tags": []
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workout ID
Query Parameters
Include sessions
Include laps
Include samples
Include route points
Include splits
Include segments
Response
OK
Modified at
Record ID
Example:
"12345678-1234-abcd-4321-abcdef123456"
Record start time
Record duration
Record end time
Data input method
Available options:
unknown, manual, device If the record is already aggregated by the source, for example Apple Health aggregating steps from multiple devices
Show child attributes
Show child attributes
Metrics output
Show child attributes
Show child attributes
Provider local date
Example:
"2006-01-02"
Provider slugs
Examples:
"strava"
"omron_eu"
"omron_us"
"health_connect"
"fitbit"
"garmin"
"huawei"
"dexcom"
"whoop"
"withings"
"suunto"
"google_health"
"apple"
"freestyle_libre"
"oura"
"polar"
"coros"
"ultrahuman"
"samsung_health_data"
"luna"
Source of the record according to the provider
Available options:
apple_healthkit_sample, apple_healthkit_activity, apple_healthkit_sample_category, apple_healthkit_sleep_aggregation, apple_healthkit_dietary_item, apple_healthkit_statistics, apple_healthkit_characteristics, apple_healthkit_ecgs, apple_healthkit_mindfulness, health_connect_record, health_connect_activity, health_connect_mindfulness_session, health_connect_aggregation, fitbit_activities_list, fitbit_activities_daily_summary, fitbit_activities_daily_summary_activity, fitbit_activity_heart_intraday, fitbit_activity_steps_intraday, fitbit_activity_distance_intraday, fitbit_activity_calories_intraday, fitbit_hrv_summary, fitbit_hrv_intraday, fitbit_vo2max_summary, fitbit_sleep_summary, fitbit_activity_tcx, fitbit_br_summary, fitbit_br_intraday, fitbit_spo2_summary, fitbit_spo2_intraday, fitbit_core_temperature_summary, fitbit_skin_temperature_summary, fitbit_ecg, fitbit_body_log_fat, fitbit_body_log_weight, garmin_wellness_epochs, garmin_wellness_dailies, garmin_wellness_activities, garmin_wellness_activity_details, garmin_wellness_sleep, garmin_wellness_activity_file, garmin_wellness_hrv, garmin_wellness_user_metrics, garmin_wellness_body_comps, garmin_wellness_blood_pressures, garmin_wellness_stress_details, garmin_wellness_skin_temperature, oura_user_collection_daily_activity_document, oura_user_collection_sleep_document, oura_user_collection_workout_document, oura_user_collection_daily_spo2_document, oura_user_collection_vo2_max, oura_user_collection_hr_document, oura_user_collection_session_document, oura_personal_info, oura_user_collection_daily_sleep, polar_continuous_heart_rate_by_date, polar_exercise, polar_exercise_fit_file, polar_sleep_available, polar_activity_transaction, polar_activity_transaction_steps, polar_sleep_by_date, polar_nightly_recharge, polar_biosensing_spo2, polar_biosensing_body_temperature, polar_biosensing_skin_temperature, polar_physical_information, polar_biosensing_ecg, polar_user_info, strava_activity, suunto_workout_summary, suunto_workout_fit_file, suunto_activity_samples, suunto_activity_daily_summary, suunto_sleep_samples, whoop_cycle, whoop_cycle_recovery, whoop_activity_sleep, whoop_activity_workout, whoop_user_body_measurement, withings_sleep_summary, withings_sleep_get, withings_measure_workouts, withings_measure_activity, withings_measure_meas, withings_measure_activity_intraday, withings_heart_list, withings_heart_get, withings_sleep_combined, wahoo_workout_summary, wahoo_workout_fit_file, huawei_activity_record, huawei_sampling_data_daily_activity_summary, huawei_sampling_data_details, huawei_sampling_data_statistics, huawei_sampling_data_daily, huawei_health_record, huawei_sampling_data_latest, ultrahuman_heartrate_metrics, ultrahuman_hrv_metrics, ultrahuman_temp_metrics, ultrahuman_heartrate_resting_metrics, ultrahuman_steps_metrics, ultrahuman_vo2max_metrics, ultrahuman_glucose_metrics, ultrahuman_sleep_metrics, coros_workout, coros_workout_fit_file, coros_daily_record, coros_daily_record_sleep, samsung_health_data_aggregation, samsung_health_data_samples, samsung_health_data_user_profile, samsung_health_data_exercise, samsung_health_data_sleep, dexcom_egvs, freestyle_libre_glucose, luna_sleep, luna_heart_rate, omron_us_blood_pressure, omron_us_hourly_activity, omron_us_weight, omron_us_temperature, omron_us_oxygen, omron_eu_blood_pressure, omron_eu_hourly_activity, omron_eu_weight, omron_eu_temperature, omron_eu_oxygen, map_my_fitness_workout, google_health_data_point_interval, google_health_data_point_session, google_health_data_point_sample, google_health_data_point_daily, google_health_rollup, google_health_rollup_daily, google_health_exercise_tcx, compat_apple_healthkit_entry, compat_health_connect_entry Provider source types
Available options:
provider_summary, intraday_aggregation, activity_summary, activity_file, activity, sample, profile Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
User time offset in minutes
Activity tags
Available options:
on_foot, running, cycling, walking, gym, swimming, winter_sports, water_sports, team_sports, racket_sports, individual_sports, outdoor_recreation, dancing, martial_arts, wheelchair, climbing, workout, sleep, ecg, lab_report, mindfulness Activity types
Available options:
other, sedentary, aerobics, play, house_work, gardening, work, sleep, workout, ecg_measurement, running, indoor_running, obstacle_run, street_running, track_running, trail_running, treadmill_running, ultra_running, virtual_running, triathlon, biathlon, duathlon, cycling, bmx_cycling, cyclocross_cycling, downhill_biking, e_bike_fitness, e_bike_mountain, gravel_cycling, indoor_cycling, mountain_biking, recumbent_cycling, road_biking, track_cycling, virtual_ride, hand_cycling, indoor_hand_cycling, rollerblading, skateboarding, skating, gym, bouldering, elliptical, indoor_cardio, hiit, indoor_climbing, indoor_rowing, pilates, stair_climbing, strength_training, yoga, meditation, rope_skipping, gymnastics, core_training, mixed_training, crossfit, calisthenics, warm_up, cool_down, flexibility_training, weight_lifting, functional_fitness, stretching, swimming, open_water_swimming, walking, casual_walking, speed_walking, hiking, stroller, winter_sports, backcountry_snowboarding, backcountry_skiing, cross_country_classic_skiing, skiing, snowboarding, skiing_snowboarding, cross_country_skate_skiing, skating_skiing, snow_shoeing, snowmobiling, curling, water_sports, boating, kayaking, kiteboarding, offshore_grinding, onshore_grinding, paddling, rowing, sailing, snorkeling, stand_up_paddleboarding, surfing, wakeboarding, waterskiing, whitewater_rafting, windsurfing, canoeing, team_sports, american_football, baseball, basketball, cricket, field_hockey, ice_hockey, lacrosse, rugby, soccer, softball, disc, volleyball, australian_football, handball, water_polo, floorball, netball, paintball, polo, racket_sports, badminton, padel, pickleball, platform_tennis, racquetball, squash, table_tennis, tennis, paddle_ball, martial_arts, boxing, mixed_martial_arts, kickboxing, muay_thai, wrestling, judo, karate, taekwondo, aikido, capoeira, kung_fu, tai_chi, jiu_jitsu, dancing, barre, climbing, wheelchair_push_run, wheelchair_push_walk, archery, bowling, fencing, golf, jumping, parkour, equestrian, hunting, fishing, diving, outdoor_recreation, geocaching, orienteering, bootcamp, motorsports, horseriding, paragliding, multisport, blood_test, mindfulness_session ⌘I