Vital home pagelight logo
Summaries
daily.data.workouts.created

Each summary object is uniquely identified by its id.

If multiple events are received at the same id, the last event received replaces all its previous versions.

​
Properties

event_typerequired
const string

Constant: daily.data.workouts.created

datarequired
ClientFacingWorkout
user_idrequired
string

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.

user_key
string | null

[⚠️ Deprecated] User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.

idrequired
string
title
string | null

Title given for the workout

timezone_offset
integer | 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

average_hr
integer | null

Average heart rate during workout::bpm

max_hr
integer | null

Max heart rate during workout::bpm

distance
number | null

Distance travelled during workout::meters

calendar_daterequired
string

Date of the workout summary in the YYYY-mm-dd format. This generally matches the workout start date.

time_startrequired
string

Start time of the workout::time

time_endrequired
string

End time of the workout::time

calories
number | null

Calories burned during the workout::kCal

sport
ClientFacingSport | null

Sport’s name

idrequired
integer
namerequired
string

Sport’s name

slugrequired
string

Slug for designated sport

hr_zones
integer | null

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

moving_time
integer | null

Time spent active during the workout::seconds

total_elevation_gain
number | null

Elevation gain during the workout::meters

elev_high
number | null

Highest point of elevation::meters

elev_low
number | null

Lowest point of elevation::meters

average_speed
number | null

Average speed during workout in m/s::meters/sec

max_speed
number | null

Max speed during workout in m/s::meters/sec

average_watts
number | null

Average watts burned during exercise::watts

device_watts
number | null

Watts burned during exercise::watts

max_watts
number | null

Max watts burned during exercise::watts

weighted_average_watts
number | null

Weighted average watts burned during exercise::watts

map
object | null

Map of workouts encoded as polyline

provider_idrequired
string

Provider ID given for that specific workout

sourcerequired
ClientFacingSource

Source the data has come from.

namerequired
string

Name of source of information

slugrequired
string

Slug for designated source

logorequired
string

URL for source logo

​
Examples

{
  "event_type": "daily.data.workouts.created",
  "data": {
    "id": "0103fd05-fbe0-43b1-8dc5-f313eafcfa4a",
    "average_hr": 100,
    "max_hr": 190,
    "distance": 1700,
    "calendar_date": "2023-56-",
    "time_start": "2023-05-26T19:56:49.406195+00:00",
    "time_end": "2023-05-26T20:56:49.406225+00:00",
    "calories": 300,
    "sport": {
      "id": 1,
      "name": "football"
    },
    "source": {
      "name": "Strava",
      "slug": "strava",
      "logo": "https://logo_url.com"
    },
    "hr_zones": [
      100,
      90,
      10,
      10,
      200
    ],
    "user_id": "37c6e292-0b9a-488e-adf7-230f7e089422",
    "moving_time": 100,
    "total_elevation_gain": 10,
    "elev_high": 20.2,
    "elev_low": -10.2,
    "average_speed": 4.2,
    "max_speed": 7.8,
    "average_watts": 100,
    "device_watts": 80,
    "max_watts": 200,
    "weighted_average_watts": 250,
    "map": {
      "summary_polyline": "agn~Ftb{uOvr@daBunBjdBkHwiD????~Ngn@ha@_N~Ql`@"
    }
  }
}