Get Provider Record

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

{
  "modified_at": "2023-11-07T05:31:56Z",
  "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_at_timestamp": "2023-11-07T05:31:56Z",
  "activity_id": "<string>",
  "activity_tags": [],
  "duration": 123,
  "end_at_timestamp": "2023-11-07T05:31:56Z",
  "is_source_aggregated": true,
  "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>",
  "provider_specific_metrics": {
    "garmin": {
      "overall_sleep_score_qualifier_key": "<string>",
      "overall_sleep_score_value": 123,
      "time_offset_stress_level_values": "<string>"
    },
    "huawei": {
      "sleep_score": 123
    },
    "oura": {
      "readiness_score": 123,
      "sleep_score": 123
    },
    "polar": {
      "sleep_score": 123
    },
    "suunto": {
      "sleep_quality_score": 123
    },
    "whoop": {
      "recovery_score": 123,
      "sleep_consistency_percentage": 123,
      "sleep_performance_percentage": 123
    },
    "withings": {
      "sleep_score": 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
      ]
    }
  },
  "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>"
  },
  "user_time_offset_minutes": 123
}

Get Provider Record

This endpoint allows you to query a single provider record with metrics by ID. It supports including sample data based on time series and provider-specific metrics in the response.

The response includes a single record with raw data from the provider transformed into the unified data model, possibly including:

base information (start, end, duration, user time offset, input method, source provider, etc.)
metrics (base and provider-specific)
activity information such as activity ID, type, and tags
activity breakdown into laps, sessions, etc. with related sample data
sleep with sample data

All timestamps in the response are in the UTC timezone.

Get Provider Record

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

{
  "modified_at": "2023-11-07T05:31:56Z",
  "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_at_timestamp": "2023-11-07T05:31:56Z",
  "activity_id": "<string>",
  "activity_tags": [],
  "duration": 123,
  "end_at_timestamp": "2023-11-07T05:31:56Z",
  "is_source_aggregated": true,
  "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>",
  "provider_specific_metrics": {
    "garmin": {
      "overall_sleep_score_qualifier_key": "<string>",
      "overall_sleep_score_value": 123,
      "time_offset_stress_level_values": "<string>"
    },
    "huawei": {
      "sleep_score": 123
    },
    "oura": {
      "readiness_score": 123,
      "sleep_score": 123
    },
    "polar": {
      "sleep_score": 123
    },
    "suunto": {
      "sleep_quality_score": 123
    },
    "whoop": {
      "recovery_score": 123,
      "sleep_consistency_percentage": 123,
      "sleep_performance_percentage": 123
    },
    "withings": {
      "sleep_score": 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
      ]
    }
  },
  "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>"
  },
  "user_time_offset_minutes": 123
}

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

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

Show child attributes

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"

"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_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,

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,

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

Show child attributes

samples

object

Show child attributes

source

object

Show child attributes

user_time_offset_minutes

integer<int32>

User time offset in minutes

List Provider Records

List Sleeps

Documentation Index

Authorizations

Path Parameters

Query Parameters

Response