Skip to main content

User Summary

Each user has a list of user summaries. User Summary is an object that represents the activity of the user during the day.

date
required
string

required, date_format:Y-m-d

activity
object

array, filled

activity.date
string

required_with:activity, date_format:Y-m-d

activity.total_steps
integer

required_with:activity, integer

activity.daily_percent
integer

required_with:activity, integer

activity.distance
double

required_with:activity, numeric

activity.calories
integer

required_with:activity, integer

activity.workouts
integer

required_with:activity, integer

activity.active_minutes
integer

required_with:activity, integer

activity.move_every_hour
integer

required_with:activity, integer

activity.avg_gait_asymmetry
double

nullable, numeric

activity.avg_gait_speed
double

nullable, numeric

activity.avg_gait_var
double

nullable, numeric

activity.total_glasses
integer

nullable, integer, min:0

activity.slots
object

required_with:activity, array

activity.slots.0.timestamp
integer

required_with:activity.slots, integer

activity.slots.0.date
string

required_with:activity.slots, date_format:H:i

activity.slots.0.step_count
integer

required_with:activity.slots, integer

activity.slots_five_minutes
object

array

activity.slots_five_minutes.0.timestamp
integer

required_with:activity.slots_five_minutes, integer

activity.slots_five_minutes.0.date
string

required_with:activity.slots_five_minutes, date_format:H:i

activity.slots_five_minutes.0.step_count
integer

required_with:activity.slots_five_minutes, integer

heart_rate
object

array, filled

heart_rate.date
string

required_with:heart_rate, date_format:Y-m-d

heart_rate.avg_daily_heart_rate
integer

nullable, present_without:heart_rate.avg_daily_heat_rate, integer

heart_rate.max_daily_heart_rate
integer

nullable, present_without:heart_rate.max_daily_heat_rate, integer

heart_rate.rest_daily_heart_rate
integer

nullable, present_without:heart_rate.rest_daily_heat_rate, integer

heart_rate.avg_daily_heat_rate
integer

nullable, present_without:heart_rate.avg_daily_heart_rate, integer

heart_rate.max_daily_heat_rate
integer

nullable, present_without:heart_rate.max_daily_heart_rate, integer

heart_rate.rest_daily_heat_rate
integer

nullable, present_without:heart_rate.rest_daily_heart_rate, integer

heart_rate.daily_percent
integer

nullable, present_with:heart_rate, integer

heart_rate.all_time
integer

required_with:heart_rate, integer

heart_rate.max_time
integer

required_with:heart_rate, integer

heart_rate.performance_time
integer

required_with:heart_rate, integer

heart_rate.endurance_time
integer

required_with:heart_rate, integer

heart_rate.fat_burn_time
integer

required_with:heart_rate, integer

heart_rate.warm_up_time
integer

required_with:heart_rate, integer

heart_rate.rest_time
integer

required_with:heart_rate, integer

heart_rate.slots
object

required_with:heart_rate, array

heart_rate.slots.0.timestamp
integer

required_with:heart_rate.slots, integer

heart_rate.slots.0.date
string

required_with:heart_rate.slots, date_format:H:i

heart_rate.slots.0.bpm
integer

nullable, present_with:heart_rate.slots, integer

heart_rate.slots.0.is_wearing
boolean

nullable, boolean

heart_rate.slots.0.is_charging
boolean

nullable, boolean

heart_rate.slots.0.is_low_battery
boolean

nullable, boolean

sleep
object

array, filled

sleep.date
string

required_with:sleep, date_format:Y-m-d

sleep.sleep_duration
integer

required_with:sleep, integer

sleep.daily_percent
integer

required_with:sleep, integer

sleep.awake_time
integer

required_with:sleep, integer

sleep.rem_time
integer

required_with:sleep, integer

sleep.light_time
integer

required_with:sleep, integer

sleep.deep_time
integer

required_with:sleep, integer

