Sleep goal dataset

[shulitskyi]

Hi Folks,

While accessing the following link, I'm getting the data that is not mentioned/described anywhere, including official API documentation:

{0}/{1}/user/-/sleep/goal.json

consistency.awakeRestlessPercentage

consistency.flowId

consistency.recommendedSleepGoal

consistency.typicalDuration

consistency.typicalWakeupTime

goal.bedtime

goal.minDuration

goal.updatedOn

goal.wakeupTime

Could you please shed some light on what does "typical" and "recommended" mean? Would love to get some description!

Thanks!

[Gordon-C]

Hi @shulitskyi 

recommendedSleepGoal is the recommended number of minutes to sleep based on the user's stats.

typicalDuration is a calculation of minutes sleep based on historical sleep data for this user.

[shulitskyi]

Thank you, appreciate your answer. That's already something 🙂

Do you happen to have somewhere the description of each of the columns? The thing is, they are absent even in the official API documentation and there is no info in the net so there is literally no place from where I can get all the information (e.g. logically I get what typicalDuration means but I would need to apply different calculations for historical data in order to find out what type of average is that and for which period)

[Gordon-C · Accepted solution]

Hi @shulitskyi 

Unfortunately, the definitions of the element names is not something we have documented yet.  I hope to have the information in the documentation one day.

Most of the information should be intuitive.  If there are some element names that don't make sense, let me know what they are.