{ "components": { "schemas": { "ActivityDivision": { "additionalProperties": false, "properties": { "division_ref": { "format": "int64", "type": "integer" }, "division_type_id": { "format": "int32", "minimum": 0, "type": "integer" }, "duration": { "format": "int64", "type": "integer" }, "metrics": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" } }, "type": "object" }, "ActivityEntry": { "additionalProperties": false, "properties": { "division_ref": { "format": "int64", "type": "integer" }, "division_type_id": { "format": "int32", "minimum": 0, "type": "integer" }, "duration": { "format": "int64", "type": "integer" }, "metrics": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" }, "offset": { "format": "int64", "type": "integer" }, "offset_durations": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "offset_metrics": { "additionalProperties": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "type": "object" }, "offsets": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] } }, "type": "object" }, "ApplicationInfo": { "additionalProperties": false, "properties": { "auth_flow": { "description": "Authentication flow", "enum": [ "client_token", "hmac", "pkcs1" ], "type": "string" }, "created_at": { "description": "Creation date", "format": "date-time", "type": "string" }, "dataset_manifest": { "$ref": "#/components/schemas/DatasetApplicationManifest", "description": "Dataset manifest" }, "id": { "description": "Application ID", "format": "int64", "type": "integer" }, "status": { "description": "Status", "type": "string" }, "updated_at": { "description": "Last update date", "format": "date-time", "type": "string" } }, "required": [ "id", "auth_flow", "status", "created_at", "updated_at" ], "type": "object" }, "AuthorizeClientTokenRequestBody": { "additionalProperties": false, "properties": { "application_compat_client_id": { "description": "Application Compat Client ID", "format": "uuid", "type": "string" }, "application_id": { "description": "Application ID", "format": "int64", "type": "integer" }, "application_user_id": { "description": "Application User ID", "type": "string" }, "expire_at": { "description": "Expiration Time as unix timestamp", "format": "int64", "type": [ "integer", "null" ] }, "signature": { "description": "Client token derived signature", "type": "string" } }, "required": [ "signature", "application_user_id" ], "type": "object" }, "AuthorizeHmacRequestBody": { "additionalProperties": false, "properties": { "application_compat_client_id": { "description": "Application Compat Client ID", "format": "uuid", "type": "string" }, "application_id": { "description": "Application ID", "format": "int64", "type": "integer" }, "application_user_id": { "description": "Application User ID", "type": "string" }, "expire_at": { "description": "Expiration Time as unix timestamp", "format": "int64", "type": [ "integer", "null" ] }, "signature": { "description": "HMAC signature", "type": "string" }, "uts": { "description": "Unix Timestamp", "format": "int64", "type": "integer" } }, "required": [ "signature", "application_user_id" ], "type": "object" }, "AuthorizePKCS1RequestBody": { "additionalProperties": false, "properties": { "application_compat_client_id": { "description": "Application Compat Client ID", "format": "uuid", "type": "string" }, "application_id": { "description": "Application ID", "format": "int64", "type": "integer" }, "application_user_id": { "description": "Application User ID", "type": "string" }, "hash_type": { "description": "Hash type", "enum": [ "sha1", "sha256", "sha512" ], "type": "string" }, "signature": { "description": "PKCS1 base64 signature", "type": "string" } }, "required": [ "signature", "hash_type", "application_user_id" ], "type": "object" }, "AuthorizeResponseBody": { "additionalProperties": false, "properties": { "access_token": { "description": "Access token", "type": "string" }, "user_info": { "$ref": "#/components/schemas/UserInfo", "description": "User info" } }, "required": [ "access_token", "user_info" ], "type": "object" }, "CompatQueryOutputRecordActivityEntry": { "additionalProperties": false, "properties": { "division_label": { "type": "string" }, "division_ref": { "format": "int64", "type": "integer" }, "duration": { "format": "int64", "type": "integer" }, "end_at": { "format": "date-time", "type": "string" }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "start_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "ContextTimer": { "additionalProperties": false, "type": "object" }, "DatasetApplicationManifest": { "additionalProperties": false, "properties": { "client_cache": { "$ref": "#/components/schemas/DatasetApplicationManifestClientCache", "deprecated": true }, "client_caches": { "additionalProperties": { "$ref": "#/components/schemas/DatasetApplicationManifestClientCache" }, "type": "object" }, "lab_report": { "$ref": "#/components/schemas/DatasetApplicationManifestQueryLabReport" }, "max_backfill_days": { "format": "int32", "type": "integer" }, "nutritional_record": { "$ref": "#/components/schemas/DatasetApplicationManifestQueryNutritionalRecord" }, "sleep": { "$ref": "#/components/schemas/DatasetApplicationManifestQuerySleep" }, "statistics_daily": { "$ref": "#/components/schemas/DatasetApplicationManifestQueryStatisticsDaily" }, "statistics_hourly": { "$ref": "#/components/schemas/DatasetApplicationManifestQueryStatisticsHourly" }, "timeseries": { "$ref": "#/components/schemas/DatasetApplicationManifestQueryTimeseries" }, "version": { "type": "string" }, "workout": { "$ref": "#/components/schemas/DatasetApplicationManifestQueryWorkout" } }, "type": "object" }, "DatasetApplicationManifestClientCache": { "additionalProperties": false, "properties": { "cleanup_interval_seconds": { "examples": [ 86400 ], "format": "int64", "type": "integer" }, "enabled": { "examples": [ true ], "type": "boolean" }, "max_cache_values": { "examples": [ 10000000 ], "format": "int64", "type": "integer" }, "ttl_dateless_entries_seconds": { "examples": [ 2592000 ], "format": "int64", "type": "integer" }, "ttl_seconds": { "examples": [ 2592000 ], "format": "int64", "type": "integer" } }, "required": [ "enabled", "ttl_seconds", "ttl_dateless_entries_seconds", "cleanup_interval_seconds", "max_cache_values" ], "type": "object" }, "DatasetApplicationManifestQueryLabReport": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "store_original_file": { "type": "boolean" } }, "required": [ "enabled", "store_original_file" ], "type": "object" }, "DatasetApplicationManifestQueryNutritionalRecord": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "store_original_file": { "type": "boolean" } }, "required": [ "enabled", "store_original_file" ], "type": "object" }, "DatasetApplicationManifestQuerySleep": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "timeseries_metrics": { "items": { "enum": [ "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" ], "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "DatasetApplicationManifestQueryStatisticsDaily": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "metrics": { "items": { "enum": [ "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" ], "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "DatasetApplicationManifestQueryStatisticsHourly": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "metrics": { "items": { "enum": [ "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" ], "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "DatasetApplicationManifestQueryTimeseries": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "metrics": { "items": { "enum": [ "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" ], "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "DatasetApplicationManifestQueryWorkout": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "include_laps": { "type": "boolean" }, "include_route_points": { "type": "boolean" }, "include_segments": { "type": "boolean" }, "include_splits": { "type": "boolean" }, "timeseries_metrics": { "items": { "enum": [ "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" ], "type": "string" }, "type": "array" } }, "required": [ "enabled", "include_laps", "include_splits", "include_segments", "include_route_points" ], "type": "object" }, "DebugEntry": { "additionalProperties": false, "properties": { "Data": {}, "Message": { "type": "string" }, "Timestamp": { "format": "date-time", "type": "string" } }, "required": [ "Timestamp", "Message", "Data" ], "type": "object" }, "DebugLog": { "additionalProperties": false, "properties": { "Entries": { "items": { "$ref": "#/components/schemas/DebugEntry" }, "type": [ "array", "null" ] } }, "required": [ "Entries" ], "type": "object" }, "ErrorDetail": { "additionalProperties": false, "properties": { "location": { "description": "Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'", "type": "string" }, "message": { "description": "Error message text", "type": "string" }, "value": { "description": "The value at the given location" } }, "type": "object" }, "ErrorModel": { "additionalProperties": false, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "examples": [ "Property foo is required but is missing." ], "type": "string" }, "errors": { "description": "Optional list of individual error details", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": [ "array", "null" ] }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem.", "examples": [ "https://example.com/error-log/abc123" ], "format": "uri", "type": "string" }, "status": { "description": "HTTP status code", "examples": [ 400 ], "format": "int64", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type. This value should not change between occurrences of the error.", "examples": [ "Bad Request" ], "type": "string" }, "type": { "default": "about:blank", "description": "A URI reference to human-readable documentation for the error.", "examples": [ "https://example.com/errors/example" ], "format": "uri", "type": "string" } }, "type": "object" }, "IntegrationInitURLResponseBody": { "additionalProperties": false, "properties": { "path": { "type": "string" }, "provider_slug": { "description": "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" ], "type": "string" } }, "required": [ "provider_slug", "path" ], "type": "object" }, "LabInformation": { "additionalProperties": false, "properties": { "address": { "type": "string" }, "email_address": { "type": "string" }, "name": { "type": "string" }, "notes": { "type": "string" }, "phone_number": { "type": "string" } }, "type": "object" }, "LabReport": { "additionalProperties": false, "properties": { "collection_date": { "type": "string" }, "lab_information": { "$ref": "#/components/schemas/LabInformation" }, "modified_at": { "format": "date-time", "type": "string" }, "notes": { "type": "string" }, "original_record_id": { "type": "string" }, "parsing_error": { "type": "string" }, "patient_information": { "$ref": "#/components/schemas/PatientInformation" }, "record_id": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "result_date": { "type": "string" }, "sections": { "items": { "$ref": "#/components/schemas/LabReportSection" }, "type": [ "array", "null" ] }, "status": { "description": "Lab Report Status", "enum": [ "pending", "processing", "completed", "failed" ], "type": "string" }, "uploaded_at": { "format": "date-time", "type": "string" } }, "required": [ "status", "record_id" ], "type": "object" }, "LabReportSection": { "additionalProperties": false, "properties": { "loinc_code": { "type": "string" }, "loinc_common_name": { "type": "string" }, "original_section_name": { "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/LabReportValue" }, "type": [ "array", "null" ] }, "section_notes": { "type": "string" }, "standard_section_name": { "type": "string" } }, "type": "object" }, "LabReportValue": { "additionalProperties": false, "properties": { "loinc_code": { "type": "string" }, "loinc_common_name": { "type": "string" }, "normal_max": { "format": "double", "type": "number" }, "normal_min": { "format": "double", "type": "number" }, "notes": { "type": "string" }, "original_test_name": { "type": "string" }, "original_unit_name": { "type": "string" }, "require_human_review": { "type": "boolean" }, "standard_test_name": { "type": "string" }, "standard_unit_name": { "type": "string" }, "tested_positive": { "type": "boolean" }, "value": { "format": "double", "type": "number" }, "value_text": { "type": "string" }, "within_normal_range": { "type": "boolean" } }, "required": [ "original_test_name", "original_unit_name", "standard_unit_name", "standard_test_name" ], "type": "object" }, "LabReportsPostInput": { "additionalProperties": false, "properties": { "body": { "description": "raw body in base64", "type": "string" }, "filename": { "description": "filename of the document", "type": "string" }, "wait_on_process": { "description": "wait for the process to complete", "type": "boolean" } }, "required": [ "body", "filename" ], "type": "object" }, "LabReportsPostOutput": { "additionalProperties": false, "properties": { "lab_report": { "$ref": "#/components/schemas/LabReport" } }, "required": [ "lab_report" ], "type": "object" }, "MetricValue": { "additionalProperties": false, "type": "object" }, "NutritionIngredient": { "additionalProperties": false, "properties": { "failure_reason": { "description": "Reason for processing failure", "examples": [ "Unable to identify label" ], "readOnly": true, "type": "string" }, "name": { "description": "Detected ingredient name", "examples": [ "beef and broccoli stir-fry" ], "type": "string" }, "nutritional_fields": { "additionalProperties": false, "description": "Nutritional values in the given serving size", "properties": { "calcium_mg": { "description": "Calcium in milligrams", "examples": [ 1000 ], "type": "number" }, "carbohydrate_g": { "description": "Carbohydrates in grams", "examples": [ 250 ], "type": "number" }, "cholesterol_mg": { "description": "Cholesterol in milligrams", "examples": [ 300 ], "type": "number" }, "energy_kcal": { "description": "Energy in kilocalories", "examples": [ 800 ], "type": "number" }, "fat_monounsaturated_g": { "description": "Monounsaturated Fat in grams", "examples": [ 20 ], "type": "number" }, "fat_polyunsaturated_g": { "description": "Polyunsaturated Fat in grams", "examples": [ 15 ], "type": "number" }, "fat_saturated_g": { "description": "Saturated Fat in grams", "examples": [ 20 ], "type": "number" }, "fat_total_g": { "description": "Total Fat in grams", "examples": [ 65 ], "type": "number" }, "fat_trans_g": { "description": "Trans Fat in grams", "examples": [ 0.5 ], "type": "number" }, "fiber_total_dietary_g": { "description": "Dietary Fiber in grams", "examples": [ 25 ], "type": "number" }, "folate_mcg": { "description": "Folate in micrograms", "examples": [ 400 ], "type": "number" }, "iron_mg": { "description": "Iron in milligrams", "examples": [ 18 ], "type": "number" }, "magnesium_mg": { "description": "Magnesium in milligrams", "examples": [ 400 ], "type": "number" }, "manganese_mcg": { "description": "Manganese in micrograms", "examples": [ 400 ], "type": "number" }, "niacin_mg": { "description": "Niacin in milligrams", "examples": [ 16 ], "type": "number" }, "phosphorus_mg": { "description": "Phosphorus in milligrams", "examples": [ 700 ], "type": "number" }, "potassium_mg": { "description": "Potassium in milligrams", "examples": [ 3500 ], "type": "number" }, "protein_g": { "description": "Protein in grams", "examples": [ 50 ], "type": "number" }, "riboflavin_mg": { "description": "Riboflavin in milligrams", "examples": [ 1.3 ], "type": "number" }, "salt_g": { "description": "Salt in grams", "examples": [ 12 ], "type": "number" }, "salt_mg": { "description": "Salt in milligrams", "examples": [ 25 ], "type": "number" }, "sodium_g": { "description": "Sodium in grams", "examples": [ 56 ], "type": "number" }, "sodium_mg": { "description": "Sodium in milligrams", "examples": [ 2300 ], "type": "number" }, "sugars_total_g": { "description": "Total Sugars in grams", "examples": [ 50 ], "type": "number" }, "thiamin_mg": { "description": "Thiamin in milligrams", "examples": [ 1.2 ], "type": "number" }, "vitamin_a_rae_mcg": { "description": "Vitamin A in micrograms", "examples": [ 900 ], "type": "number" }, "vitamin_b12_mcg": { "description": "Vitamin B12 in micrograms", "examples": [ 2.4 ], "type": "number" }, "vitamin_b6_mg": { "description": "Vitamin B6 in milligrams", "examples": [ 1.7 ], "type": "number" }, "vitamin_c_mg": { "description": "Vitamin C in milligrams", "examples": [ 90 ], "type": "number" }, "vitamin_d_mcg": { "description": "Vitamin D in micrograms", "examples": [ 20 ], "type": "number" }, "vitamin_e_mg": { "description": "Vitamin E in milligrams", "examples": [ 15 ], "type": "number" }, "vitamin_k_mcg": { "description": "Vitamin K in micrograms", "examples": [ 120 ], "type": "number" }, "zinc_mg": { "description": "Zinc in milligrams", "examples": [ 11 ], "type": "number" } }, "type": "object" }, "serving_size": { "description": "Serving size in metric units", "examples": [ 120 ], "format": "double", "minimum": 0.01, "type": "number" }, "status": { "description": "Processing status", "enum": [ "completed", "failed" ], "examples": [ "completed" ], "readOnly": true, "type": "string" }, "unit": { "description": "Metric unit (g for solids, ml for liquids)", "enum": [ "g", "mg", "mcg", "ml", "kcal" ], "examples": [ "g" ], "type": "string" } }, "required": [ "name", "serving_size", "unit" ], "type": "object" }, "NutritionIngredientLabelInput": { "additionalProperties": false, "properties": { "analysis_mode": { "default": "precise", "description": "A preferred mode for the analysis", "enum": [ "fast", "precise" ], "type": "string" }, "body": { "description": "Base64-encoded binary data, this or 'body_url' is required", "type": "string" }, "body_url": { "description": "URL to the image, this or 'body' is required", "type": "string" } }, "type": "object" }, "NutritionRecord": { "additionalProperties": false, "properties": { "consumed_at": { "description": "The UTC time when food was consumed. By default, it is set to the record update time", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" }, "dish_description": { "description": "Detected dish description", "examples": [ "beef, ground, lean, cooked with broccoli, raw and rice, brown, cooked" ], "type": "string" }, "dish_description_translated": { "description": "Dish description translated to target language", "examples": [ "Rindfleisch, Hackfleisch, mager, gekocht mit Brokkoli, roh und Reis, braun, gekocht" ], "type": "string" }, "dish_name": { "description": "Detected dish name", "examples": [ "beef and broccoli stir-fry" ], "type": "string" }, "dish_name_translated": { "description": "Dish name translated to target language", "examples": [ "Rindfleisch und Brokkoli Pfanne" ], "type": "string" }, "failure_reason": { "description": "Reason for processing failure", "examples": [ "Unable to identify food items" ], "readOnly": true, "type": "string" }, "ingredients": { "description": "List of detected ingredients with nutritional information", "items": { "$ref": "#/components/schemas/NutritionRecordIngredient" }, "type": [ "array", "null" ] }, "input_type": { "description": "Nutrition record input type", "enum": [ "image", "manual", "push", "text" ], "examples": [ "image" ], "readOnly": true, "type": "string" }, "modified_at": { "description": "Update timestamp in UTC", "examples": [ "2025-09-15T10:30:12.132Z" ], "format": "date-time", "readOnly": true, "type": "string" }, "nutri_score": { "description": "Nutri-Score known as the 5-Colour Nutrition label (A-E)", "examples": [ "B" ], "type": "string" }, "nutritional_fields": { "additionalProperties": false, "description": "Nutritional values in the given serving size", "properties": { "calcium_mg": { "description": "Calcium in milligrams", "examples": [ 1000 ], "type": "number" }, "carbohydrate_g": { "description": "Carbohydrates in grams", "examples": [ 250 ], "type": "number" }, "cholesterol_mg": { "description": "Cholesterol in milligrams", "examples": [ 300 ], "type": "number" }, "energy_kcal": { "description": "Energy in kilocalories", "examples": [ 800 ], "type": "number" }, "fat_monounsaturated_g": { "description": "Monounsaturated Fat in grams", "examples": [ 20 ], "type": "number" }, "fat_polyunsaturated_g": { "description": "Polyunsaturated Fat in grams", "examples": [ 15 ], "type": "number" }, "fat_saturated_g": { "description": "Saturated Fat in grams", "examples": [ 20 ], "type": "number" }, "fat_total_g": { "description": "Total Fat in grams", "examples": [ 65 ], "type": "number" }, "fat_trans_g": { "description": "Trans Fat in grams", "examples": [ 0.5 ], "type": "number" }, "fiber_total_dietary_g": { "description": "Dietary Fiber in grams", "examples": [ 25 ], "type": "number" }, "folate_mcg": { "description": "Folate in micrograms", "examples": [ 400 ], "type": "number" }, "iron_mg": { "description": "Iron in milligrams", "examples": [ 18 ], "type": "number" }, "magnesium_mg": { "description": "Magnesium in milligrams", "examples": [ 400 ], "type": "number" }, "manganese_mcg": { "description": "Manganese in micrograms", "examples": [ 400 ], "type": "number" }, "niacin_mg": { "description": "Niacin in milligrams", "examples": [ 16 ], "type": "number" }, "phosphorus_mg": { "description": "Phosphorus in milligrams", "examples": [ 700 ], "type": "number" }, "potassium_mg": { "description": "Potassium in milligrams", "examples": [ 3500 ], "type": "number" }, "protein_g": { "description": "Protein in grams", "examples": [ 50 ], "type": "number" }, "riboflavin_mg": { "description": "Riboflavin in milligrams", "examples": [ 1.3 ], "type": "number" }, "salt_g": { "description": "Salt in grams", "examples": [ 12 ], "type": "number" }, "salt_mg": { "description": "Salt in milligrams", "examples": [ 25 ], "type": "number" }, "sodium_g": { "description": "Sodium in grams", "examples": [ 56 ], "type": "number" }, "sodium_mg": { "description": "Sodium in milligrams", "examples": [ 2300 ], "type": "number" }, "sugars_total_g": { "description": "Total Sugars in grams", "examples": [ 50 ], "type": "number" }, "thiamin_mg": { "description": "Thiamin in milligrams", "examples": [ 1.2 ], "type": "number" }, "vitamin_a_rae_mcg": { "description": "Vitamin A in micrograms", "examples": [ 900 ], "type": "number" }, "vitamin_b12_mcg": { "description": "Vitamin B12 in micrograms", "examples": [ 2.4 ], "type": "number" }, "vitamin_b6_mg": { "description": "Vitamin B6 in milligrams", "examples": [ 1.7 ], "type": "number" }, "vitamin_c_mg": { "description": "Vitamin C in milligrams", "examples": [ 90 ], "type": "number" }, "vitamin_d_mcg": { "description": "Vitamin D in micrograms", "examples": [ 20 ], "type": "number" }, "vitamin_e_mg": { "description": "Vitamin E in milligrams", "examples": [ 15 ], "type": "number" }, "vitamin_k_mcg": { "description": "Vitamin K in micrograms", "examples": [ 120 ], "type": "number" }, "zinc_mg": { "description": "Zinc in milligrams", "examples": [ 11 ], "type": "number" } }, "type": "object" }, "record_id": { "description": "Report record ID", "examples": [ "6ba7b810-9dad-11d1-80b4-00c04fd430c8" ], "format": "uuid", "readOnly": true, "type": "string" }, "serving_size": { "description": "Serving size in metric units", "examples": [ 120 ], "format": "double", "minimum": 0.01, "type": "number" }, "status": { "description": "Processing status", "enum": [ "pending", "processing", "completed", "failed", "updated" ], "examples": [ "completed" ], "readOnly": true, "type": "string" }, "unit": { "description": "Metric unit (g for solids, ml for liquids)", "enum": [ "g", "mg", "mcg", "ml", "kcal" ], "examples": [ "g" ], "type": "string" }, "uploaded_at": { "description": "Upload timestamp in UTC", "examples": [ "2025-09-15T10:30:04.521Z" ], "format": "date-time", "readOnly": true, "type": "string" }, "user_time_offset_minutes": { "description": "User's local timezone offset in minutes", "examples": [ -540 ], "format": "int32", "type": "integer" } }, "required": [ "dish_name", "serving_size", "unit" ], "type": "object" }, "NutritionRecordIngredient": { "additionalProperties": false, "properties": { "name": { "description": "Ingredient name using LANGUAL standard terminology", "examples": [ "beef, ground, lean, cooked" ], "type": "string" }, "name_translated": { "description": "Ingredient name translated to target language", "examples": [ "Rindfleisch, Hackfleisch, mager, gekocht" ], "type": "string" }, "nutritional_fields": { "additionalProperties": false, "description": "Nutritional values in the given serving size", "properties": { "calcium_mg": { "description": "Calcium in milligrams", "examples": [ 1000 ], "type": "number" }, "carbohydrate_g": { "description": "Carbohydrates in grams", "examples": [ 250 ], "type": "number" }, "cholesterol_mg": { "description": "Cholesterol in milligrams", "examples": [ 300 ], "type": "number" }, "energy_kcal": { "description": "Energy in kilocalories", "examples": [ 800 ], "type": "number" }, "fat_monounsaturated_g": { "description": "Monounsaturated Fat in grams", "examples": [ 20 ], "type": "number" }, "fat_polyunsaturated_g": { "description": "Polyunsaturated Fat in grams", "examples": [ 15 ], "type": "number" }, "fat_saturated_g": { "description": "Saturated Fat in grams", "examples": [ 20 ], "type": "number" }, "fat_total_g": { "description": "Total Fat in grams", "examples": [ 65 ], "type": "number" }, "fat_trans_g": { "description": "Trans Fat in grams", "examples": [ 0.5 ], "type": "number" }, "fiber_total_dietary_g": { "description": "Dietary Fiber in grams", "examples": [ 25 ], "type": "number" }, "folate_mcg": { "description": "Folate in micrograms", "examples": [ 400 ], "type": "number" }, "iron_mg": { "description": "Iron in milligrams", "examples": [ 18 ], "type": "number" }, "magnesium_mg": { "description": "Magnesium in milligrams", "examples": [ 400 ], "type": "number" }, "manganese_mcg": { "description": "Manganese in micrograms", "examples": [ 400 ], "type": "number" }, "niacin_mg": { "description": "Niacin in milligrams", "examples": [ 16 ], "type": "number" }, "phosphorus_mg": { "description": "Phosphorus in milligrams", "examples": [ 700 ], "type": "number" }, "potassium_mg": { "description": "Potassium in milligrams", "examples": [ 3500 ], "type": "number" }, "protein_g": { "description": "Protein in grams", "examples": [ 50 ], "type": "number" }, "riboflavin_mg": { "description": "Riboflavin in milligrams", "examples": [ 1.3 ], "type": "number" }, "salt_g": { "description": "Salt in grams", "examples": [ 12 ], "type": "number" }, "salt_mg": { "description": "Salt in milligrams", "examples": [ 25 ], "type": "number" }, "sodium_g": { "description": "Sodium in grams", "examples": [ 56 ], "type": "number" }, "sodium_mg": { "description": "Sodium in milligrams", "examples": [ 2300 ], "type": "number" }, "sugars_total_g": { "description": "Total Sugars in grams", "examples": [ 50 ], "type": "number" }, "thiamin_mg": { "description": "Thiamin in milligrams", "examples": [ 1.2 ], "type": "number" }, "vitamin_a_rae_mcg": { "description": "Vitamin A in micrograms", "examples": [ 900 ], "type": "number" }, "vitamin_b12_mcg": { "description": "Vitamin B12 in micrograms", "examples": [ 2.4 ], "type": "number" }, "vitamin_b6_mg": { "description": "Vitamin B6 in milligrams", "examples": [ 1.7 ], "type": "number" }, "vitamin_c_mg": { "description": "Vitamin C in milligrams", "examples": [ 90 ], "type": "number" }, "vitamin_d_mcg": { "description": "Vitamin D in micrograms", "examples": [ 20 ], "type": "number" }, "vitamin_e_mg": { "description": "Vitamin E in milligrams", "examples": [ 15 ], "type": "number" }, "vitamin_k_mcg": { "description": "Vitamin K in micrograms", "examples": [ 120 ], "type": "number" }, "zinc_mg": { "description": "Zinc in milligrams", "examples": [ 11 ], "type": "number" } }, "type": "object" }, "serving_size": { "description": "Serving size in metric units", "examples": [ 120 ], "format": "double", "type": "number" }, "unit": { "description": "Metric unit (g for solids, ml for liquids)", "enum": [ "g", "mg", "mcg", "ml", "kcal" ], "examples": [ "g" ], "type": "string" } }, "required": [ "name", "serving_size", "unit" ], "type": "object" }, "NutritionRecordPatchRequestBody": { "additionalProperties": false, "properties": { "consumed_at": { "description": "The UTC time when food was consumed", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" }, "serving_size": { "description": "Serving size in metric units", "examples": [ 120 ], "format": "double", "type": "number" } }, "type": "object" }, "NutritionRecordTextUploadInput": { "additionalProperties": false, "properties": { "analysis_mode": { "default": "precise", "description": "A preferred mode for the analysis", "enum": [ "fast", "precise" ], "type": "string" }, "consumed": { "default": true, "description": "Whether to save the record (true) or only analyze (false)", "type": "boolean" }, "consumed_at": { "description": "The UTC time when food was consumed. By default, it is set to the upload time", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" }, "country_code": { "default": "us", "description": "Country ISO 3166-1 alpha-2 code in lowercase", "enum": [ "af", "al", "dz", "ad", "ao", "ag", "ar", "am", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bt", "bo", "ba", "bw", "br", "bn", "bg", "bf", "bi", "cv", "kh", "cm", "ca", "cf", "td", "cl", "cn", "co", "km", "cg", "cd", "cr", "ci", "hr", "cu", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "sz", "et", "fj", "fi", "fr", "ga", "gm", "ge", "de", "gh", "gr", "gd", "gt", "gn", "gw", "gy", "ht", "hn", "hu", "is", "in", "id", "ir", "iq", "ie", "il", "it", "jm", "jp", "jo", "kz", "ke", "ki", "kp", "kr", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mr", "mu", "mx", "fm", "md", "mc", "mn", "me", "ma", "mz", "mm", "na", "nr", "np", "nl", "nz", "ni", "ne", "ng", "mk", "no", "om", "pk", "pw", "pa", "pg", "py", "pe", "ph", "pl", "pt", "qa", "ro", "ru", "rw", "kn", "lc", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sk", "si", "sb", "so", "za", "ss", "es", "lk", "sd", "sr", "se", "ch", "sy", "tj", "tz", "th", "tl", "tg", "to", "tt", "tn", "tr", "tm", "tv", "ug", "ua", "ae", "gb", "us", "uy", "uz", "vu", "ve", "vn", "ye", "zm", "zw" ], "type": "string" }, "include_dish_description": { "default": false, "description": "Include dish description of the food", "examples": [ true ], "type": "boolean" }, "include_ingredients": { "default": false, "description": "Include ingredients of the food", "examples": [ true ], "type": "boolean" }, "include_nutri_score": { "default": false, "description": "Include nutri-score label of the food", "type": "boolean" }, "include_nutrition_fields": { "default": [ "carbohydrate_g", "energy_kcal", "fat_total_g", "protein_g" ], "description": "Include specific nutrition fields in the analysis report. By default, carbohydrate_g, energy_kcal, fat_total_g and protein_g will be included", "items": { "enum": [ "energy_kcal", "carbohydrate_g", "protein_g", "fat_total_g", "fat_saturated_g", "fat_polyunsaturated_g", "fat_monounsaturated_g", "fat_trans_g", "fiber_total_dietary_g", "sugars_total_g", "cholesterol_mg", "sodium_mg", "potassium_mg", "calcium_mg", "iron_mg", "magnesium_mg", "phosphorus_mg", "zinc_mg", "vitamin_a_rae_mcg", "vitamin_c_mg", "vitamin_d_mcg", "vitamin_e_mg", "vitamin_k_mcg", "thiamin_mg", "riboflavin_mg", "niacin_mg", "vitamin_b6_mg", "folate_mcg", "vitamin_b12_mcg", "sodium_g", "salt_mg", "salt_g", "manganese_mcg" ], "type": "string" }, "type": "array" }, "language_code": { "default": "en", "description": "Language ISO 639-1 code in lowercase", "enum": [ "aa", "ab", "ae", "af", "ak", "am", "an", "ar", "as", "av", "ay", "az", "ba", "be", "bg", "bh", "bi", "bm", "bn", "bo", "br", "bs", "ca", "ce", "ch", "co", "cr", "cs", "cu", "cv", "cy", "da", "de", "dv", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fj", "fo", "fr", "fy", "ga", "gd", "gl", "gn", "gu", "gv", "ha", "he", "hi", "ho", "hr", "ht", "hu", "hy", "hz", "ia", "id", "ie", "ig", "ii", "ik", "io", "is", "it", "iu", "ja", "jv", "ka", "kg", "ki", "kj", "kk", "kl", "km", "kn", "ko", "kr", "ks", "ku", "kv", "kw", "ky", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "mg", "mh", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "na", "nb", "nd", "ne", "ng", "nl", "nn", "no", "nr", "nv", "ny", "oc", "oj", "om", "or", "os", "pa", "pi", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "ss", "st", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "wo", "xh", "yi", "yo", "za", "zh", "zu" ], "examples": [ "de" ], "type": "string" }, "meal_description": { "description": "Text description of the meal to analyze", "examples": [ "grilled chicken breast with rice and steamed broccoli" ], "maxLength": 2000, "minLength": 3, "type": "string" }, "user_time_offset_minutes": { "default": 0, "description": "User's local timezone offset in minutes", "examples": [ -540 ], "format": "int32", "type": "integer" }, "wait_on_process": { "default": false, "description": "If true, waits for the process to complete. If false, returns immediate response and sends notification with analysis report to webhook URL when finished", "type": "boolean" } }, "required": [ "meal_description" ], "type": "object" }, "NutritionRecordUploadInput": { "additionalProperties": false, "properties": { "analysis_mode": { "default": "precise", "description": "A preferred mode for the analysis", "enum": [ "fast", "precise" ], "type": "string" }, "body": { "description": "Base64-encoded binary data, this or 'body_url' is required", "type": "string" }, "body_url": { "description": "URL to the image, this or 'body' is required", "type": "string" }, "consumed": { "default": true, "description": "Whether to save the record (true) or only analyze (false)", "type": "boolean" }, "consumed_at": { "description": "The UTC time when food was consumed. By default, it is set to the upload time", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" }, "country_code": { "default": "us", "description": "Country ISO 3166-1 alpha-2 code in lowercase", "enum": [ "af", "al", "dz", "ad", "ao", "ag", "ar", "am", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bt", "bo", "ba", "bw", "br", "bn", "bg", "bf", "bi", "cv", "kh", "cm", "ca", "cf", "td", "cl", "cn", "co", "km", "cg", "cd", "cr", "ci", "hr", "cu", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "sz", "et", "fj", "fi", "fr", "ga", "gm", "ge", "de", "gh", "gr", "gd", "gt", "gn", "gw", "gy", "ht", "hn", "hu", "is", "in", "id", "ir", "iq", "ie", "il", "it", "jm", "jp", "jo", "kz", "ke", "ki", "kp", "kr", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mr", "mu", "mx", "fm", "md", "mc", "mn", "me", "ma", "mz", "mm", "na", "nr", "np", "nl", "nz", "ni", "ne", "ng", "mk", "no", "om", "pk", "pw", "pa", "pg", "py", "pe", "ph", "pl", "pt", "qa", "ro", "ru", "rw", "kn", "lc", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sk", "si", "sb", "so", "za", "ss", "es", "lk", "sd", "sr", "se", "ch", "sy", "tj", "tz", "th", "tl", "tg", "to", "tt", "tn", "tr", "tm", "tv", "ug", "ua", "ae", "gb", "us", "uy", "uz", "vu", "ve", "vn", "ye", "zm", "zw" ], "type": "string" }, "include_dish_description": { "default": false, "description": "Include dish description of the food", "examples": [ true ], "type": "boolean" }, "include_ingredients": { "default": false, "description": "Include ingredients of the food", "examples": [ true ], "type": "boolean" }, "include_nutri_score": { "default": false, "description": "Include nutri-score label of the food", "type": "boolean" }, "include_nutrition_fields": { "default": [ "carbohydrate_g", "energy_kcal", "fat_total_g", "protein_g" ], "description": "Include specific nutrition fields in the analysis report. By default, carbohydrate_g, energy_kcal, fat_total_g and protein_g will be included", "items": { "enum": [ "energy_kcal", "carbohydrate_g", "protein_g", "fat_total_g", "fat_saturated_g", "fat_polyunsaturated_g", "fat_monounsaturated_g", "fat_trans_g", "fiber_total_dietary_g", "sugars_total_g", "cholesterol_mg", "sodium_mg", "potassium_mg", "calcium_mg", "iron_mg", "magnesium_mg", "phosphorus_mg", "zinc_mg", "vitamin_a_rae_mcg", "vitamin_c_mg", "vitamin_d_mcg", "vitamin_e_mg", "vitamin_k_mcg", "thiamin_mg", "riboflavin_mg", "niacin_mg", "vitamin_b6_mg", "folate_mcg", "vitamin_b12_mcg", "sodium_g", "salt_mg", "salt_g", "manganese_mcg" ], "type": "string" }, "type": "array" }, "language_code": { "default": "en", "description": "Language ISO 639-1 code in lowercase", "enum": [ "aa", "ab", "ae", "af", "ak", "am", "an", "ar", "as", "av", "ay", "az", "ba", "be", "bg", "bh", "bi", "bm", "bn", "bo", "br", "bs", "ca", "ce", "ch", "co", "cr", "cs", "cu", "cv", "cy", "da", "de", "dv", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fj", "fo", "fr", "fy", "ga", "gd", "gl", "gn", "gu", "gv", "ha", "he", "hi", "ho", "hr", "ht", "hu", "hy", "hz", "ia", "id", "ie", "ig", "ii", "ik", "io", "is", "it", "iu", "ja", "jv", "ka", "kg", "ki", "kj", "kk", "kl", "km", "kn", "ko", "kr", "ks", "ku", "kv", "kw", "ky", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "mg", "mh", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "na", "nb", "nd", "ne", "ng", "nl", "nn", "no", "nr", "nv", "ny", "oc", "oj", "om", "or", "os", "pa", "pi", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "ss", "st", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "wo", "xh", "yi", "yo", "za", "zh", "zu" ], "examples": [ "de" ], "type": "string" }, "user_time_offset_minutes": { "default": 0, "description": "User's local timezone offset in minutes", "examples": [ -540 ], "format": "int32", "type": "integer" }, "wait_on_process": { "default": false, "description": "If true, waits for the process to complete. If false, returns immediate response and sends notification with analysis report to webhook URL when finished", "type": "boolean" } }, "type": "object" }, "OutputDecimal": { "additionalProperties": false, "type": "object" }, "PatientInformation": { "additionalProperties": false, "properties": { "address": { "type": "string" }, "age": { "format": "int32", "minimum": 0, "type": "integer" }, "date_of_birth": { "type": "string" }, "email_address": { "type": "string" }, "gender": { "type": "string" }, "name": { "type": "string" }, "notes": { "type": "string" }, "patient_id": { "type": "string" }, "phone_number": { "type": "string" } }, "type": "object" }, "ProviderRecord": { "additionalProperties": false, "properties": { "RecordSource": { "format": "int64", "type": "integer" }, "activity_divisions": { "items": { "$ref": "#/components/schemas/ActivityDivision" }, "type": [ "array", "null" ] }, "activity_entries": { "items": { "$ref": "#/components/schemas/ActivityEntry" }, "type": [ "array", "null" ] }, "activity_id": { "contentEncoding": "base64", "type": "string" }, "activity_name": { "type": "string" }, "activity_type_id": { "format": "int32", "minimum": 0, "type": "integer" }, "application_id": { "format": "int64", "type": "integer" }, "data_input_method": { "format": "int32", "minimum": 0, "type": "integer" }, "duration": { "format": "int64", "type": "integer" }, "expire_at": { "format": "date-time", "type": "string" }, "is_source_aggregated": { "type": "boolean" }, "metric_values": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" }, "metrics": { "additionalProperties": { "type": "string" }, "type": "object" }, "modified_at": { "format": "date-time", "type": "string" }, "provider_local_date": { "format": "date-time", "type": "string" }, "provider_source_id": { "format": "int32", "minimum": 0, "type": "integer" }, "record_id": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "record_metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "source_info": { "additionalProperties": { "type": "string" }, "type": "object" }, "start_at": { "format": "date-time", "type": "string" }, "timezone_ambiguous": { "type": "boolean" }, "uid": { "description": "Unique identifier for a user.", "examples": [ "a12b34cd-a1b2-c3d4-e5f6-abcdef123456" ], "format": "uuid", "type": "string" }, "user_time_offset_minutes": { "format": "int32", "type": "integer" } }, "required": [ "source_info", "start_at", "metric_values", "metrics", "activity_divisions", "activity_entries", "modified_at", "record_metadata", "RecordSource" ], "type": "object" }, "QueryInput": { "additionalProperties": false, "properties": { "activity_tags": { "items": { "description": "Activity tags", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "activity_type": { "items": { "description": "Activity types", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "calender_date": { "description": "The date of the query without timezone", "examples": [ "2021-01-01" ], "type": "string" }, "exclude_activity_tags": { "items": { "description": "Activity tags", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "exclude_activity_type": { "items": { "description": "Activity types", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "exclude_provider": { "items": { "description": "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" ], "type": "string" }, "type": [ "array", "null" ] }, "exclude_provider_source": { "items": { "description": "Provider sources", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "from": { "description": "The start time of the query without timezone", "examples": [ "2021-01-01T00:00:00" ], "type": "string" }, "input_method": { "items": { "description": "Input Methods", "enum": [ "unknown", "manual", "device" ], "type": "string" }, "type": [ "array", "null" ] }, "provider": { "items": { "description": "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" ], "type": "string" }, "type": [ "array", "null" ] }, "provider_source": { "items": { "description": "Provider sources", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "query_flags": { "items": { "description": "Query flags to change query behavior", "enum": [ "require_device_only", "require_manual_only", "prefer_device_only", "activities_only", "summaries_only", "include_sessions", "include_sample_metrics", "include_lap_metrics", "include_split_metrics", "include_segment_metrics", "include_route_metrics", "include_sleep_metrics" ], "type": "string" }, "type": [ "array", "null" ] }, "records": { "$ref": "#/components/schemas/QueryRecordInput" }, "statistics": { "items": { "$ref": "#/components/schemas/QueryStatisticInput" }, "type": [ "array", "null" ] }, "timezone": { "default": "UTC", "description": "The timezone to use for responses, it would convert the internal timestamp from UTC to this timezone", "examples": [ "America/New_York" ], "type": "string" }, "to": { "description": "The end time of the query without timezone", "examples": [ "2021-01-02T00:00:00" ], "type": "string" } }, "required": [ "from", "to", "timezone" ], "type": "object" }, "QueryOutput": { "additionalProperties": false, "properties": { "activities": { "items": { "$ref": "#/components/schemas/QueryOutputRecordRow" }, "type": [ "array", "null" ] }, "from": { "format": "date-time", "type": "string" }, "query_at": { "format": "date-time", "type": "string" }, "records": { "items": { "$ref": "#/components/schemas/QueryOutputRecordRow" }, "type": [ "array", "null" ] }, "statistics": { "items": { "$ref": "#/components/schemas/QueryOutputStatisticRow" }, "type": [ "array", "null" ] }, "timezone": { "type": "string" }, "to": { "format": "date-time", "type": "string" }, "uid": { "description": "Unique identifier for a user.", "examples": [ "a12b34cd-a1b2-c3d4-e5f6-abcdef123456" ], "format": "uuid", "type": "string" } }, "required": [ "query_at", "uid", "from", "to", "timezone" ], "type": "object" }, "QueryOutputActivityEntrySamples": { "additionalProperties": false, "properties": { "durations": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "offsets": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "values": { "properties": { "air_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "air_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "air_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ascent": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "bedtime_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_bone_mass": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_mass_index": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned_active": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned_basal": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_intake": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "descent": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_cycling": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_running": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_swimming": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_walking": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_wheelchair": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_active": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_high_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_low_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_moderate_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ecg_rri": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ecg_voltage": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_gain": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_loss": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "floors_climbed": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "glucose": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone0_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone1_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone2_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone3_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone4_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone5_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "height": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "hrv_rmssd": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "hrv_sdnn": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "latitude": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "longitude": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "pace": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "power": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "power_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_awake": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_deep": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_light": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_nap": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_rem": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_efficiency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_interruptions": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_latency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_score": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_skin_temperature_deviation": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "steps": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "swimming_distance_per_stroke": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "swimming_lengths": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "vo2max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "wakeup_latency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "weight": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" } }, "type": "object" } }, "type": "object" }, "QueryOutputActivitySleepSamples": { "additionalProperties": false, "properties": { "durations": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "offsets": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "values": { "properties": { "air_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "air_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "air_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ascent": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "bedtime_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_bone_mass": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_mass_index": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned_active": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned_basal": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_intake": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "descent": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_cycling": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_running": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_swimming": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_walking": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_wheelchair": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_active": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_high_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_low_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_moderate_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ecg_rri": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ecg_voltage": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_gain": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_loss": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "floors_climbed": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "glucose": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone0_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone1_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone2_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone3_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone4_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone5_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "height": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "hrv_rmssd": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "hrv_sdnn": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "latitude": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "longitude": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "pace": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "power": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "power_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_awake": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_deep": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_light": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_nap": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_rem": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_efficiency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_interruptions": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_latency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_score": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_skin_temperature_deviation": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "steps": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "swimming_distance_per_stroke": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "swimming_lengths": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "vo2max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "wakeup_latency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "weight": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" } }, "type": "object" } }, "type": "object" }, "QueryOutputDebug": { "additionalProperties": false, "properties": { "input": { "$ref": "#/components/schemas/QueryInput" }, "original_records": { "items": { "$ref": "#/components/schemas/ProviderRecord" }, "type": [ "array", "null" ] }, "timer": { "$ref": "#/components/schemas/ContextTimer" } }, "required": [ "input" ], "type": "object" }, "QueryOutputDebugInfo": { "additionalProperties": false, "type": "object" }, "QueryOutputProviderSpecificMetrics": { "additionalProperties": false, "properties": { "garmin": { "$ref": "#/components/schemas/QueryOutputProviderSpecificMetricsGarmin" }, "huawei": { "$ref": "#/components/schemas/QueryOutputProviderSpecificMetricsHuawei" }, "oura": { "$ref": "#/components/schemas/QueryOutputProviderSpecificMetricsOura" }, "polar": { "$ref": "#/components/schemas/QueryOutputProviderSpecificMetricsPolar" }, "suunto": { "$ref": "#/components/schemas/QueryOutputProviderSpecificMetricsSuunto" }, "whoop": { "$ref": "#/components/schemas/QueryOutputProviderSpecificMetricsWhoop" }, "withings": { "$ref": "#/components/schemas/QueryOutputProviderSpecificMetricsWithings" } }, "type": "object" }, "QueryOutputProviderSpecificMetricsGarmin": { "additionalProperties": false, "properties": { "overall_sleep_score_qualifier_key": { "type": "string" }, "overall_sleep_score_value": { "format": "int64", "type": "integer" }, "time_offset_stress_level_values": { "type": "string" } }, "type": "object" }, "QueryOutputProviderSpecificMetricsHuawei": { "additionalProperties": false, "properties": { "sleep_score": { "format": "int64", "type": "integer" } }, "type": "object" }, "QueryOutputProviderSpecificMetricsOura": { "additionalProperties": false, "properties": { "readiness_score": { "format": "int64", "type": "integer" }, "sleep_score": { "format": "int64", "type": "integer" } }, "type": "object" }, "QueryOutputProviderSpecificMetricsPolar": { "additionalProperties": false, "properties": { "sleep_score": { "format": "int64", "type": "integer" } }, "type": "object" }, "QueryOutputProviderSpecificMetricsSuunto": { "additionalProperties": false, "properties": { "sleep_quality_score": { "format": "int64", "type": "integer" } }, "type": "object" }, "QueryOutputProviderSpecificMetricsWhoop": { "additionalProperties": false, "properties": { "recovery_score": { "format": "float", "type": "number" }, "sleep_consistency_percentage": { "format": "float", "type": "number" }, "sleep_performance_percentage": { "format": "float", "type": "number" }, "strain": { "format": "float", "type": "number" } }, "type": "object" }, "QueryOutputProviderSpecificMetricsWithings": { "additionalProperties": false, "properties": { "sleep_score": { "format": "int64", "type": "integer" } }, "type": "object" }, "QueryOutputRecord": { "additionalProperties": false, "properties": { "activity_id": { "contentEncoding": "base64", "type": "string" }, "activity_tags": { "items": { "description": "Activity tags", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "activity_type": { "description": "Activity types", "enum": [ "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" ], "type": "string" }, "duration": { "description": "Record duration", "format": "int64", "type": "integer" }, "end_at_timestamp": { "description": "Record end time", "format": "date-time", "type": "string" }, "input_method": { "description": "Data input method", "enum": [ "unknown", "manual", "device" ], "type": "string" }, "is_source_aggregated": { "description": "If the record is already aggregated by the source, for example Apple Health aggregating steps from multiple devices", "type": "boolean" }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "modified_at": { "description": "Modified at", "format": "date-time", "type": "string" }, "provider_local_date": { "description": "Provider local date", "examples": [ "2006-01-02" ], "format": "date" }, "provider_slug": { "description": "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" ], "type": "string" }, "provider_source": { "description": "Source of the record according to the provider", "enum": [ "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" ], "type": "string" }, "provider_source_type": { "description": "Provider source types", "enum": [ "provider_summary", "intraday_aggregation", "activity_summary", "activity_file", "activity", "sample", "profile" ], "type": "string" }, "provider_specific_metrics": { "$ref": "#/components/schemas/QueryOutputProviderSpecificMetrics" }, "record_id": { "description": "Record ID", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "samples": { "$ref": "#/components/schemas/QueryOutputActivityEntrySamples" }, "source": { "$ref": "#/components/schemas/QueryOutputSourceInfo" }, "start_at_timestamp": { "description": "Record start time", "format": "date-time", "type": "string" }, "user_time_offset_minutes": { "description": "User time offset in minutes", "format": "int32", "type": "integer" } }, "required": [ "record_id", "modified_at", "start_at_timestamp" ], "type": "object" }, "QueryOutputRecordRow": { "additionalProperties": false, "properties": { "activity_tags": { "items": { "description": "Activity tags", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "activity_type": { "description": "Activity types", "enum": [ "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" ], "type": "string" }, "duration": { "format": "int64", "type": "integer" }, "end_at": { "format": "date-time", "type": "string" }, "expire_at": { "format": "date-time", "type": "string" }, "input_method": { "description": "Input Methods", "enum": [ "unknown", "manual", "device" ], "type": "string" }, "is_source_aggregated": { "type": "boolean" }, "laps": { "items": { "$ref": "#/components/schemas/CompatQueryOutputRecordActivityEntry" }, "type": [ "array", "null" ] }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "modified_at": { "format": "date-time", "type": "string" }, "provider_slug": { "description": "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" ], "type": "string" }, "provider_source": { "description": "Provider sources", "enum": [ "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" ], "type": "string" }, "record_id": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "route_points": { "items": { "$ref": "#/components/schemas/CompatQueryOutputRecordActivityEntry" }, "type": [ "array", "null" ] }, "samples": { "items": { "$ref": "#/components/schemas/CompatQueryOutputRecordActivityEntry" }, "type": [ "array", "null" ] }, "segments": { "items": { "$ref": "#/components/schemas/CompatQueryOutputRecordActivityEntry" }, "type": [ "array", "null" ] }, "sessions": { "items": { "$ref": "#/components/schemas/CompatQueryOutputRecordActivityEntry" }, "type": [ "array", "null" ] }, "sleep": { "items": { "$ref": "#/components/schemas/CompatQueryOutputRecordActivityEntry" }, "type": [ "array", "null" ] }, "sleep_score": { "format": "int64", "type": "integer" }, "source": { "$ref": "#/components/schemas/QueryOutputRecordSource" }, "splits": { "items": { "$ref": "#/components/schemas/CompatQueryOutputRecordActivityEntry" }, "type": [ "array", "null" ] }, "start_at": { "format": "date-time", "type": "string" }, "user_time_offset_minutes": { "format": "int32", "type": "integer" } }, "required": [ "modified_at", "start_at", "record_id" ], "type": "object" }, "QueryOutputRecordSource": { "additionalProperties": false, "properties": { "device_manufacturer": { "type": "string" }, "device_model": { "type": "string" }, "device_product": { "type": "string" }, "device_version": { "type": "string" }, "source_bundle_identifier": { "type": "string" }, "source_os_version": { "type": "string" }, "source_product": { "type": "string" }, "source_version": { "type": "string" } }, "type": "object" }, "QueryOutputSleep": { "additionalProperties": false, "properties": { "duration": { "description": "Record duration", "format": "int64", "type": "integer" }, "end_at_timestamp": { "description": "Record end time", "format": "date-time", "type": "string" }, "input_method": { "description": "Data input method", "enum": [ "unknown", "manual", "device" ], "type": "string" }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "modified_at": { "description": "Modified at", "format": "date-time", "type": "string" }, "provider_slug": { "description": "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" ], "type": "string" }, "record_ids": { "items": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "samples": { "$ref": "#/components/schemas/QueryOutputActivitySleepSamples" }, "score": { "format": "int64", "type": "integer" }, "sleep_date": { "description": "Calendar date for which the sleep is attributed", "examples": [ "2006-01-02" ], "format": "date" }, "sleep_id": { "contentEncoding": "base64", "type": "string" }, "source": { "$ref": "#/components/schemas/QueryOutputSourceInfo" }, "stages": { "items": { "$ref": "#/components/schemas/QueryOutputSleepStage" }, "type": [ "array", "null" ] }, "start_at_timestamp": { "description": "Record start time", "format": "date-time", "type": "string" }, "user_time_offset_minutes": { "description": "User time offset in minutes", "format": "int32", "type": "integer" } }, "required": [ "start_at_timestamp", "modified_at" ], "type": "object" }, "QueryOutputSleepStage": { "additionalProperties": false, "properties": { "duration": { "format": "int64", "type": "integer" }, "end_at": { "format": "date-time", "type": "string" }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "stage": { "description": "Sleep stages", "enum": [ "awake", "sleeping", "out_of_bed", "light", "deep", "rem", "awake_in_bed", "nap", "in_bed", "unknown" ], "type": "string" }, "start_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "QueryOutputSourceInfo": { "additionalProperties": false, "properties": { "device_manufacturer": { "type": "string" }, "device_model": { "type": "string" }, "device_product": { "type": "string" }, "device_version": { "type": "string" }, "source_bundle_identifier": { "type": "string" }, "source_os_version": { "type": "string" }, "source_product": { "type": "string" }, "source_version": { "type": "string" } }, "type": "object" }, "QueryOutputStatisticRow": { "additionalProperties": false, "properties": { "activity_tags": { "items": { "description": "Activity tags", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "activity_types": { "items": { "description": "Activity types", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "interval_duration": { "format": "int64", "type": "integer" }, "interval_end": { "format": "date-time", "type": "string" }, "interval_start": { "format": "date-time", "type": "string" }, "provider_sources": { "items": { "description": "Provider sources", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "providers": { "items": { "description": "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" ], "type": "string" }, "type": [ "array", "null" ] }, "record_ids": { "items": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "row_count": { "format": "int64", "type": "integer" }, "source_coverage": { "$ref": "#/components/schemas/OutputDecimal" }, "statistic_type": { "description": "Types of statistics available, each designed to provide insights into different aspects of data.", "enum": [ "sleep_score", "stress_score", "recovery_score", "activity_score", "steps", "distance_total", "distance_walking", "distance_cycling", "distance_running", "calories_burned_basal", "calories_burned_active", "calories_burned_total", "sleep_duration_total", "heartrate", "heartrate_max", "heartrate_min", "heartrate_resting", "sleep_skin_temperature_deviation", "hrv_rmssd", "hrv_sdnn", "duration_low_intensity", "duration_moderate_intensity", "duration_high_intensity" ], "type": "string" }, "statistic_unit": { "description": "Metric units", "enum": [ "bpm", "meters", "miles", "kcal", "count", "m/sec", "celsius", "fahrenheit", "percentage", "ms", "seconds", "degrees", "sleep_stage", "sec/m", "rpm", "spm", "breaths/min", "g", "lbs", "st", "mmHg", "mL/kg/min", "uV", "mg/dL", "w", "j" ], "type": "string" }, "statistic_value": { "$ref": "#/components/schemas/OutputDecimal" } }, "required": [ "interval_start", "interval_end", "interval_duration", "record_ids" ], "type": "object" }, "QueryRecordInput": { "additionalProperties": false, "properties": { "excluding_metrics": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "include_all_metrics": { "type": "boolean" }, "include_records_without_metrics": { "type": "boolean" }, "metrics": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "QueryStatisticInput": { "additionalProperties": false, "properties": { "interval": { "description": "Interval windows to aggregate data", "enum": [ "fifteen_minute", "thirty_minute", "hour", "day" ], "type": "string" }, "statistic_type": { "description": "Types of statistics available, each designed to provide insights into different aspects of data.", "enum": [ "sleep_score", "stress_score", "recovery_score", "activity_score", "steps", "distance_total", "distance_walking", "distance_cycling", "distance_running", "calories_burned_basal", "calories_burned_active", "calories_burned_total", "sleep_duration_total", "heartrate", "heartrate_max", "heartrate_min", "heartrate_resting", "sleep_skin_temperature_deviation", "hrv_rmssd", "hrv_sdnn", "duration_low_intensity", "duration_moderate_intensity", "duration_high_intensity" ], "type": "string" } }, "required": [ "statistic_type" ], "type": "object" }, "RecordsQueryOutput": { "additionalProperties": false, "properties": { "from_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "records": { "items": { "$ref": "#/components/schemas/QueryOutputRecord" }, "type": [ "array", "null" ] }, "to_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" } }, "required": [ "records" ], "type": "object" }, "SleepsQueryOutput": { "additionalProperties": false, "properties": { "from_date": { "description": "Calendar date in user's local timezone according to the provider", "examples": [ "2006-01-02" ], "format": "date" }, "sleeps": { "items": { "$ref": "#/components/schemas/QueryOutputSleep" }, "type": [ "array", "null" ] }, "to_date": { "description": "Calendar date in user's local timezone according to the provider", "examples": [ "2006-01-02" ], "format": "date" } }, "required": [ "sleeps" ], "type": "object" }, "StatisticsDailyQueryOutput": { "additionalProperties": false, "properties": { "from_date": { "description": "Calendar date in user's local timezone according to the provider", "examples": [ "2006-01-02" ], "format": "date" }, "statistics": { "items": { "$ref": "#/components/schemas/StatisticsDailyQueryOutputValue" }, "type": [ "array", "null" ] }, "to_date": { "description": "Calendar date in user's local timezone according to the provider", "examples": [ "2006-01-02" ], "format": "date" } }, "required": [ "from_date", "to_date", "statistics" ], "type": "object" }, "StatisticsDailyQueryOutputValue": { "additionalProperties": false, "properties": { "date": { "description": "Calendar date in user's local timezone according to the provider", "examples": [ "2006-01-02" ], "format": "date" }, "record_ids": { "items": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "values": { "description": "Statistics values", "properties": { "activity_score": { "description": "activity_score in count", "examples": [ 83 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 1020.0991 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 2000.1242 ], "type": "number" }, "calories_burned_total": { "description": "calories_burned_total in kcal", "examples": [ 3020.2233 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 20091.0022 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 12000.1014 ], "type": "number" }, "distance_total": { "description": "distance_total in meters", "examples": [ 5880.7021 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 1200.7022 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 100 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 120 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 60 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "recovery_score": { "description": "recovery_score in count", "examples": [ 83 ], "type": "number" }, "sleep_duration_total": { "description": "sleep_duration_total in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in count", "examples": [ 70 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 10000 ], "type": "number" }, "stress_score": { "description": "stress_score in count", "examples": [ 70 ], "type": "number" } }, "type": "object" } }, "required": [ "date", "values" ], "type": "object" }, "StatisticsInterpolationQueryOutput": { "additionalProperties": false, "properties": { "from_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "statistics": { "items": { "$ref": "#/components/schemas/StatisticsInterpolationQueryOutputValue" }, "type": [ "array", "null" ] }, "to_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" } }, "required": [ "statistics" ], "type": "object" }, "StatisticsInterpolationQueryOutputValue": { "additionalProperties": false, "properties": { "from_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "record_ids": { "items": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "to_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "values": { "description": "Statistics values", "properties": { "activity_score": { "description": "activity_score in count", "examples": [ 83 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 1020.0991 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 2000.1242 ], "type": "number" }, "calories_burned_total": { "description": "calories_burned_total in kcal", "examples": [ 3020.2233 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 20091.0022 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 12000.1014 ], "type": "number" }, "distance_total": { "description": "distance_total in meters", "examples": [ 5880.7021 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 1200.7022 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 100 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 120 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 60 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "recovery_score": { "description": "recovery_score in count", "examples": [ 83 ], "type": "number" }, "sleep_duration_total": { "description": "sleep_duration_total in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in count", "examples": [ 70 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 10000 ], "type": "number" }, "stress_score": { "description": "stress_score in count", "examples": [ 70 ], "type": "number" } }, "type": "object" } }, "required": [ "values" ], "type": "object" }, "StatisticsIntervalQueryOutput": { "additionalProperties": false, "properties": { "from_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "statistics": { "items": { "$ref": "#/components/schemas/StatisticsIntervalQueryOutputValue" }, "type": [ "array", "null" ] }, "to_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" } }, "required": [ "from_timestamp", "to_timestamp", "statistics" ], "type": "object" }, "StatisticsIntervalQueryOutputValue": { "additionalProperties": false, "properties": { "from_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "record_ids": { "items": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "to_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "values": { "description": "Statistics values", "properties": { "activity_score": { "description": "activity_score in count", "examples": [ 83 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 1020.0991 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 2000.1242 ], "type": "number" }, "calories_burned_total": { "description": "calories_burned_total in kcal", "examples": [ 3020.2233 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 20091.0022 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 12000.1014 ], "type": "number" }, "distance_total": { "description": "distance_total in meters", "examples": [ 5880.7021 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 1200.7022 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 100 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 120 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 60 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "recovery_score": { "description": "recovery_score in count", "examples": [ 83 ], "type": "number" }, "sleep_duration_total": { "description": "sleep_duration_total in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in count", "examples": [ 70 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 10000 ], "type": "number" }, "stress_score": { "description": "stress_score in count", "examples": [ 70 ], "type": "number" } }, "type": "object" } }, "required": [ "values" ], "type": "object" }, "TimeseriesMergedQueryOutput": { "additionalProperties": false, "properties": { "device_types": { "description": "Device types involved for these timeseries", "items": { "enum": [ "unknown", "phone", "watch", "scale", "ring", "head_mounted", "fitness_band", "chest_strap", "smart_display", "accessory" ], "type": "string" }, "type": "array" }, "durations": { "description": "Duration of each timeseries entry in milliseconds", "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "from_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "metric": { "description": "The metric type for these timeseries", "enum": [ "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" ], "type": "string" }, "offsets": { "description": "Millisecond offsets from the start_at timestamp", "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "provider_sources": { "description": "Provider sources involved for these timeseries", "items": { "enum": [ "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" ], "type": "string" }, "type": "array" }, "providers": { "description": "Providers involved for these timeseries", "items": { "description": "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" ], "type": "string" }, "type": "array" }, "record_ids": { "description": "IDs of the records containing these timeseries", "items": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "to_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "values": { "description": "The actual metric values for each timeseries entry", "items": { "$ref": "#/components/schemas/MetricValue" }, "type": [ "array", "null" ] } }, "required": [ "metric" ], "type": "object" }, "TimeseriesSplitQueryOutput": { "additionalProperties": false, "properties": { "from_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "timeseries": { "items": { "$ref": "#/components/schemas/TimeseriesSplitQueryOutputEntry" }, "type": [ "array", "null" ] }, "to_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" } }, "required": [ "timeseries" ], "type": "object" }, "TimeseriesSplitQueryOutputEntry": { "additionalProperties": false, "properties": { "device_type": { "description": "The device type for these timeseries", "enum": [ "unknown", "phone", "watch", "scale", "ring", "head_mounted", "fitness_band", "chest_strap", "smart_display", "accessory" ], "type": "string" }, "division_type": { "description": "The division type for these timeseries", "enum": [ "session", "sample", "lap", "split", "segment", "sleep_stage" ], "type": "string" }, "durations": { "description": "Duration of each timeseries entry in milliseconds", "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "metric": { "description": "The metric type for these timeseries", "enum": [ "heartrate", "heartrate_resting", "hrv_rmssd", "hrv_sdnn", "floors_climbed", "speed", "air_temperature", "spo2", "breathing_rate", "elevation", "sleep_breathing_rate", "cadence", "body_mass_index", "weight", "height", "vo2max", "body_temperature", "basal_body_temperature", "skin_temperature", "body_fat", "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" ], "type": "string" }, "offsets": { "description": "Millisecond offsets from the start_at timestamp", "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "provider": { "description": "The provider slug for these timeseries", "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" ], "type": "string" }, "record_ids": { "description": "IDs of the records containing these timeseries", "items": { "description": "Unique identifier for a record.", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "source": { "$ref": "#/components/schemas/QueryOutputSourceInfo", "description": "Source info for these timeseries" }, "start_at": { "description": "The base timestamp from which offsets are calculated", "format": "date-time", "type": "string" }, "values": { "description": "The actual metric values for each timeseries entry", "items": { "$ref": "#/components/schemas/MetricValue" }, "type": [ "array", "null" ] } }, "required": [ "metric", "start_at" ], "type": "object" }, "UserInfo": { "additionalProperties": false, "properties": { "application_id": { "description": "Application ID", "format": "int64", "type": "integer" }, "application_user_id": { "description": "Application user ID", "type": "string" }, "compat_application_client_id": { "description": "Compat application client ID", "format": "uuid", "type": "string" }, "compat_application_client_token": { "description": "Compat application client token", "format": "uuid", "type": "string" }, "created_at": { "description": "Created at", "format": "date-time", "type": [ "string", "null" ] }, "integrated_providers": { "description": "List of integrated providers", "items": { "$ref": "#/components/schemas/UserInfoIntegratedProvider" }, "type": [ "array", "null" ] }, "uid": { "description": "Spike Internal User ID", "examples": [ "a12b34cd-a1b2-c3d4-e5f6-abcdef123456" ], "format": "uuid", "type": "string" } }, "required": [ "application_id", "application_user_id", "uid", "compat_application_client_token", "compat_application_client_id", "integrated_providers", "created_at" ], "type": "object" }, "UserInfoIntegratedProvider": { "additionalProperties": false, "properties": { "created_at": { "description": "Created at", "format": "date-time", "type": "string" }, "is_integration_broken": { "description": "Is integration broken", "type": "boolean" }, "provider_integration_id": { "description": "Provider integration ID", "format": "int64", "type": [ "integer", "null" ] }, "provider_slug": { "description": "Provider slug", "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" ], "type": "string" } }, "required": [ "provider_slug", "provider_integration_id", "is_integration_broken", "created_at" ], "type": "object" }, "UserProperties": { "additionalProperties": false, "properties": { "birth_date": { "description": "User birth date in YYYY-MM-DD format", "type": "string" }, "birth_year": { "description": "User birth year", "format": "int64", "type": "integer" }, "body_bone_mass": { "description": "User body bone mass in kg", "format": "double", "type": "number" }, "body_fat": { "description": "User body fat percentage", "format": "double", "type": "number" }, "body_mass_index": { "description": "User body mass index", "format": "double", "type": "number" }, "gender": { "description": "User gender in ISO/IEC 5218 format", "enum": [ "unknown", "male", "female", "other" ], "type": "string" }, "height": { "description": "User height in cm", "format": "double", "type": "number" }, "language": { "description": "User language in ISO 639 (SET 1) format (e.g., 'en')", "type": "string" }, "resting_heartrate": { "description": "User resting heart rate in bpm", "format": "double", "type": "number" }, "timezone": { "description": "User timezone in IANA format (e.g., 'America/New_York')", "type": "string" }, "weight": { "description": "User weight in kg", "format": "double", "type": "number" } }, "type": "object" }, "UserPropertiesPatchRequestBody": { "additionalProperties": false, "properties": { "birth_date": { "description": "User's date of birth in YYYY-MM-DD format", "type": "string" }, "timezone": { "description": "User's timezone in IANA format (e.g., 'America/New_York')", "type": "string" } }, "type": "object" }, "UserPropertiesPatchResponseBody": { "additionalProperties": false, "properties": { "properties": { "$ref": "#/components/schemas/UserProperties", "description": "Updated user properties" } }, "required": [ "properties" ], "type": "object" }, "UserPropertiesResponseBody": { "additionalProperties": false, "properties": { "properties": { "$ref": "#/components/schemas/UserProperties", "description": "User properties" } }, "required": [ "properties" ], "type": "object" }, "WorkoutQueryOutput": { "additionalProperties": false, "properties": { "duration": { "description": "Record duration", "format": "int64", "type": "integer" }, "end_at_timestamp": { "description": "Record end time", "format": "date-time", "type": "string" }, "input_method": { "description": "Data input method", "enum": [ "unknown", "manual", "device" ], "type": "string" }, "is_source_aggregated": { "description": "If the record is already aggregated by the source, for example Apple Health aggregating steps from multiple devices", "type": "boolean" }, "laps": { "items": { "$ref": "#/components/schemas/WorkoutQueryOutputActivityLap" }, "type": [ "array", "null" ] }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "modified_at": { "description": "Modified at", "format": "date-time", "type": "string" }, "provider_local_date": { "description": "Provider local date", "examples": [ "2006-01-02" ], "format": "date" }, "provider_slug": { "description": "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" ], "type": "string" }, "provider_source": { "description": "Source of the record according to the provider", "enum": [ "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" ], "type": "string" }, "provider_source_type": { "description": "Provider source types", "enum": [ "provider_summary", "intraday_aggregation", "activity_summary", "activity_file", "activity", "sample", "profile" ], "type": "string" }, "record_id": { "description": "Record ID", "examples": [ "12345678-1234-abcd-4321-abcdef123456" ], "format": "uuid", "type": "string" }, "route_points": { "$ref": "#/components/schemas/WorkoutQueryOutputActivitySamples" }, "samples": { "$ref": "#/components/schemas/WorkoutQueryOutputActivitySamples" }, "segments": { "items": { "$ref": "#/components/schemas/WorkoutQueryOutputActivitySegments" }, "type": [ "array", "null" ] }, "sessions": { "items": { "$ref": "#/components/schemas/WorkoutQueryOutputActivitySession" }, "type": [ "array", "null" ] }, "source": { "$ref": "#/components/schemas/QueryOutputSourceInfo" }, "splits": { "items": { "$ref": "#/components/schemas/WorkoutQueryOutputActivitySplits" }, "type": [ "array", "null" ] }, "start_at_timestamp": { "description": "Record start time", "format": "date-time", "type": "string" }, "user_time_offset_minutes": { "description": "User time offset in minutes", "format": "int32", "type": "integer" }, "workout_id": { "contentEncoding": "base64", "type": "string" }, "workout_name": { "type": "string" }, "workout_tags": { "items": { "description": "Activity tags", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] }, "workout_type": { "description": "Activity types", "enum": [ "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" ], "type": "string" } }, "required": [ "record_id", "modified_at", "start_at_timestamp" ], "type": "object" }, "WorkoutQueryOutputActivityLap": { "additionalProperties": false, "properties": { "duration": { "format": "int64", "type": "integer" }, "end_at": { "format": "date-time", "type": "string" }, "lap": { "format": "int64", "type": "integer" }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "start_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "WorkoutQueryOutputActivitySamples": { "additionalProperties": false, "properties": { "durations": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "offsets": { "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "values": { "properties": { "air_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "air_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "air_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ascent": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "basal_body_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "bedtime_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_diastolic_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "blood_pressure_systolic_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_bone_mass": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_fat_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_mass_index": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "body_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "breathing_rate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "cadence_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned_active": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_burned_basal": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "calories_intake": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "descent": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_cycling": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_running": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_swimming": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_walking": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "distance_wheelchair": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_active": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_high_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_low_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "duration_moderate_intensity": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ecg_rri": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "ecg_voltage": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_gain": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_loss": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "elevation_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "floors_climbed": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "glucose": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_resting_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone0_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone1_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone2_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone3_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone4_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "heartrate_zone5_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "height": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "hrv_rmssd": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "hrv_sdnn": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "latitude": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "longitude": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "pace": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "power": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "power_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "skin_temperature_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_breathing_rate_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_awake": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_deep": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_light": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_nap": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_duration_rem": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_efficiency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_interruptions": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_latency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_score": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "sleep_skin_temperature_deviation": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "speed_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2_max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "spo2_min": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "steps": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "swimming_distance_per_stroke": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "swimming_lengths": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "vo2max": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "wakeup_latency": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "weight": { "items": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array" } }, "type": "object" } }, "type": "object" }, "WorkoutQueryOutputActivitySegments": { "additionalProperties": false, "properties": { "duration": { "format": "int64", "type": "integer" }, "end_at": { "format": "date-time", "type": "string" }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "start_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "WorkoutQueryOutputActivitySession": { "additionalProperties": false, "properties": { "duration": { "format": "int64", "type": "integer" }, "end_at": { "format": "date-time", "type": "string" }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "start_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "WorkoutQueryOutputActivitySplits": { "additionalProperties": false, "properties": { "duration": { "format": "int64", "type": "integer" }, "end_at": { "format": "date-time", "type": "string" }, "metrics": { "description": "Metrics output", "properties": { "air_temperature": { "description": "air_temperature in celsius", "examples": [ 22.73 ], "type": "number" }, "air_temperature_max": { "description": "air_temperature_max in celsius", "examples": [ 28.55 ], "type": "number" }, "air_temperature_min": { "description": "air_temperature_min in celsius", "examples": [ 15.27 ], "type": "number" }, "ascent": { "description": "ascent in meters", "examples": [ 320.29 ], "type": "number" }, "basal_body_temperature": { "description": "basal_body_temperature in celsius", "examples": [ 36.53 ], "type": "number" }, "basal_body_temperature_max": { "description": "basal_body_temperature_max in celsius", "examples": [ 37.03 ], "type": "number" }, "basal_body_temperature_min": { "description": "basal_body_temperature_min in celsius", "examples": [ 36.01 ], "type": "number" }, "bedtime_duration": { "description": "bedtime_duration in ms", "examples": [ 28800000 ], "type": "number" }, "blood_pressure_diastolic": { "description": "blood_pressure_diastolic in mmHg", "examples": [ 80.03 ], "type": "number" }, "blood_pressure_diastolic_max": { "description": "blood_pressure_diastolic_max in mmHg", "examples": [ 90.07 ], "type": "number" }, "blood_pressure_diastolic_min": { "description": "blood_pressure_diastolic_min in mmHg", "examples": [ 60.01 ], "type": "number" }, "blood_pressure_systolic": { "description": "blood_pressure_systolic in mmHg", "examples": [ 120.03 ], "type": "number" }, "blood_pressure_systolic_max": { "description": "blood_pressure_systolic_max in mmHg", "examples": [ 140.07 ], "type": "number" }, "blood_pressure_systolic_min": { "description": "blood_pressure_systolic_min in mmHg", "examples": [ 100.01 ], "type": "number" }, "body_bone_mass": { "description": "body_bone_mass in g", "examples": [ 3200 ], "type": "number" }, "body_fat": { "description": "body_fat in percentage", "examples": [ 18.53 ], "type": "number" }, "body_fat_max": { "description": "body_fat_max in percentage", "examples": [ 25.03 ], "type": "number" }, "body_fat_min": { "description": "body_fat_min in percentage", "examples": [ 12.01 ], "type": "number" }, "body_mass_index": { "description": "body_mass_index in count", "examples": [ 22.5016 ], "type": "number" }, "body_temperature": { "description": "body_temperature in celsius", "examples": [ 36.73 ], "type": "number" }, "body_temperature_max": { "description": "body_temperature_max in celsius", "examples": [ 37.55 ], "type": "number" }, "body_temperature_min": { "description": "body_temperature_min in celsius", "examples": [ 36.13 ], "type": "number" }, "breathing_rate": { "description": "breathing_rate in breaths/min", "examples": [ 16.5016 ], "type": "number" }, "breathing_rate_max": { "description": "breathing_rate_max in breaths/min", "examples": [ 24.7549 ], "type": "number" }, "breathing_rate_min": { "description": "breathing_rate_min in breaths/min", "examples": [ 12.2534 ], "type": "number" }, "cadence": { "description": "cadence in rpm", "examples": [ 85.5016 ], "type": "number" }, "cadence_max": { "description": "cadence_max in rpm", "examples": [ 110.0049 ], "type": "number" }, "cadence_min": { "description": "cadence_min in rpm", "examples": [ 60.0034 ], "type": "number" }, "calories_burned": { "description": "calories_burned in kcal", "examples": [ 1650.7549 ], "type": "number" }, "calories_burned_active": { "description": "calories_burned_active in kcal", "examples": [ 450.2516 ], "type": "number" }, "calories_burned_basal": { "description": "calories_burned_basal in kcal", "examples": [ 1200.5034 ], "type": "number" }, "calories_intake": { "description": "calories_intake in kcal", "examples": [ 2100.5016 ], "type": "number" }, "descent": { "description": "descent in meters", "examples": [ 280.91 ], "type": "number" }, "distance": { "description": "distance in meters", "examples": [ 6500.2516 ], "type": "number" }, "distance_cycling": { "description": "distance_cycling in meters", "examples": [ 15000.7549 ], "type": "number" }, "distance_running": { "description": "distance_running in meters", "examples": [ 5000.5016 ], "type": "number" }, "distance_swimming": { "description": "distance_swimming in meters", "examples": [ 1000.7549 ], "type": "number" }, "distance_walking": { "description": "distance_walking in meters", "examples": [ 3200.5034 ], "type": "number" }, "distance_wheelchair": { "description": "distance_wheelchair in meters", "examples": [ 2800.5034 ], "type": "number" }, "duration_active": { "description": "duration_active in ms", "examples": [ 5400000 ], "type": "number" }, "duration_high_intensity": { "description": "duration_high_intensity in ms", "examples": [ 1200000 ], "type": "number" }, "duration_low_intensity": { "description": "duration_low_intensity in ms", "examples": [ 9000000 ], "type": "number" }, "duration_moderate_intensity": { "description": "duration_moderate_intensity in ms", "examples": [ 2400000 ], "type": "number" }, "ecg_rri": { "description": "ecg_rri in ms", "examples": [ 850 ], "type": "number" }, "ecg_voltage": { "description": "ecg_voltage in uV", "examples": [ 1200.53 ], "type": "number" }, "elevation": { "description": "elevation in meters", "examples": [ 1050.73 ], "type": "number" }, "elevation_gain": { "description": "elevation_gain in meters", "examples": [ 450.83 ], "type": "number" }, "elevation_loss": { "description": "elevation_loss in meters", "examples": [ 380.47 ], "type": "number" }, "elevation_max": { "description": "elevation_max in meters", "examples": [ 1250.55 ], "type": "number" }, "elevation_min": { "description": "elevation_min in meters", "examples": [ 850.37 ], "type": "number" }, "floors_climbed": { "description": "floors_climbed in count", "examples": [ 12 ], "type": "number" }, "glucose": { "description": "glucose in mg/dL", "examples": [ 95.654321 ], "type": "number" }, "heartrate": { "description": "heartrate in bpm", "examples": [ 90 ], "type": "number" }, "heartrate_max": { "description": "heartrate_max in bpm", "examples": [ 180 ], "type": "number" }, "heartrate_min": { "description": "heartrate_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_resting": { "description": "heartrate_resting in bpm", "examples": [ 70 ], "type": "number" }, "heartrate_resting_max": { "description": "heartrate_resting_max in bpm", "examples": [ 85 ], "type": "number" }, "heartrate_resting_min": { "description": "heartrate_resting_min in bpm", "examples": [ 60 ], "type": "number" }, "heartrate_zone0_duration": { "description": "heartrate_zone0_duration in ms", "examples": [ 5000 ], "type": "number" }, "heartrate_zone1_duration": { "description": "heartrate_zone1_duration in ms", "examples": [ 7152 ], "type": "number" }, "heartrate_zone2_duration": { "description": "heartrate_zone2_duration in ms", "examples": [ 25000 ], "type": "number" }, "heartrate_zone3_duration": { "description": "heartrate_zone3_duration in ms", "examples": [ 18170 ], "type": "number" }, "heartrate_zone4_duration": { "description": "heartrate_zone4_duration in ms", "examples": [ 6372 ], "type": "number" }, "heartrate_zone5_duration": { "description": "heartrate_zone5_duration in ms", "examples": [ 2000 ], "type": "number" }, "height": { "description": "height in meters", "examples": [ 1.7549 ], "type": "number" }, "hrv_rmssd": { "description": "hrv_rmssd in ms", "examples": [ 45 ], "type": "number" }, "hrv_sdnn": { "description": "hrv_sdnn in ms", "examples": [ 52 ], "type": "number" }, "latitude": { "description": "latitude in degrees", "examples": [ 37.77492948 ], "type": "number" }, "longitude": { "description": "longitude in degrees", "examples": [ -122.41941637 ], "type": "number" }, "pace": { "description": "pace in sec/m", "examples": [ 3.53 ], "type": "number" }, "power": { "description": "power in w", "examples": [ 125 ], "type": "number" }, "power_max": { "description": "power_max in w", "examples": [ 125 ], "type": "number" }, "skin_temperature": { "description": "skin_temperature in celsius", "examples": [ 33.53 ], "type": "number" }, "skin_temperature_max": { "description": "skin_temperature_max in celsius", "examples": [ 34.27 ], "type": "number" }, "skin_temperature_min": { "description": "skin_temperature_min in celsius", "examples": [ 32.89 ], "type": "number" }, "sleep_breathing_rate": { "description": "sleep_breathing_rate in breaths/min", "examples": [ 14.27 ], "type": "number" }, "sleep_breathing_rate_max": { "description": "sleep_breathing_rate_max in breaths/min", "examples": [ 18.59 ], "type": "number" }, "sleep_breathing_rate_min": { "description": "sleep_breathing_rate_min in breaths/min", "examples": [ 10.03 ], "type": "number" }, "sleep_duration": { "description": "sleep_duration in ms", "examples": [ 25200000 ], "type": "number" }, "sleep_duration_awake": { "description": "sleep_duration_awake in ms", "examples": [ 1800000 ], "type": "number" }, "sleep_duration_deep": { "description": "sleep_duration_deep in ms", "examples": [ 5400000 ], "type": "number" }, "sleep_duration_light": { "description": "sleep_duration_light in ms", "examples": [ 12600000 ], "type": "number" }, "sleep_duration_nap": { "description": "sleep_duration_nap in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_duration_rem": { "description": "sleep_duration_rem in ms", "examples": [ 3600000 ], "type": "number" }, "sleep_efficiency": { "description": "sleep_efficiency in percentage", "examples": [ 92 ], "type": "number" }, "sleep_interruptions": { "description": "sleep_interruptions in count", "examples": [ 2 ], "type": "number" }, "sleep_latency": { "description": "sleep_latency in ms", "examples": [ 900000 ], "type": "number" }, "sleep_score": { "description": "sleep_score in percentage", "examples": [ 85 ], "type": "number" }, "sleep_skin_temperature_deviation": { "description": "sleep_skin_temperature_deviation in celsius", "examples": [ -0.13 ], "type": "number" }, "speed": { "description": "speed in m/sec", "examples": [ 3.2516 ], "type": "number" }, "speed_max": { "description": "speed_max in m/sec", "examples": [ 8.5034 ], "type": "number" }, "speed_min": { "description": "speed_min in m/sec", "examples": [ 0.5016 ], "type": "number" }, "spo2": { "description": "spo2 in percentage", "examples": [ 98.5016 ], "type": "number" }, "spo2_max": { "description": "spo2_max in percentage", "examples": [ 99.5034 ], "type": "number" }, "spo2_min": { "description": "spo2_min in percentage", "examples": [ 95.2516 ], "type": "number" }, "steps": { "description": "steps in count", "examples": [ 8500 ], "type": "number" }, "swimming_distance_per_stroke": { "description": "swimming_distance_per_stroke in meters", "examples": [ 2.27 ], "type": "number" }, "swimming_lengths": { "description": "swimming_lengths in count", "examples": [ 40 ], "type": "number" }, "vo2max": { "description": "vo2max in mL/kg/min", "examples": [ 45.23 ], "type": "number" }, "wakeup_latency": { "description": "wakeup_latency in ms", "examples": [ 600000 ], "type": "number" }, "weight": { "description": "weight in g", "examples": [ 70000.5034 ], "type": "number" } }, "type": "object" }, "start_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "WorkoutsQueryOutput": { "additionalProperties": false, "properties": { "from_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "to_timestamp": { "examples": [ "2006-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "workouts": { "items": { "$ref": "#/components/schemas/WorkoutQueryOutput" }, "type": [ "array", "null" ] } }, "required": [ "workouts" ], "type": "object" } }, "securitySchemes": { "bearer": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Application user API", "version": "3.0.2" }, "openapi": "3.1.0", "paths": { "/applicationinfo": { "get": { "description": "Get the application manifest for the current application.", "operationId": "getApplicationinfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationInfo" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Application Information", "tags": [ "Info / App" ] } }, "/auth/client_token": { "post": { "operationId": "postAuthClientToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeClientTokenRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeResponseBody" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Authenticate via V1 Client Token", "tags": [ "Auth" ] } }, "/auth/hmac": { "post": { "description": "Authenticate using an HMAC signature. @TODO: document and examples", "operationId": "postAuthHmac", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeHmacRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeResponseBody" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Authenticate via HMAC", "tags": [ "Auth" ] } }, "/auth/pkcs1": { "post": { "description": "Authenticate using a PKCS1 signature. @TODO: document and examples", "operationId": "postAuthPkcs1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizePKCS1RequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeResponseBody" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Authenticate via PKCS1", "tags": [ "Auth" ] } }, "/lab_reports": { "get": { "description": "Retrieve a list of lab reports by the time range.", "operationId": "listLabReports", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "required": true, "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "required": true, "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/LabReport" }, "type": [ "array", "null" ] } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "List Lab Reports", "tags": [ "Lab Reports" ] }, "post": { "description": "Upload and process a base64 encoded document.", "operationId": "postLabReports", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabReportsPostInput", "description": "raw body" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabReportsPostOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Upload Lab Report", "tags": [ "Lab Reports" ] } }, "/lab_reports/process": { "post": { "description": "Process a lab report and return the results.", "operationId": "postLabReportsProcess", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabReportsPostInput", "description": "raw body" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabReportsPostOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Process Lab Report", "tags": [ "Lab Reports" ] } }, "/lab_reports/{lab_report_id}": { "get": { "description": "Retrieve a lab report by record ID.", "operationId": "getLabReportsByLabReportId", "parameters": [ { "description": "Lab Report ID", "in": "path", "name": "lab_report_id", "required": true, "schema": { "description": "Lab Report ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabReport" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Get Lab Report", "tags": [ "Lab Reports" ] } }, "/nutrition_records": { "get": { "description": "Retrieve a list of nutrition records by the time range.", "operationId": "listNutritionRecords", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "required": true, "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "required": true, "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "Filter by consumed status: 'true' for saved records with consumed_at, 'false' for analyze-only records, 'any' for both. Default: 'true'", "explode": false, "in": "query", "name": "consumed", "schema": { "default": "true", "description": "Filter by consumed status: 'true' for saved records with consumed_at, 'false' for analyze-only records, 'any' for both. Default: 'true'", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/NutritionRecord" }, "type": [ "array", "null" ] } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "List Nutrition Records", "tags": [ "Nutrition AI" ] } }, "/nutrition_records/image": { "post": { "description": "##### Upload a food image and analyze the nutritional content.\n\nThe system uses advanced computer vision and machine learning models to identify ingredients, calculate nutritional values, and provide detailed food composition data.\n\n### Processing Flow\n\nThe processing mode is controlled by the `wait_on_process` parameter. The API supports two processing modes, each suited for a different use case:\n\n- **Asynchronous** (recommended) — returns immediately and processes the image in the background (see [Asynchronous Processing](/nutrition-ai/async)); use webhooks for real-time notifications\n- **Synchronous** — waits for analysis to be completed before responding\n\nIf your application is configured to use asynchronous processing and ready to consume webhooks, our API will send a webhook notification in both processing modes, synchronous or asynchronous, once the nutritional analysis is completed.\n\n### Analysis Modes\n\n- **`precise`** (default) — uses advanced AI models for the highest accuracy and detail with good processing time\n- **`fast`** — uses optimized AI models for good accuracy and detail with the fastest processing time\n\n### Localization\n\nOptionally provide `country_code` and/or `language_code` in lowercase (ISO 3166-1 alpha-2 code) for region-specific analysis.\n\n### Including Optional Data\n\nIf `include_nutrition_fields` is omitted or empty, only four basic fields are included by default:\n- `carbohydrate_g`\n- `energy_kcal`\n- `fat_total_g`\n- `protein_g`\n\nExample of how to include optional fields and custom nutritional fields:\n\n```json\n{\n \"include_nutri_score\": true,\n \"include_dish_description\": true,\n \"include_ingredients\": true,\n \"include_nutrition_fields\": [\n \"energy_kcal\",\n \"protein_g\",\n \"fat_total_g\",\n \"carbohydrate_g\",\n \"fiber_total_dietary_g\",\n \"sodium_mg\",\n \"calcium_mg\",\n \"iron_mg\"\n ]\n}\n```\n\nFor more documentation, including implementation examples, processing workflows, and integration guides, see **[Implementation Guide](/nutrition-ai/implementation)**.\n", "operationId": "postNutritionRecordsImage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecordUploadInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecord" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Analyze Nutrition Image", "tags": [ "Nutrition AI" ] } }, "/nutrition_records/ingredients/label": { "post": { "description": "##### Upload an image of a nutritional facts label to analyze it.\n\nThe system uses OCR (Optical Character Recognition) powered by AI to extract nutrition details from nutritional facts label image.\nThe results with nutritional fields like total fat, protein, etc. are structurized and presented as one ingredient in the JSON response.\n\n### Processing Flow\n\nThe processing of nutrition facts label analysis is synchronous. No webhooks will be sent.\n\n### Analysis Modes\n\n- **`precise`** (default) — uses advanced AI models for the highest accuracy and detail with good processing time\n- **`fast`** — uses optimized AI models for good accuracy and detail with the fastest processing time\n\n### Nutritional fields\n\nA predefined list of nutritional fields is extracted. See **[Nutritional Fields](/technical-references/nutritional_fields)** for supported macronutrients and micronutrients.\n\n### Localization\n\nFor more documentation, including implementation examples, processing workflows, and integration guides, see **[Implementation Guide](/nutrition-ai/implementation)**.\n", "operationId": "postNutritionRecordsIngredientsLabel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionIngredientLabelInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionIngredient" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Analyze Nutrition Facts Label", "tags": [ "Nutrition AI" ] } }, "/nutrition_records/manual": { "post": { "description": "##### Upload a manually created nutrition record\n\nThe values are validated against the schema but not verified to be consistent (e.g., total calories are not verified to be\nequal to the sum of calories found in the ingredients), but the check for mandatory fields is still enforced.\n\nThe status of the successfully uploaded record will be set to `completed` and the input type will be set to `manual`.\n\nThe language of the provided dish name and description will be neither identified nor validated.\nWhen available, provide `dish_name` in English and use the `dish_name_translated` field for the dish name in the local language.\nOtherwise, populate both the `dish_name_translated` and mandatory `dish_name` fields with the localized dish name provided by the user.\n", "operationId": "postNutritionRecordsManual", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecord" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecord" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Upload Nutrition Record", "tags": [ "Nutrition AI" ] } }, "/nutrition_records/text": { "post": { "description": "Analyze a text description of a meal and return nutritional information.\n\nSubmit a plain-text description of what was eaten (e.g., \"grilled chicken breast with rice and steamed broccoli\") and the API will return a detailed nutritional breakdown including calories, macronutrients, and optionally micronutrients and ingredients.\n\nThis endpoint works identically to the image-based nutrition analysis but accepts text instead of an image. All the same options are available: `include_ingredients`, `include_nutri_score`, `include_dish_description`, etc.\n\n### Request\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `meal_description` | string | Yes | Text description of the meal (3–2000 characters) |\n| `consumed_at` | string | No | UTC timestamp when food was consumed. Defaults to upload time |\n| `wait_on_process` | boolean | No | If true, waits for completion. Otherwise returns immediately with pending status |\n| `analysis_mode` | string | No | `fast` or `precise` (default: `precise`) |\n| `country_code` | string | No | ISO 3166-1 alpha-2 country code (default: `us`) |\n| `language_code` | string | No | ISO 639-1 language code (default: `en`) |\n| `include_ingredients` | boolean | No | Include ingredient breakdown (default: `false`) |\n| `include_nutri_score` | boolean | No | Include Nutri-Score rating (default: `false`) |\n| `include_dish_description` | boolean | No | Include dish description (default: `false`) |\n| `include_nutrition_fields` | array | No | Nutrition fields to include (default: `energy_kcal, protein_g, fat_total_g, carbohydrate_g`) |\n", "operationId": "postNutritionRecordsText", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecordTextUploadInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecord" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Analyze Nutrition Text", "tags": [ "Nutrition AI" ] } }, "/nutrition_records/{nutrition_record_id}": { "delete": { "description": "##### Delete a nutrition report record by ID.\n\nAn HTTP 204 status code will be returned if successful, regardless if the record existed or not.\n", "operationId": "deleteNutritionRecordsByNutritionRecordId", "parameters": [ { "description": "Nutrition report record ID", "in": "path", "name": "nutrition_record_id", "required": true, "schema": { "description": "Nutrition report record ID", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Delete Nutrition Record", "tags": [ "Nutrition AI" ] }, "get": { "description": "Retrieve a nutrition record by ID.", "operationId": "getNutritionRecordsByNutritionRecordId", "parameters": [ { "description": "Nutrition report record ID", "in": "path", "name": "nutrition_record_id", "required": true, "schema": { "description": "Nutrition report record ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecord" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Get Nutrition Record", "tags": [ "Nutrition AI" ] }, "patch": { "description": "##### Change the portion size for a nutrition record by ID.\n\nYou can modify the nutrition record by updating the total serving size or consumption time. At least one of these fields must be provided.\n\nThe status of the successfully modified record will be set to `updated` while the input type will preserve the original value.\n\n### Updating Serving Size\n\nWhen the serving size is changed, all ingredients and their respective nutritional fields will be automatically recalculated proportionally to maintain the same nutritional ratios.\nThis allows you to easily adjust portion sizes while maintaining accurate nutritional information.\n\nThe new serving size is expected to be in the same unit as the original serving size.\n\n### Setting Up Consumption Time\n\nThe consumption time indicates when the food was actually consumed. Leaving the consumption time empty or not providing it will keep the original value.\n\nThis allows you to first track planned meals (without consumption time) and eventually mark them as consumed by setting up consumption time.\n", "operationId": "patchNutritionRecordsByNutritionRecordId", "parameters": [ { "description": "Nutrition report record ID", "in": "path", "name": "nutrition_record_id", "required": true, "schema": { "description": "Nutrition report record ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecordPatchRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecord" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Modify Nutrition Record", "tags": [ "Nutrition AI" ] }, "put": { "description": "##### Replace an existing nutrition record.\n\nYou can replace an existing nutrition record. All information of the old one will be deleted, and only\nthe new information will be retained. The `record_id` will remain the same.\n\nThe status of the successfully replaced record will be set to `updated` while the input type will be updated to `manual` regardless of the original value.\n\nThe language of the provided dish name and description will be neither identified nor validated.\n", "operationId": "putNutritionRecordsByNutritionRecordId", "parameters": [ { "description": "Nutrition report record ID", "in": "path", "name": "nutrition_record_id", "required": true, "schema": { "description": "Nutrition report record ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecord" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionRecord" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Replace Nutrition Record", "tags": [ "Nutrition AI" ] } }, "/providers/apple/push": { "post": { "description": "Push Apple Healthkit data into the system.", "operationId": "postProvidersApplePush", "parameters": [ { "description": "The version of the SDK that is sending the request", "example": "4.3.91-beta.1", "in": "header", "name": "x-spike-sdk-version", "schema": { "description": "The version of the SDK that is sending the request", "examples": [ "4.3.91-beta.1" ], "type": "string" } }, { "description": "The OS that is sending the request", "example": "iOS", "in": "header", "name": "x-spike-os", "schema": { "description": "The OS that is sending the request", "examples": [ "iOS" ], "type": "string" } }, { "description": "The version of the OS that is sending the request", "example": "18.6.2", "in": "header", "name": "x-spike-os-version", "schema": { "description": "The version of the OS that is sending the request", "examples": [ "18.6.2" ], "type": "string" } }, { "description": "The version of the SDK wrapper that is sending the request", "example": "1.0.0", "in": "header", "name": "x-spike-sdk-wrapper-version", "schema": { "description": "The version of the SDK wrapper that is sending the request", "examples": [ "1.0.0" ], "type": "string" } }, { "description": "Boolean denoting background delivery of the push", "in": "header", "name": "x-spike-background", "schema": { "description": "Boolean denoting background delivery of the push", "type": "boolean" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Push Apple Healthkit", "tags": [ "SDK / Push" ] } }, "/providers/apple/push/proto": { "post": { "description": "Push Apple Healthkit data into the system.", "operationId": "postProvidersApplePushProto", "parameters": [ { "description": "The version of the SDK that is sending the request", "example": "4.3.91-beta.1", "in": "header", "name": "x-spike-sdk-version", "schema": { "description": "The version of the SDK that is sending the request", "examples": [ "4.3.91-beta.1" ], "type": "string" } }, { "description": "The OS that is sending the request", "example": "iOS", "in": "header", "name": "x-spike-os", "schema": { "description": "The OS that is sending the request", "examples": [ "iOS" ], "type": "string" } }, { "description": "The version of the OS that is sending the request", "example": "18.6.2", "in": "header", "name": "x-spike-os-version", "schema": { "description": "The version of the OS that is sending the request", "examples": [ "18.6.2" ], "type": "string" } }, { "description": "The version of the SDK wrapper that is sending the request", "example": "1.0.0", "in": "header", "name": "x-spike-sdk-wrapper-version", "schema": { "description": "The version of the SDK wrapper that is sending the request", "examples": [ "1.0.0" ], "type": "string" } }, { "description": "Boolean denoting background delivery of the push", "in": "header", "name": "x-spike-background", "schema": { "description": "Boolean denoting background delivery of the push", "type": "boolean" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Push Apple Healthkit", "tags": [ "SDK / Push" ] } }, "/providers/biostrap/integration/callback": { "get": { "operationId": "getProvidersBiostrapIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers biostrap integration callback", "tags": [ "Init / Callback" ] } }, "/providers/coros/integration/callback": { "get": { "operationId": "getProvidersCorosIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers coros integration callback", "tags": [ "Init / Callback" ] } }, "/providers/dexcom/integration/callback": { "get": { "operationId": "getProvidersDexcomIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers dexcom integration callback", "tags": [ "Init / Callback" ] } }, "/providers/dexcom_sandbox/integration/callback": { "get": { "operationId": "getProvidersDexcomSandboxIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers dexcom sandbox integration callback", "tags": [ "Init / Callback" ] } }, "/providers/fitbit/integration/callback": { "get": { "operationId": "getProvidersFitbitIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers fitbit integration callback", "tags": [ "Init / Callback" ] } }, "/providers/freestyle_libre/integration/callback": { "get": { "operationId": "getProvidersFreestyleLibreIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers freestyle libre integration callback", "tags": [ "Init / Callback" ] } }, "/providers/garmin/integration/callback": { "get": { "operationId": "getProvidersGarminIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "OAuth token", "explode": false, "in": "query", "name": "oauth_token", "schema": { "description": "OAuth token", "type": "string" } }, { "description": "OAuth verifier", "explode": false, "in": "query", "name": "oauth_verifier", "schema": { "description": "OAuth verifier", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers garmin integration callback", "tags": [ "Init / Callback" ] } }, "/providers/google_fit/integration/callback": { "get": { "operationId": "getProvidersGoogleFitIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers google fit integration callback", "tags": [ "Init / Callback" ] } }, "/providers/google_health/integration/callback": { "get": { "operationId": "getProvidersGoogleHealthIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers google health integration callback", "tags": [ "Init / Callback" ] } }, "/providers/health_connect/push": { "post": { "description": "Push Health Connect data into the system.", "operationId": "postProvidersHealthConnectPush", "parameters": [ { "description": "The version of the SDK that is sending the request", "example": "4.3.91-beta.1", "in": "header", "name": "x-spike-sdk-version", "schema": { "description": "The version of the SDK that is sending the request", "examples": [ "4.3.91-beta.1" ], "type": "string" } }, { "description": "The OS that is sending the request", "example": "Android", "in": "header", "name": "x-spike-os", "schema": { "description": "The OS that is sending the request", "examples": [ "Android" ], "type": "string" } }, { "description": "The version of the OS that is sending the request", "example": "14.0", "in": "header", "name": "x-spike-os-version", "schema": { "description": "The version of the OS that is sending the request", "examples": [ "14.0" ], "type": "string" } }, { "description": "The version of the SDK wrapper that is sending the request", "example": "1.0.0", "in": "header", "name": "x-spike-sdk-wrapper-version", "schema": { "description": "The version of the SDK wrapper that is sending the request", "examples": [ "1.0.0" ], "type": "string" } }, { "description": "Boolean denoting background delivery of the push", "in": "header", "name": "x-spike-background", "schema": { "description": "Boolean denoting background delivery of the push", "type": "boolean" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Push Health Connect", "tags": [ "SDK / Push" ] } }, "/providers/health_connect/push/proto": { "post": { "description": "Push Health Connect data into the system.", "operationId": "postProvidersHealthConnectPushProto", "parameters": [ { "description": "The version of the SDK that is sending the request", "example": "4.3.91-beta.1", "in": "header", "name": "x-spike-sdk-version", "schema": { "description": "The version of the SDK that is sending the request", "examples": [ "4.3.91-beta.1" ], "type": "string" } }, { "description": "The OS that is sending the request", "example": "Android", "in": "header", "name": "x-spike-os", "schema": { "description": "The OS that is sending the request", "examples": [ "Android" ], "type": "string" } }, { "description": "The version of the OS that is sending the request", "example": "14.0", "in": "header", "name": "x-spike-os-version", "schema": { "description": "The version of the OS that is sending the request", "examples": [ "14.0" ], "type": "string" } }, { "description": "The version of the SDK wrapper that is sending the request", "example": "1.0.0", "in": "header", "name": "x-spike-sdk-wrapper-version", "schema": { "description": "The version of the SDK wrapper that is sending the request", "examples": [ "1.0.0" ], "type": "string" } }, { "description": "Boolean denoting background delivery of the push", "in": "header", "name": "x-spike-background", "schema": { "description": "Boolean denoting background delivery of the push", "type": "boolean" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Push Health Connect", "tags": [ "SDK / Push" ] } }, "/providers/huawei/integration/callback": { "get": { "operationId": "getProvidersHuaweiIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers huawei integration callback", "tags": [ "Init / Callback" ] } }, "/providers/luna/integration/callback": { "get": { "operationId": "getProvidersLunaIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "Whether the user gave consent in the Luna app", "explode": false, "in": "query", "name": "consent", "schema": { "description": "Whether the user gave consent in the Luna app", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers luna integration callback", "tags": [ "Init / Callback" ] } }, "/providers/map_my_fitness/integration/callback": { "get": { "operationId": "getProvidersMapMyFitnessIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers map my fitness integration callback", "tags": [ "Init / Callback" ] } }, "/providers/omron_eu/integration/callback": { "get": { "operationId": "getProvidersOmronEuIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers omron eu integration callback", "tags": [ "Init / Callback" ] } }, "/providers/omron_us/integration/callback": { "get": { "operationId": "getProvidersOmronUsIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers omron us integration callback", "tags": [ "Init / Callback" ] } }, "/providers/oura/integration/callback": { "get": { "operationId": "getProvidersOuraIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers oura integration callback", "tags": [ "Init / Callback" ] } }, "/providers/polar/integration/callback": { "get": { "operationId": "getProvidersPolarIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers polar integration callback", "tags": [ "Init / Callback" ] } }, "/providers/samsung_health_data/push/proto": { "post": { "description": "Push Samsung Health Data data into the system.", "operationId": "postProvidersSamsungHealthDataPushProto", "parameters": [ { "description": "The version of the SDK that is sending the request", "example": "4.3.91-beta.1", "in": "header", "name": "x-spike-sdk-version", "schema": { "description": "The version of the SDK that is sending the request", "examples": [ "4.3.91-beta.1" ], "type": "string" } }, { "description": "The OS that is sending the request", "example": "Android", "in": "header", "name": "x-spike-os", "schema": { "description": "The OS that is sending the request", "examples": [ "Android" ], "type": "string" } }, { "description": "The version of the OS that is sending the request", "example": "14.0", "in": "header", "name": "x-spike-os-version", "schema": { "description": "The version of the OS that is sending the request", "examples": [ "14.0" ], "type": "string" } }, { "description": "The version of the SDK wrapper that is sending the request", "example": "1.0.0", "in": "header", "name": "x-spike-sdk-wrapper-version", "schema": { "description": "The version of the SDK wrapper that is sending the request", "examples": [ "1.0.0" ], "type": "string" } }, { "description": "Boolean denoting background delivery of the push", "in": "header", "name": "x-spike-background", "schema": { "description": "Boolean denoting background delivery of the push", "type": "boolean" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "contentMediaType": "application/octet-stream", "format": "binary", "type": "string" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Push Samsung Health Data", "tags": [ "SDK / Push" ] } }, "/providers/strava/integration/callback": { "get": { "operationId": "getProvidersStravaIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers strava integration callback", "tags": [ "Init / Callback" ] } }, "/providers/suunto/integration/callback": { "get": { "operationId": "getProvidersSuuntoIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers suunto integration callback", "tags": [ "Init / Callback" ] } }, "/providers/testing/integration/callback": { "get": { "operationId": "getProvidersTestingIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers testing integration callback", "tags": [ "Init / Callback" ] } }, "/providers/ultrahuman/integration/callback": { "get": { "operationId": "getProvidersUltrahumanIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers ultrahuman integration callback", "tags": [ "Init / Callback" ] } }, "/providers/wahoo/integration/callback": { "get": { "operationId": "getProvidersWahooIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers wahoo integration callback", "tags": [ "Init / Callback" ] } }, "/providers/whoop/integration/callback": { "get": { "operationId": "getProvidersWhoopIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers whoop integration callback", "tags": [ "Init / Callback" ] } }, "/providers/withings/integration/callback": { "get": { "operationId": "getProvidersWithingsIntegrationCallback", "parameters": [ { "description": "Cookie data", "in": "cookie", "name": "spike-integration", "schema": { "description": "Cookie data", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Code", "explode": false, "in": "query", "name": "code", "schema": { "description": "Code", "type": "string" } }, { "description": "Error", "explode": false, "in": "query", "name": "error", "schema": { "description": "Error", "type": "string" } }, { "description": "Error Description", "explode": false, "in": "query", "name": "error_description", "schema": { "description": "Error Description", "type": "string" } }, { "description": "Scope", "explode": false, "in": "query", "name": "scope", "schema": { "description": "Scope", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Location": { "schema": { "type": "string" } } } }, "302": { "description": "Redirect back to the application" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Get providers withings integration callback", "tags": [ "Init / Callback" ] } }, "/providers/{provider_slug}/integration": { "delete": { "description": "Delete an integration with a provider.", "operationId": "deleteProvidersByProviderSlugIntegration", "parameters": [ { "description": "Provider name", "example": "strava", "in": "path", "name": "provider_slug", "required": true, "schema": { "description": "Provider name", "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" ], "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Delete Integration", "tags": [ "Init / Init" ] } }, "/providers/{provider_slug}/integration/init": { "get": { "description": "Initiate an integration with a provider.", "operationId": "getProvidersByProviderSlugIntegrationInit", "parameters": [ { "description": "Provider name", "in": "path", "name": "provider_slug", "required": true, "schema": { "description": "Provider name", "enum": [ "strava", "omron_eu", "omron_us", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "luna", "map_my_fitness", "application" ], "type": "string" } }, { "description": "Redirect URI", "explode": false, "in": "query", "name": "redirect_uri", "schema": { "description": "Redirect URI", "format": "url", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Provider User ID (where applicable)", "explode": false, "in": "query", "name": "provider_user_id", "schema": { "description": "Provider User ID (where applicable)", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Domain": { "schema": { "type": "string" } }, "Expires": { "schema": { "type": "string" } }, "HttpOnly": { "schema": { "type": "boolean" } }, "Location": { "schema": { "type": "string" } }, "MaxAge": { "schema": { "format": "int64", "type": "integer" } }, "Name": { "schema": { "type": "string" } }, "Partitioned": { "schema": { "type": "boolean" } }, "Path": { "schema": { "type": "string" } }, "Quoted": { "schema": { "type": "boolean" } }, "Raw": { "schema": { "type": "string" } }, "RawExpires": { "schema": { "type": "string" } }, "SameSite": { "schema": { "format": "int64", "type": "integer" } }, "Secure": { "schema": { "type": "boolean" } }, "Set-Cookie": { "schema": { "type": "string" } }, "Unparsed": { "schema": { "type": "string" } }, "Value": { "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Initiate Integration", "tags": [ "Init / Init" ] } }, "/providers/{provider_slug}/integration/init/ic/{ic}": { "get": { "description": "Initiate an integration from an encrypted IC parameter. Pass ?stateful=true to store state in Redis instead of a cookie.", "operationId": "getProvidersByProviderSlugIntegrationInitIcByIc", "parameters": [ { "description": "Integration request object", "in": "path", "name": "ic", "required": true, "schema": { "description": "Integration request object", "type": "string" } }, { "description": "Provider name", "in": "path", "name": "provider_slug", "required": true, "schema": { "description": "Provider name", "enum": [ "strava", "omron_eu", "omron_us", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "luna", "map_my_fitness", "application" ], "type": "string" } }, { "description": "Redirect URI", "explode": false, "in": "query", "name": "redirect_uri", "schema": { "description": "Redirect URI", "format": "url", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Provider User ID (where applicable)", "explode": false, "in": "query", "name": "provider_user_id", "schema": { "description": "Provider User ID (where applicable)", "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "Domain": { "schema": { "type": "string" } }, "Expires": { "schema": { "type": "string" } }, "HttpOnly": { "schema": { "type": "boolean" } }, "Location": { "schema": { "type": "string" } }, "MaxAge": { "schema": { "format": "int64", "type": "integer" } }, "Name": { "schema": { "type": "string" } }, "Partitioned": { "schema": { "type": "boolean" } }, "Path": { "schema": { "type": "string" } }, "Quoted": { "schema": { "type": "boolean" } }, "Raw": { "schema": { "type": "string" } }, "RawExpires": { "schema": { "type": "string" } }, "SameSite": { "schema": { "format": "int64", "type": "integer" } }, "Secure": { "schema": { "type": "boolean" } }, "Set-Cookie": { "schema": { "type": "string" } }, "Unparsed": { "schema": { "type": "string" } }, "Value": { "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "summary": "Initiate Integration from IC", "tags": [ "Init / Init" ] } }, "/providers/{provider_slug}/integration/init_url": { "get": { "description": "Initiate an integration with a provider.", "operationId": "getProvidersByProviderSlugIntegrationInitUrl", "parameters": [ { "description": "Provider name", "in": "path", "name": "provider_slug", "required": true, "schema": { "description": "Provider name", "enum": [ "strava", "omron_eu", "omron_us", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "luna", "map_my_fitness", "application" ], "type": "string" } }, { "description": "Redirect URI", "explode": false, "in": "query", "name": "redirect_uri", "schema": { "description": "Redirect URI", "format": "url", "type": "string" } }, { "description": "State", "explode": false, "in": "query", "name": "state", "schema": { "description": "State", "type": "string" } }, { "description": "Provider User ID (where applicable)", "explode": false, "in": "query", "name": "provider_user_id", "schema": { "description": "Provider User ID (where applicable)", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInitURLResponseBody" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Initiate Integration", "tags": [ "Init / Init" ] } }, "/queries/provider_record": { "post": { "description": "Query the provider record dataset.\n\n", "operationId": "postQueriesProviderRecord", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "COMPAT: Query provider records", "tags": [ "Queries / Provider Records (Compat)" ] } }, "/queries/provider_records": { "get": { "description": "This endpoint allows you to query provider records with metrics, optionally filtering by providers. It supports filtering by UTC timestamp range and providers, and includes provider-specific metrics in the response.\n\nThe response includes records with raw data from providers transformed into the unified data model, each possibly including:\n- base information (start, end, duration, user time offset, input method, source provider, etc.)\n- metrics (base and provider-specific)\n- activity information such as activity ID, type, and tags\n- activity breakdown into laps, sessions, etc.\n- sleeps with sample data\n\nAll timestamps in both request and response are in the UTC timezone.\n", "operationId": "getQueriesProviderRecords", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "explode": false, "in": "query", "name": "providers", "schema": { "items": { "enum": [ "strava", "health_connect", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "apple", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "samsung_health_data", "luna", "map_my_fitness", "application" ], "type": "string" }, "type": "array" } }, { "description": "Include metrics", "explode": false, "in": "query", "name": "metrics", "schema": { "description": "Include metrics", "items": { "enum": [ "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" ], "type": "string" }, "type": "array" } }, { "description": "Include provider specific metrics such as unique sleep score", "explode": false, "in": "query", "name": "include_provider_specific_metrics", "schema": { "description": "Include provider specific metrics such as unique sleep score", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordsQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "List Provider Records", "tags": [ "Queries / Provider Records" ] } }, "/queries/provider_records/{record_id}": { "get": { "description": "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.\n\nThe response includes a single record with raw data from the provider transformed into the unified data model, possibly including:\n- base information (start, end, duration, user time offset, input method, source provider, etc.)\n- metrics (base and provider-specific)\n- activity information such as activity ID, type, and tags\n- activity breakdown into laps, sessions, etc. with related sample data\n- sleep with sample data\n\nAll timestamps in the response are in the UTC timezone.\n", "operationId": "getQueriesProviderRecordsByRecordId", "parameters": [ { "in": "path", "name": "record_id", "required": true, "schema": { "type": "string" } }, { "explode": false, "in": "query", "name": "metrics", "schema": { "items": { "enum": [ "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" ], "type": "string" }, "type": "array" } }, { "explode": false, "in": "query", "name": "include_samples", "schema": { "type": "boolean" } }, { "explode": false, "in": "query", "name": "include_provider_specific_metrics", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryOutputRecord" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Get Provider Record", "tags": [ "Queries / Provider Records" ] } }, "/queries/sleeps": { "get": { "description": "This endpoint returns sleep data including different sleep stages that represent the various phases of sleep a person goes through during a sleep cycle. Each stage is characterized by distinct physiological and neurological patterns.\n\nThe different sleep stages are:\n\n- **awake**: The state of being fully conscious and alert.\n- **sleeping**: A general term for being in a state of sleep.\n- **out_of_bed**: The state when a person is not in bed, possibly indicating a brief interruption in sleep.\n- **light**: A stage of sleep where the body begins to relax, and the heart rate slows down. It is easier to wake up from this stage.\n- **deep**: A restorative stage of sleep where the body repairs and regrows tissues, builds bone and muscle, and strengthens the immune system.\n- **rem**: Rapid Eye Movement sleep, a stage where dreaming occurs, and the brain is very active. It plays a role in memory consolidation and mood regulation.\n- **awake_in_bed**: The state of being awake while still in bed, often occurring before falling asleep or after waking up.\n- **nap**: A short sleep, typically taken during the day, that can help improve alertness and performance.\n- **unknown**: A stage that cannot be classified into any of the known categories, possibly due to insufficient data or anomalies in the sleep pattern.\n\n\n### Sleep Attribution Date\n\nThe sleep date attribution follows two simple rules to determine which date a sleep record should be associated with:\n\n1. **Provider Payload Date**: The primary source of truth is the date provided in the payload from the sleep tracking provider. This date is used if available.\n\n2. **End Date Rule**: If the provider payload date is not available, the sleep date is attributed to the day on which the sleep session ended.\n\nThis straightforward approach ensures consistent date attribution for sleep records, regardless of when the sleep session started or ended.\n\n\n### Main Sleep and Nap\n\nThere are two types of sleep: main sleep and nap. There can be only one main sleep per day, which is the longest sleep period. A nap is a shorter sleep taken during the day and will have a `sleep_duration_nap` value.\n\n\n### Sleep Durations\n\nTotal sleep duration is the sum of the durations of light, deep, and REM sleep stages, while total time in bed also includes time spent awake.\n```\ntotal sleep = light + deep + rem\ntime in bed = total sleep + awake\n```\nNote that nap time is not included in the total sleep time for a day.\nSleep latency refers to the estimated time from when rest begins until the first occurrence of light or deep sleep. The accuracy of sleep stages and latency depends entirely on the provider’s sensors and calculations.\nSleep duration values are reported in milliseconds.", "operationId": "getQueriesSleeps", "parameters": [ { "description": "Start time of the query range in user's local timezone according to the provider, inclusive", "example": "2006-01-02", "explode": false, "in": "query", "name": "from_date", "schema": { "description": "Start time of the query range in user's local timezone according to the provider, inclusive", "examples": [ "2006-01-02" ], "format": "date" } }, { "description": "End time of the query range in user's local timezone according to the provider, inclusive", "example": "2006-01-02", "explode": false, "in": "query", "name": "to_date", "schema": { "description": "End time of the query range in user's local timezone according to the provider, inclusive", "examples": [ "2006-01-02" ], "format": "date" } }, { "description": "Providers", "explode": false, "in": "query", "name": "providers", "schema": { "description": "Providers", "items": { "enum": [ "strava", "health_connect", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "apple", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "samsung_health_data", "luna", "map_my_fitness", "application" ], "type": "string" }, "type": "array" } }, { "description": "Include stages", "explode": false, "in": "query", "name": "include_stages", "schema": { "description": "Include stages", "type": "boolean" } }, { "description": "Include samples", "explode": false, "in": "query", "name": "include_samples", "schema": { "description": "Include samples", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SleepsQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "List Sleeps", "tags": [ "Queries / Sleep" ] } }, "/queries/sleeps/{sleep_id}": { "get": { "description": "This endpoint returns sleep data including different sleep stages that represent the various phases of sleep a person goes through during a sleep cycle. Each stage is characterized by distinct physiological and neurological patterns.\n\nThe different sleep stages are:\n\n- **awake**: The state of being fully conscious and alert.\n- **sleeping**: A general term for being in a state of sleep.\n- **out_of_bed**: The state when a person is not in bed, possibly indicating a brief interruption in sleep.\n- **light**: A stage of sleep where the body begins to relax, and the heart rate slows down. It is easier to wake up from this stage.\n- **deep**: A restorative stage of sleep where the body repairs and regrows tissues, builds bone and muscle, and strengthens the immune system.\n- **rem**: Rapid Eye Movement sleep, a stage where dreaming occurs, and the brain is very active. It plays a role in memory consolidation and mood regulation.\n- **awake_in_bed**: The state of being awake while still in bed, often occurring before falling asleep or after waking up.\n- **nap**: A short sleep, typically taken during the day, that can help improve alertness and performance.\n- **unknown**: A stage that cannot be classified into any of the known categories, possibly due to insufficient data or anomalies in the sleep pattern.\n\n\n### Sleep Attribution Date\n\nThe sleep date attribution follows two simple rules to determine which date a sleep record should be associated with:\n\n1. **Provider Payload Date**: The primary source of truth is the date provided in the payload from the sleep tracking provider. This date is used if available.\n\n2. **End Date Rule**: If the provider payload date is not available, the sleep date is attributed to the day on which the sleep session ended.\n\nThis straightforward approach ensures consistent date attribution for sleep records, regardless of when the sleep session started or ended.\n\n\n### Main Sleep and Nap\n\nThere are two types of sleep: main sleep and nap. There can be only one main sleep per day, which is the longest sleep period. A nap is a shorter sleep taken during the day and will have a `sleep_duration_nap` value.\n\n\n### Sleep Durations\n\nTotal sleep duration is the sum of the durations of light, deep, and REM sleep stages, while total time in bed also includes time spent awake.\n```\ntotal sleep = light + deep + rem\ntime in bed = total sleep + awake\n```\nNote that nap time is not included in the total sleep time for a day.\nSleep latency refers to the estimated time from when rest begins until the first occurrence of light or deep sleep. The accuracy of sleep stages and latency depends entirely on the provider’s sensors and calculations.\nSleep duration values are reported in milliseconds.", "operationId": "getQueriesSleepsBySleepId", "parameters": [ { "description": "Sleep ID", "in": "path", "name": "sleep_id", "required": true, "schema": { "description": "Sleep ID", "type": "string" } }, { "description": "Include stages", "explode": false, "in": "query", "name": "include_stages", "schema": { "description": "Include stages", "type": "boolean" } }, { "description": "Include samples", "explode": false, "in": "query", "name": "include_samples", "schema": { "description": "Include samples", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryOutputSleep" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Get Sleep", "tags": [ "Queries / Sleep" ] } }, "/queries/statistics": { "get": { "description": "This endpoint returns statistics calculated based on the data available for a specific time period. The data is aggregated according to the time interval specified in your request, allowing you to see trends and patterns over time. \n\n\u003cNote\u003e\nRefer to the different statistics types in the [Statistics Types](/technical-references/statistics_matrix) section for more information on how the data is aggregated for each type.\n\u003c/Note\u003e\n\n#### Coordinated Universal Time\n\nThe `/statistics/interval` endpoint uses Coordinated Universal Time (UTC) for all its calculations. This standardization ensures that data is consistent and comparable across different time zones. By using UTC, the API provides a global view of the data, which is crucial for applications that require a uniform time reference. This approach contrasts with the `/statistics/daily` endpoint, which uses the user's local timezone for calculations, offering a more personalized view.\n\n#### Selection of Provider Source\nWithin a single statistics interval there can be data aggregated from one provider source only.\n", "operationId": "getQueriesStatistics", "parameters": [ { "description": "Start time of the query range in UTC", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "schema": { "description": "Start time of the query range in UTC", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "schema": { "description": "End time of the query range in UTC", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "Interval of the query", "explode": false, "in": "query", "name": "interval", "required": true, "schema": { "description": "Interval of the query", "enum": [ "fifteen_minute", "thirty_minute", "hour", "day" ], "type": "string" } }, { "description": "Exclude manual metrics from the statistics", "explode": false, "in": "query", "name": "exclude_manual", "schema": { "default": false, "description": "Exclude manual metrics from the statistics", "type": "boolean" } }, { "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "steps", "distance_total", "distance_walking", "distance_cycling", "distance_running", "calories_burned_basal", "calories_burned_active", "calories_burned_total", "heartrate", "heartrate_max", "heartrate_min", "heartrate_resting", "sleep_skin_temperature_deviation", "hrv_rmssd", "hrv_sdnn", "duration_low_intensity", "duration_moderate_intensity", "duration_high_intensity" ], "type": "string" }, "minItems": 1, "type": "array" } }, { "explode": false, "in": "query", "name": "providers", "schema": { "items": { "enum": [ "strava", "health_connect", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "apple", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "samsung_health_data", "luna", "map_my_fitness", "application" ], "type": "string" }, "type": "array" } }, { "description": "Whether to include the record IDs in the response", "explode": false, "in": "query", "name": "include_record_ids", "schema": { "default": false, "description": "Whether to include the record IDs in the response", "type": "boolean" } }, { "description": "Device types to include in the statistics", "explode": false, "in": "query", "name": "device_types", "schema": { "description": "Device types to include in the statistics", "items": { "enum": [ "unknown", "phone", "watch", "scale", "ring", "head_mounted", "fitness_band", "chest_strap", "smart_display", "accessory" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsIntervalQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Statistics by interval (moved to /statistics/interval)", "tags": [ "Queries / Statistics" ] } }, "/queries/statistics/daily": { "get": { "description": "This endpoint returns daily statistics calculated based on the data available for a specific time period. The data is aggregated for each day based on the user's local timezone.\n\n\u003cNote\u003e\nRefer to the different statistics types in the [Statistics Types](/technical-references/statistics_matrix) section for more information on how the data is aggregated for each type.\n\u003c/Note\u003e\n\n#### User's Local Timezone\n\nThe `/statistics/daily` endpoint uses the user's local timezone for all its calculations. This approach ensures that the data reflects the user's actual daily activity patterns, providing a more personalized view. By using the local timezone, the API tailors the data to the user's specific context, which is particularly useful for applications that focus on individual user experiences. This approach contrasts with the `/statistics/interval` endpoint, which uses Coordinated Universal Time (UTC) for calculations, offering a standardized global view.\n", "operationId": "getQueriesStatisticsDaily", "parameters": [ { "description": "Start time of the query range in user's local timezone according to the provider, inclusive", "example": "2006-01-02", "explode": false, "in": "query", "name": "from_date", "required": true, "schema": { "description": "Start time of the query range in user's local timezone according to the provider, inclusive", "examples": [ "2006-01-02" ], "format": "date" } }, { "description": "End time of the query range in user's local timezone according to the provider, inclusive", "example": "2006-01-02", "explode": false, "in": "query", "name": "to_date", "required": true, "schema": { "description": "End time of the query range in user's local timezone according to the provider, inclusive", "examples": [ "2006-01-02" ], "format": "date" } }, { "description": "Exclude manual metrics from the statistics", "explode": false, "in": "query", "name": "exclude_manual", "schema": { "default": false, "description": "Exclude manual metrics from the statistics", "type": "boolean" } }, { "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "sleep_score", "stress_score", "recovery_score", "activity_score", "steps", "distance_total", "distance_walking", "distance_cycling", "distance_running", "calories_burned_basal", "calories_burned_active", "calories_burned_total", "sleep_duration_total", "heartrate", "heartrate_max", "heartrate_min", "heartrate_resting", "sleep_skin_temperature_deviation", "hrv_rmssd", "hrv_sdnn", "duration_low_intensity", "duration_moderate_intensity", "duration_high_intensity" ], "type": "string" }, "minItems": 1, "type": "array" } }, { "explode": false, "in": "query", "name": "providers", "schema": { "items": { "description": "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" ], "type": "string" }, "type": "array" } }, { "description": "Whether to include the record IDs in the response", "explode": false, "in": "query", "name": "include_record_ids", "schema": { "default": false, "description": "Whether to include the record IDs in the response", "type": "boolean" } }, { "description": "Device types to include in the statistics", "explode": false, "in": "query", "name": "device_types", "schema": { "description": "Device types to include in the statistics", "items": { "enum": [ "unknown", "phone", "watch", "scale", "ring", "head_mounted", "fitness_band", "chest_strap", "smart_display", "accessory" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsDailyQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Daily Statistics", "tags": [ "Queries / Statistics" ] } }, "/queries/statistics/interpolation": { "get": { "operationId": "getQueriesStatisticsInterpolation", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "Interval of the query", "explode": false, "in": "query", "name": "interval", "schema": { "description": "Interval of the query", "enum": [ "5m", "15m", "30m", "1h" ], "type": "string" } }, { "description": "Exclude manual metrics from the statistics", "explode": false, "in": "query", "name": "exclude_manual", "schema": { "default": false, "description": "Exclude manual metrics from the statistics", "type": "boolean" } }, { "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "steps", "distance_total", "distance_walking", "distance_cycling", "distance_running", "calories_burned_basal", "calories_burned_active", "calories_burned_total", "heartrate", "heartrate_max", "heartrate_min", "heartrate_resting", "sleep_skin_temperature_deviation", "hrv_rmssd", "hrv_sdnn", "duration_low_intensity", "duration_moderate_intensity", "duration_high_intensity" ], "type": "string" }, "minItems": 1, "type": "array" } }, { "explode": false, "in": "query", "name": "providers", "schema": { "items": { "enum": [ "strava", "health_connect", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "apple", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "samsung_health_data", "luna", "map_my_fitness", "application" ], "type": "string" }, "type": "array" } }, { "description": "Whether to include the record IDs in the response", "explode": false, "in": "query", "name": "include_record_ids", "schema": { "default": false, "description": "Whether to include the record IDs in the response", "type": "boolean" } }, { "description": "Device types to include in the statistics", "explode": false, "in": "query", "name": "device_types", "schema": { "description": "Device types to include in the statistics", "items": { "enum": [ "unknown", "phone", "watch", "scale", "ring", "head_mounted", "fitness_band", "chest_strap", "smart_display", "accessory" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsInterpolationQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Statistics by interpolation", "tags": [ "Queries / Statistics" ] } }, "/queries/statistics/interval": { "get": { "description": "This endpoint returns statistics calculated based on the data available for a specific time period. The data is aggregated according to the time interval specified in your request, allowing you to see trends and patterns over time. \n\n\u003cNote\u003e\nRefer to the different statistics types in the [Statistics Types](/technical-references/statistics_matrix) section for more information on how the data is aggregated for each type.\n\u003c/Note\u003e\n\n#### Coordinated Universal Time\n\nThe `/statistics/interval` endpoint uses Coordinated Universal Time (UTC) for all its calculations. This standardization ensures that data is consistent and comparable across different time zones. By using UTC, the API provides a global view of the data, which is crucial for applications that require a uniform time reference. This approach contrasts with the `/statistics/daily` endpoint, which uses the user's local timezone for calculations, offering a more personalized view.\n\n#### Selection of Provider Source\nWithin a single statistics interval there can be data aggregated from one provider source only.\n", "operationId": "getQueriesStatisticsInterval", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "required": true, "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "required": true, "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "Interval of the query", "explode": false, "in": "query", "name": "interval", "required": true, "schema": { "description": "Interval of the query", "enum": [ "1h" ], "type": "string" } }, { "description": "Exclude manual metrics from the statistics", "explode": false, "in": "query", "name": "exclude_manual", "schema": { "default": false, "description": "Exclude manual metrics from the statistics", "type": "boolean" } }, { "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "steps", "distance_total", "distance_walking", "distance_cycling", "distance_running", "calories_burned_basal", "calories_burned_active", "calories_burned_total", "heartrate", "heartrate_max", "heartrate_min", "heartrate_resting", "sleep_skin_temperature_deviation", "hrv_rmssd", "hrv_sdnn", "duration_low_intensity", "duration_moderate_intensity", "duration_high_intensity" ], "type": "string" }, "minItems": 1, "type": "array" } }, { "explode": false, "in": "query", "name": "providers", "schema": { "items": { "enum": [ "strava", "health_connect", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "apple", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "samsung_health_data", "luna", "map_my_fitness", "application" ], "type": "string" }, "type": "array" } }, { "description": "Whether to include the record IDs in the response", "explode": false, "in": "query", "name": "include_record_ids", "schema": { "default": false, "description": "Whether to include the record IDs in the response", "type": "boolean" } }, { "description": "Device types to include in the statistics", "explode": false, "in": "query", "name": "device_types", "schema": { "description": "Device types to include in the statistics", "items": { "enum": [ "unknown", "phone", "watch", "scale", "ring", "head_mounted", "fitness_band", "chest_strap", "smart_display", "accessory" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsIntervalQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Interval Statistics", "tags": [ "Queries / Statistics" ] } }, "/queries/timeseries": { "get": { "description": "This endpoint returns a time series for a given metric with automatic merge strategy selection. The system chooses the optimal merge method based on metric characteristics to ensure the best data quality without manual configuration.\n\n## Request Example\n\n```json\n{\n \"from_timestamp\": \"2024-01-01T00:00:00Z\",\n \"to_timestamp\": \"2024-01-02T00:00:00Z\",\n \"metric\": \"heartrate\"\n}\n```\n\n## Response Example\n\n```json\n{\n \"metric\": \"heartrate\",\n \"start_at\": \"2024-01-01T00:00:00Z\",\n \"offsets\": [0, 60000, 120000],\n \"durations\": [60000, 60000, 60000],\n \"values\": [100, 150, 200],\n \"providers\": [\"garmin\"]\n}\n```\n\n\u003cNote\u003e\nThe arrays `offsets`, `durations`, and `values` will all be of the same length. This alignment is crucial for interpreting the data correctly.\n\u003c/Note\u003e\n\n## Overriding the Default Merge Method\n\nTo override the default merge strategy, use the `merge_method` parameter.\n\n\u003cNote\u003e\nThe default merge method is automatically selected based on the metric type and provides optimal data quality for most use cases. Only override the default if you have specific requirements that cannot be met by the automatic selection. This parameter is intended for advanced users who understand the implications of different merge strategies.\n\u003c/Note\u003e\n\n\n### Source Selection Methods\n\nSelects data from a single best provider source based on criteria like coverage, granularity, or priority. Only one source contributes to the final result, ensuring consistency but potentially losing data from other sources.\n\n\n- **`select_best_weighted_source`**: Best weighted coverage score mix of time coverage and data point density\n\n- **`select_highest_coverage_source`**: Highest total time coverage (sum of all entry durations)\n\n- **`select_most_granular_source`**: Most data points (highest entry count)\n\n- **`select_highest_priority_source_type`**: Sample \u0026gt; Intraday \u0026gt; Summary \u0026gt; Activity priority, then weighted coverage\n\n\n### Coverage Optimization Methods\n\nMaximizes time coverage by selecting non-overlapping entries from multiple sources. Prioritizes filling time gaps while avoiding overlaps, using interval scheduling algorithms.\n\n\n- **`merge_maximize_coverage`**: Weighted interval scheduling to maximize total time coverage\n\n- **`merge_maximize_granularity`**: Source with most data points, then greedy interval scheduling\n\n- **`merge_maximize_weighted_coverage`**: Source with best weighted coverage score, then greedy interval scheduling\n\n\n### Sample Merging Methods\n\nCombines all sample data points, resolving conflicts at identical timestamps by selecting the source with the most total entries. Preserves all available data while handling timestamp collisions.\n\n\n- **`merge_all_samples`**: All zero-duration samples, conflicts resolved by source with most total entries\n\n", "operationId": "getQueriesTimeseries", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "The metric you want to query", "explode": false, "in": "query", "name": "metric", "required": true, "schema": { "description": "The metric you want to query", "enum": [ "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" ], "type": "string" } }, { "explode": false, "in": "query", "name": "providers", "schema": { "items": { "enum": [ "strava", "health_connect", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "apple", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "samsung_health_data", "luna", "map_my_fitness", "application" ], "type": "string" }, "type": "array" } }, { "description": "Whether to include the record IDs in the response", "explode": false, "in": "query", "name": "include_record_ids", "schema": { "description": "Whether to include the record IDs in the response", "type": "boolean" } }, { "description": "Method to merge data", "explode": false, "in": "query", "name": "merge_method", "schema": { "description": "Method to merge data", "enum": [ "select_best_weighted_source", "select_highest_coverage_source", "select_most_granular_source", "select_highest_priority_source_type", "merge_maximize_coverage", "merge_maximize_granularity", "merge_maximize_weighted_coverage", "merge_all_samples" ], "type": "string" } }, { "description": "Device types to include", "explode": false, "in": "query", "name": "device_types", "schema": { "description": "Device types to include", "items": { "enum": [ "unknown", "phone", "watch", "scale", "ring", "head_mounted", "fitness_band", "chest_strap", "smart_display", "accessory" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeseriesMergedQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Time Series", "tags": [ "Queries / Time Series" ] } }, "/queries/timeseries/samples": { "get": { "description": "This endpoint returns only sample data points (individual measurements) from time series data, excluding any aggregated data. Uses the `merge_all_samples` merge method to combine data from multiple sources while preserving individual sample points.\n\n\u003cNote\u003e\nThe arrays `offsets`, `durations`, and `values` will all be of the same length. This alignment is crucial for interpreting the data correctly.\n\u003c/Note\u003e\n\n## Data Filtering\n\nThis endpoint returns only **sample** data points, meaning:\n- Individual measurements with zero duration (instantaneous readings)\n- No aggregated data (daily summaries, hourly averages, etc.)\n- Data is merged from all available sources using the `merge_all_samples` method\n\n## Request Example\n\n```json\n{\n \"from_timestamp\": \"2024-01-01T00:00:00Z\",\n \"to_timestamp\": \"2024-01-02T00:00:00Z\",\n \"metric\": \"heartrate\",\n \"include_record_ids\": true\n}\n```\n\n## Response Example\n\n```json\n{\n \"metric\": \"heartrate\",\n \"start_at\": \"2024-01-01T00:00:00Z\",\n \"offsets\": [0, 60000, 120000],\n \"values\": [100, 150, 200],\n \"record_ids\": [\"ff000000-0000-0000-0000-000000000000\"],\n \"providers\": [\"apple\"],\n \"provider_sources\": [\"apple_healthkit_sample\"]\n}\n```\n\n\u003cNote\u003e\nFor sample data, the `durations` field is omitted from the response since all sample points have zero duration.\n\u003c/Note\u003e ", "operationId": "getQueriesTimeseriesSamples", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "The metric you want to query", "explode": false, "in": "query", "name": "metric", "required": true, "schema": { "description": "The metric you want to query", "enum": [ "heartrate", "heartrate_resting", "hrv_rmssd", "hrv_sdnn", "floors_climbed", "speed", "air_temperature", "spo2", "breathing_rate", "elevation", "sleep_breathing_rate", "cadence", "body_mass_index", "weight", "height", "vo2max", "body_temperature", "basal_body_temperature", "skin_temperature", "body_fat", "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" ], "type": "string" } }, { "explode": false, "in": "query", "name": "providers", "schema": { "items": { "enum": [ "strava", "health_connect", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "apple", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "samsung_health_data", "luna", "map_my_fitness", "application" ], "type": "string" }, "type": "array" } }, { "description": "Whether to include the record IDs in the response", "explode": false, "in": "query", "name": "include_record_ids", "schema": { "description": "Whether to include the record IDs in the response", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeseriesMergedQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Get Samples Time Series", "tags": [ "Queries / Time Series" ] } }, "/queries/timeseries/split": { "get": { "description": "This endpoint returns time series data separated by provider source, allowing you to see data from each source individually without merging. Each time series entry contains arrays of `offsets`, `durations`, and `values` that are aligned by index.\n\n\u003cNote\u003e\nThe arrays `offsets`, `durations`, and `values` will all be of the same length. This alignment is crucial for interpreting the data correctly.\n\u003c/Note\u003e\n\n## Response Structure\n\nThe response contains a `timeseries` array where each entry represents data from a specific provider source, including:\n- **Provider information**: The specific provider slug\n- **Division type**: The type of data division (sample, activity, etc.)\n- **Source details**: Device manufacturer, model, and other source information\n- **Data arrays**: Offsets, durations, and values for the time series\n\n## Request Example\n\n```json\n{\n \"from_timestamp\": \"2024-01-01T00:00:00Z\",\n \"to_timestamp\": \"2024-01-02T00:00:00Z\",\n \"metric\": \"heartrate\",\n \"include_record_ids\": true\n}\n```\n\n## Response Example\n\n```json\n{\n \"timeseries\": [\n {\n \"metric\": \"heartrate\",\n \"start_at\": \"2024-01-01T00:00:00Z\",\n \"offsets\": [43200000, 46800000],\n \"durations\": [2400000, 600000],\n \"values\": [71, 76],\n \"provider\": \"apple\",\n \"division_type\": \"sample\",\n \"record_ids\": [\"ff000000-0000-0000-0000-000000000000\"],\n \"source\": {\n \"device_manufacturer\": \"Apple\",\n \"device_model\": \"iPhone 15\"\n }\n }\n ]\n}\n```\n\n", "operationId": "getQueriesTimeseriesSplit", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "The metric you want to query", "explode": false, "in": "query", "name": "metric", "required": true, "schema": { "description": "The metric you want to query", "enum": [ "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" ], "type": "string" } }, { "explode": false, "in": "query", "name": "providers", "schema": { "items": { "enum": [ "strava", "health_connect", "fitbit", "garmin", "huawei", "dexcom", "whoop", "withings", "suunto", "google_health", "apple", "freestyle_libre", "oura", "polar", "coros", "ultrahuman", "samsung_health_data", "luna", "map_my_fitness", "application" ], "type": "string" }, "type": "array" } }, { "description": "Whether to include the record IDs in the response", "explode": false, "in": "query", "name": "include_record_ids", "schema": { "default": false, "description": "Whether to include the record IDs in the response", "type": "boolean" } }, { "description": "Device types to include in the statistics", "explode": false, "in": "query", "name": "device_types", "schema": { "description": "Device types to include in the statistics", "items": { "enum": [ "unknown", "phone", "watch", "scale", "ring", "head_mounted", "fitness_band", "chest_strap", "smart_display", "accessory" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeseriesSplitQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Time Series Data split by provider source", "tags": [ "Queries / Time Series" ] } }, "/queries/workouts": { "get": { "description": "This endpoint returns a list of workouts for a user, including various types of physical activities and exercises. Workouts represent structured physical activities that can be tracked and analyzed for fitness and health purposes.\n\n### Workout Types\n\nWorkouts encompass a wide variety of physical activities. For a complete list of available workout types, see the [Activity Types](/api-docs/activity_matrix) documentation.\n\n### Workout Structure\n\nEach workout contains:\n- **Base Information**: Start time, end time, duration, and provider details\n- **Activity Details**: Workout type, name, tags, and unique identifier\n- **Metrics**: Distance, calories, heart rate, pace, and other relevant measurements\n- **Optional Components**: Sessions, laps, samples, route points, splits, and segments\n\n### Data Inclusion Options\n\nThe endpoint supports various inclusion parameters to customize the response:\n- **Sessions**: Include workout session breakdowns\n- **Laps**: Include lap-by-lap data for structured activities\n- **Samples**: Include detailed time-series data points\n- **Route Points**: Include GPS coordinates and route information\n- **Splits**: Include split times for timed activities\n- **Segments**: Include segment breakdowns for complex workouts\n\n### Activity Tags\n\nWorkouts are categorized using activity tags that help classify the type of activity. For a complete list of available activity tags, see the [Activity Types](/api-docs/activity_matrix) documentation.\n\nAll timestamps in both request and response are in the UTC timezone.\n", "operationId": "getQueriesWorkouts", "parameters": [ { "description": "Start time of the query range in UTC, inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "from_timestamp", "schema": { "description": "Start time of the query range in UTC, inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "End time of the query range in UTC, non-inclusive", "example": "2006-01-02T15:04:05", "explode": false, "in": "query", "name": "to_timestamp", "schema": { "description": "End time of the query range in UTC, non-inclusive", "examples": [ "2006-01-02T15:04:05", "2006-01-02T15:04:05Z" ], "format": "date-time" } }, { "description": "Providers", "explode": false, "in": "query", "name": "providers", "schema": { "description": "Providers", "items": { "description": "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" ], "type": "string" }, "type": [ "array", "null" ] } }, { "description": "Activity tags", "explode": false, "in": "query", "name": "activity_tags", "schema": { "description": "Activity tags", "items": { "description": "Activity tags", "enum": [ "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" ], "type": "string" }, "type": [ "array", "null" ] } }, { "description": "Activity types", "explode": false, "in": "query", "name": "activity_types", "schema": { "description": "Activity types", "items": { "description": "Activity types", "enum": [ "aerobics", "play", "house_work", "gardening", "work", "workout", "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", "mindfulness_session" ], "type": "string" }, "type": [ "array", "null" ] } }, { "description": "Include sessions", "explode": false, "in": "query", "name": "include_sessions", "schema": { "description": "Include sessions", "type": "boolean" } }, { "description": "Include laps", "explode": false, "in": "query", "name": "include_laps", "schema": { "description": "Include laps", "type": "boolean" } }, { "description": "Include samples", "explode": false, "in": "query", "name": "include_samples", "schema": { "description": "Include samples", "type": "boolean" } }, { "description": "Include route points", "explode": false, "in": "query", "name": "include_route_points", "schema": { "description": "Include route points", "type": "boolean" } }, { "description": "Include splits", "explode": false, "in": "query", "name": "include_splits", "schema": { "description": "Include splits", "type": "boolean" } }, { "description": "Include segments", "explode": false, "in": "query", "name": "include_segments", "schema": { "description": "Include segments", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkoutsQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "List Workouts", "tags": [ "Queries / Workouts" ] } }, "/queries/workouts/{workout_id}": { "get": { "description": "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.\n\n### Workout Details\n\nA single workout contains complete information about the activity:\n\n- **Base Information**: Start time, end time, duration, user time offset, input method, and source provider\n- **Activity Metadata**: Workout ID, name, type, and associated tags\n- **Metrics**: Base metrics (distance, calories, duration) and provider-specific metrics\n- **Detailed Breakdowns**: Sessions, laps, splits, segments, and route information\n- **Sample Data**: Time-series data points with offsets, durations, and values\n\n### Data Components\n\nThe endpoint supports various inclusion parameters to customize the response:\n\n- **Sessions**: Include workout session breakdowns with detailed metrics\n- **Laps**: Include lap-by-lap data for structured activities with lap numbers\n- **Samples**: Include detailed time-series data points with metric values\n- **Route Points**: Include GPS coordinates and elevation data for route visualization\n- **Splits**: Include split times and metrics for timed activities\n- **Segments**: Include segment breakdowns for complex workouts\n\n### Sample Data Structure\n\nWhen samples are included, the response contains time-series data with:\n- **Offsets**: Time offsets from the workout start in milliseconds\n- **Durations**: Duration of each data point in milliseconds\n- **Values**: Metric values organized by metric type (heart rate, pace, etc.)\n\n### Route Information\n\nRoute points provide GPS and location data:\n- **Latitude/Longitude**: Geographic coordinates for route visualization\n- **Elevation**: Altitude data when available\n- **Timing**: Precise timing information for each route point\n\n### Activity Breakdowns\n\nComplex workouts may include multiple breakdowns:\n- **Sessions**: Different phases or segments of the workout\n- **Laps**: Individual laps for track or structured activities\n- **Splits**: Time splits for performance analysis\n- **Segments**: Custom segments defined by the activity\n\nAll timestamps in the response are in the UTC timezone.\n", "operationId": "getQueriesWorkoutsByWorkoutId", "parameters": [ { "description": "Workout ID", "in": "path", "name": "workout_id", "required": true, "schema": { "description": "Workout ID", "type": "string" } }, { "description": "Include sessions", "explode": false, "in": "query", "name": "include_sessions", "schema": { "description": "Include sessions", "type": "boolean" } }, { "description": "Include laps", "explode": false, "in": "query", "name": "include_laps", "schema": { "description": "Include laps", "type": "boolean" } }, { "description": "Include samples", "explode": false, "in": "query", "name": "include_samples", "schema": { "description": "Include samples", "type": "boolean" } }, { "description": "Include route points", "explode": false, "in": "query", "name": "include_route_points", "schema": { "description": "Include route points", "type": "boolean" } }, { "description": "Include splits", "explode": false, "in": "query", "name": "include_splits", "schema": { "description": "Include splits", "type": "boolean" } }, { "description": "Include segments", "explode": false, "in": "query", "name": "include_segments", "schema": { "description": "Include segments", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkoutQueryOutput" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "422": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unprocessable Entity" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "Get Workout", "tags": [ "Queries / Workouts" ] } }, "/userinfo": { "get": { "description": "Get information about the current user.", "operationId": "getUserinfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInfo" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "User Information", "tags": [ "Info / User" ] } }, "/userproperties": { "get": { "description": "Get information about the current user.", "operationId": "getUserproperties", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPropertiesResponseBody" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Not Found" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "Internal Server Error" } }, "security": [ { "bearer": [] } ], "summary": "User Properties", "tags": [ "Info / User" ] } } }, "servers": [ { "url": "https://app-api.spikeapi.com/v3" } ] }