Skip to main content
Get Provider Record

Authorizations

Authorization
string
header
required

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

Path Parameters

record_id
string
required

Query Parameters

metrics
enum<string>[]
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,
power,
power_max,
duration_low_intensity,
duration_moderate_intensity,
duration_high_intensity
include_samples
boolean
include_provider_specific_metrics
boolean

Response

OK

modified_at
string<date-time>
required

Modified at

record_id
string<uuid>
required

Record ID

Example:

"12345678-1234-abcd-4321-abcdef123456"

start_at_timestamp
string<date-time>
required

Record start time

activity_id
string
activity_tags
enum<string>[] | null

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_type
enum<string>

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
duration
integer<int64>

Record duration

end_at_timestamp
string<date-time>

Record end time

input_method
enum<string>

Data input method

Available options:
unknown,
manual,
device
is_source_aggregated
boolean

If the record is already aggregated by the source, for example Apple Health aggregating steps from multiple devices

metrics
object

Metrics output

provider_local_date
string<date>

Provider local date

Example:

"2006-01-02"

provider_slug
string

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"

provider_source
enum<string>

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_type
enum<string>

Provider source types

Available options:
provider_summary,
intraday_aggregation,
activity_summary,
activity_file,
activity,
sample,
profile
provider_specific_metrics
object
samples
object
source
object
user_time_offset_minutes
integer<int32>

User time offset in minutes