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

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.total_glasses
integer

nullable, integer, min:0

activity.slots
object

required_with:activity, array

activity.slots.*.timestamp
required
integer

required, integer

activity.slots.*.date
required
string

required, date_format:H:i

activity.slots.*.step_count
required
integer

required, 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.*.timestamp
required
integer

required, integer

heart_rate.slots.*.date
required
string

required, date_format:H:i

heart_rate.slots.*.bpm
integer

nullable, present, integer

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.slots
object

required_with:sleep, array

sleep.slots.*.timestamp
required
integer

required, integer

sleep.slots.*.start_date
required
string

required, date_format:Y-m-d\TH:i:s

sleep.slots.*.end_date
required
string

required, date_format:Y-m-d\TH:i:s

sleep.slots.*.type
required
integer

required, 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.*.timestamp
required
integer

required, integer

stress.slots.*.date
required
string

required, date_format:H:i

stress.slots.*.si
required
double

required, numeric

stress.slots.*.si_n
required
double

required, numeric

stress.slots.*.mrr
required
double

required, numeric

stress.slots.*.sdnn
required
double

required, numeric

stress.slots.*.rmssd
required
double

required, numeric

stress.slots.*.pnn50
required
double

required, numeric

stress.slots.*.vlf
required
double

required, numeric

stress.slots.*.vlf_percent
required
double

required, numeric

stress.slots.*.lf
required
double

required, numeric

stress.slots.*.lf_percent
required
double

required, numeric

stress.slots.*.hf
required
double

required, numeric

stress.slots.*.hf_percent
required
double

required, numeric

stress.slots.*.hrv
required
double

required, 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.*.timestamp
required
integer

required, integer

respiration_rate.slots.*.date
required
string

required, date_format:H:i

respiration_rate.slots.*.respiration_rate
required
double

required, numeric

respiration_rate.slots.*.quality
required
double

required, numeric

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.*.timestamp
required
integer

required, integer

temperature.slots.*.date
required
string

required, date_format:H:i

temperature.slots.*.temp_sk1
double

nullable, present, numeric

temperature.slots.*.temp_sk2
double

nullable, present, numeric

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.*.timestamp
required
integer

required, integer

spo2.slots.*.date
required
string

required, date_format:H:i

spo2.slots.*.spo2
integer

nullable, present, integer

spo2.slots.*.spo2_q
integer

nullable, present, integer

{
  • "date": "2008-08-08",
  • "activity": {
    },
  • "heart_rate": {
    },
  • "sleep": {
    },
  • "respiration_rate": {
    }
}