sleep.performance
integer

required_with:sleep, integer

sleep.tranquility
integer

required_with:sleep, integer

sleep.consistency
integer

filled, nullable, integer

sleep.heart_rate
integer

nullable, integer

sleep.heart_rate_quality
integer

nullable, integer

sleep.time_to_sleep
integer

nullable, integer

sleep.time_to_wake_up
integer

nullable, integer

sleep.start_session_original_ph
string

nullable, date_format:Y-m-d\TH:i:s.vP

sleep.stop_session_original_ph
string

nullable, date_format:Y-m-d\TH:i:s.vP

sleep.slots
object

required_with:sleep, array

sleep.slots.0.timestamp
integer

required_with:sleep.slots, integer

sleep.slots.0.start_date
string

required_with:sleep.slots, date_format:Y-m-d\TH:i:s

sleep.slots.0.end_date
string

required_with:sleep.slots, date_format:Y-m-d\TH:i:s

sleep.slots.0.type
integer

required_with:sleep.slots, integer, in:0,1,2,3,4

corsano_sleep
object

array, filled

corsano_sleep.date
string

required_with:corsano_sleep, date_format:Y-m-d

corsano_sleep.sleep_duration
integer

required_with:corsano_sleep, integer

corsano_sleep.daily_percent
integer

required_with:corsano_sleep, integer

corsano_sleep.awake_time
integer

required_with:corsano_sleep, integer

corsano_sleep.rem_time
integer

required_with:corsano_sleep, integer

corsano_sleep.light_time
integer

required_with:corsano_sleep, integer

corsano_sleep.deep_time
integer

required_with:corsano_sleep, integer

corsano_sleep.performance
integer

required_with:corsano_sleep, integer

corsano_sleep.tranquility
integer

required_with:corsano_sleep, integer

corsano_sleep.consistency
integer

required_with:corsano_sleep, integer

corsano_sleep.heart_rate
integer

required_with:corsano_sleep, integer

corsano_sleep.heart_rate_quality
integer

required_with:corsano_sleep, integer

corsano_sleep.time_to_sleep
integer

nullable, integer

corsano_sleep.time_to_wake_up
integer

nullable, integer

corsano_sleep.slots
object

required_with:corsano_sleep, array

corsano_sleep.slots.0.timestamp
integer

required_with:corsano_sleep.slots, integer

corsano_sleep.slots.0.start_date
string

required_with:corsano_sleep.slots, date_format:Y-m-d\TH:i:s

corsano_sleep.slots.0.end_date
string

required_with:corsano_sleep.slots, date_format:Y-m-d\TH:i:s

corsano_sleep.slots.0.type
integer

required_with:corsano_sleep.slots, integer, in:0,1,2,3,4

stress
object

array, filled

stress.date
string

required_with:stress, date_format:Y-m-d

stress.avg_si
double

required_with:stress, numeric

stress.avg_si_n
double

required_with:stress, numeric

stress.avg_mrr
double

required_with:stress, numeric

stress.avg_sdnn
double

required_with:stress, numeric

stress.avg_rmssd
double

required_with:stress, numeric

stress.avg_pnn50
double

required_with:stress, numeric

stress.avg_vlf
double

required_with:stress, numeric

stress.avg_vlf_percent
double

required_with:stress, numeric

stress.avg_lf
double

required_with:stress, numeric

stress.avg_lf_percent
double

required_with:stress, numeric

stress.avg_hf
double

required_with:stress, numeric

stress.avg_hf_percent
double

required_with:stress, numeric

stress.avg_hrv
double

required_with:stress, numeric

stress.slots
object

required_with:stress, array

stress.slots.0.timestamp
integer

required_with:stress.slots, integer

stress.slots.0.date
string

required_with:stress.slots, date_format:H:i

stress.slots.0.si
double

required_with:stress.slots, numeric

stress.slots.0.si_n
double

