daily.data.workouts.created
A new workout session has been created
Each summary is uniquely identified by its ID ($.id
).
Given the same ID, the latest version of a summary you received replaces all its previous versions.
Properties
Constant: daily.data.workouts.created
User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.
Title given for the workout Any of:
- string
- null
Timezone offset from UTC as seconds. For example, EEST (Eastern European Summer Time, +3h) is 10800. PST (Pacific Standard Time, -8h) is -28800::seconds Any of:
- integer
- null
Average heart rate during workout::bpm Any of:
- integer
- null
Max heart rate during workout::bpm Any of:
- integer
- null
Distance travelled during workout::meters Any of:
- number
- null
Date of the workout summary in the YYYY-mm-dd format. This generally matches the workout start date.
Start time of the workout::time
End time of the workout::time
Calories burned during the workout::kCal Any of:
- number
- null
Sport’s name
Sport’s name
Slug for designated sport
Time in seconds spent in different heart rate zones <50%, 50-60%, 60-70%, 70-80%, 80-90%, 90%+. Due to rounding errors, it’s possible that summing all values is different than the total time of the workout. Not available for all providers::seconds Any of:
- array
- null
Time spent active during the workout::seconds Any of:
- integer
- null
Elevation gain during the workout::meters Any of:
- number
- null
Highest point of elevation::meters Any of:
- number
- null
Lowest point of elevation::meters Any of:
- number
- null
Average speed during workout in m/s::meters/sec Any of:
- number
- null
Max speed during workout in m/s::meters/sec Any of:
- number
- null
Average watts burned during exercise::watts Any of:
- number
- null
Watts burned during exercise::watts Any of:
- number
- null
Max watts burned during exercise::watts Any of:
- number
- null
Weighted average watts burned during exercise::watts Any of:
- number
- null
Number of steps accumulated during this workout::count Any of:
- integer
- null
Map of workouts encoded as polyline Any of:
- object
- null
Provider ID given for that specific workout
Source the data has come from.
Provider slug. e.g., oura
, fitbit
, garmin
.
The type of the data source (app or device) by which the summary or the timeseries data were recorded. This defaults to unknown
when Vital cannot extract or infer that information
The identifier of the app which recorded this summary. This is only applicable to multi-source providers like Apple Health and Android Health Connect. Any of:
- string
- null
Deprecated. Subject to removal after 1 Jan 2024.
Deprecated. Use provider
instead. Subject to removal after 1 Jan 2024.
Deprecated. Subject to removal after 1 Jan 2024.