required_with:stress.slots, numeric

stress.slots.0.mrr
double

required_with:stress.slots, numeric

stress.slots.0.sdnn
double

required_with:stress.slots, numeric

stress.slots.0.rmssd
double

required_with:stress.slots, numeric

stress.slots.0.pnn50
double

required_with:stress.slots, numeric

stress.slots.0.vlf
double

required_with:stress.slots, numeric

stress.slots.0.vlf_percent
double

required_with:stress.slots, numeric

stress.slots.0.lf
double

required_with:stress.slots, numeric

stress.slots.0.lf_percent
double

required_with:stress.slots, numeric

stress.slots.0.hf
double

required_with:stress.slots, numeric

stress.slots.0.hf_percent
double

required_with:stress.slots, numeric

stress.slots.0.hrv
double

required_with:stress.slots, numeric

respiration_rate
object

array, filled

respiration_rate.date
string

required_with:respiration_rate, date_format:Y-m-d

respiration_rate.avg_respiration_rate
double

required_with:respiration_rate, numeric

respiration_rate.start_timestamp
integer

required_with:respiration_rate, integer

respiration_rate.end_timestamp
integer

required_with:respiration_rate, integer

respiration_rate.slots
object

required_with:respiration_rate, array

respiration_rate.slots.0.timestamp
integer

required_with:respiration_rate.slots, integer

respiration_rate.slots.0.date
string

required_with:respiration_rate.slots, date_format:H:i

respiration_rate.slots.0.respiration_rate
double

required_with:respiration_rate.slots, numeric

respiration_rate.slots.0.quality
double

required_with:respiration_rate.slots, numeric

respiration_rate.slots.0.is_wearing
boolean

nullable, boolean

respiration_rate.slots.0.is_charging
boolean

nullable, boolean

respiration_rate.slots.0.is_low_battery
boolean

nullable, boolean

respiration_rate.slots_five_minutes
object

array

respiration_rate.slots_five_minutes.0.timestamp
integer

required_with:respiration_rate.slots_five_minutes, integer

respiration_rate.slots_five_minutes.0.date
string

required_with:respiration_rate.slots_five_minutes, date_format:H:i

respiration_rate.slots_five_minutes.0.respiration_rate
double

required_with:respiration_rate.slots_five_minutes, numeric

respiration_rate.slots_five_minutes.0.quality
double

required_with:respiration_rate.slots_five_minutes, numeric

respiration_rate.slots_five_minutes.0.is_wearing
boolean

nullable, boolean

respiration_rate.slots_five_minutes.0.is_charging
boolean

nullable, boolean

respiration_rate.slots_five_minutes.0.is_low_battery
boolean

nullable, boolean

temperature
object

array, filled

temperature.date
string

required_with:temperature, date_format:Y-m-d

temperature.avg_temp_sk1
double

nullable, present_with:temperature, numeric

temperature.avg_temp_sk2
double

nullable, present_with:temperature, numeric

temperature.max_temp_sk1
double

nullable, numeric

temperature.max_temp_sk2
double

nullable, numeric

temperature.start_timestamp
integer

required_with:temperature, integer

temperature.end_timestamp
integer

required_with:temperature, integer

temperature.slots
object

required_with:temperature, array

temperature.slots.0.timestamp
integer

required_with:temperature.slots, integer

temperature.slots.0.date
string

required_with:temperature.slots, date_format:H:i

temperature.slots.0.temp_sk1
double

nullable, present_with:temperature.slots, numeric

temperature.slots.0.temp_sk2
double

nullable, present_with:temperature.slots, numeric

temperature.slots.0.is_wearing
boolean

nullable, boolean

temperature.slots.0.is_charging
boolean

nullable, boolean

temperature.slots.0.is_low_battery
boolean

nullable, boolean

temperature.slots_five_minutes
object

array

temperature.slots_five_minutes.0.timestamp
integer

required_with:temperature.slots_five_minutes, integer

temperature.slots_five_minutes.0.date
string

required_with:temperature.slots_five_minutes, date_format:H:i

temperature.slots_five_minutes.0.temp_sk1
double

nullable, present_with:temperature.slots_five_minutes, numeric

temperature.slots_five_minutes.0.temp_sk2
double

nullable, present_with:temperature.slots_five_minutes, numeric

temperature.slots_five_minutes.0.is_wearing
boolean

nullable, boolean

temperature.slots_five_minutes.0.is_charging
boolean

nullable, boolean

temperature.slots_five_minutes.0.is_low_battery
boolean

nullable, boolean

spo2
object

array, filled

spo2.date
string

required_with:spo2, date_format:Y-m-d

spo2.avg_spo2
integer

nullable, present_with:spo2, integer

spo2.start_timestamp
integer

required_with:spo2, integer

spo2.end_timestamp
integer

required_with:spo2, integer

spo2.slots
object

required_with:spo2, array

spo2.slots.0.timestamp
integer

required_with:spo2.slots, integer

spo2.slots.0.date
string

required_with:spo2.slots, date_format:H:i

spo2.slots.0.spo2
integer

nullable, present_with:spo2.slots, integer

spo2.slots.0.spo2_q
integer

nullable, present_with:spo2.slots, integer

spo2.slots.0.is_wearing
boolean

nullable, boolean

spo2.slots.0.is_charging
boolean

nullable, boolean

spo2.slots.0.is_low_battery
boolean

nullable, boolean

spo2.slots_five_minutes
object

array

spo2.slots_five_minutes.0.timestamp
integer

required_with:spo2.slots_five_minutes, integer

spo2.slots_five_minutes.0.date
string

required_with:spo2.slots_five_minutes, date_format:H:i

spo2.slots_five_minutes.0.spo2
integer

nullable, present_with:spo2.slots_five_minutes, integer

spo2.slots_five_minutes.0.spo2_q
integer

nullable, present_with:spo2.slots_five_minutes, integer

spo2.slots_five_minutes.0.is_wearing
boolean

nullable, boolean

spo2.slots_five_minutes.0.is_charging
boolean

nullable, boolean

spo2.slots_five_minutes.0.is_low_battery
boolean

nullable, boolean

non_invasive_blood_pressure
object

array, filled

non_invasive_blood_pressure.date
string

required_with:non_invasive_blood_pressure, date_format:Y-m-d

non_invasive_blood_pressure.daily_average_systolic_pressure
integer

nullable, integer

non_invasive_blood_pressure.daily_average_diastolic_pressure
integer

nullable, integer

non_invasive_blood_pressure.sleeping_average_systolic_pressure
integer

nullable, integer

non_invasive_blood_pressure.sleeping_average_diastolic_pressure
integer

nullable, integer

non_invasive_blood_pressure.awaken_average_systolic_pressure
integer

nullable, integer

non_invasive_blood_pressure.awaken_average_diastolic_pressure
integer

nullable, integer

non_invasive_blood_pressure.slots
object

required_with:non_invasive_blood_pressure, array

non_invasive_blood_pressure.slots.0.start_timestamp
integer

required_with:non_invasive_blood_pressure.slots, integer

non_invasive_blood_pressure.slots.0.end_timestamp
integer

required_with:non_invasive_blood_pressure.slots, integer

non_invasive_blood_pressure.slots.0.start_date
string

required_with:non_invasive_blood_pressure.slots, date_format:H:i

non_invasive_blood_pressure.slots.0.end_date
string

required_with:non_invasive_blood_pressure.slots, date_format:H:i

non_invasive_blood_pressure.slots.0.systolic_pressure_combine
integer

nullable, integer

non_invasive_blood_pressure.slots.0.diastolic_pressure_combine
integer

nullable, integer

{
  • "date": "2018-09-10",
  • "sleep": {
    }
}