daily.data.workouts.created

Lab Tests

Orders
Results
Appointments

Provider

Summaries

Activity
Body
Meal
Menstrual Cycle
Profile
Sleep
Sleep Cycle
Workout
Workout Stream

Activity Timeseries

Calories Active
Calories Basal
Distance
Floors Climbed
Steps
VO2 Max
Workout Duration
Wheelchair Push
Stand Hour
Stand Duration
Fall

Vitals Timeseries

Blood Pressure
Blood Oxygen
Cholesterol
Electrocardiogram Voltage
Glucose
IGE
IGG
Insulin Injection
Heart rate
HRV
Respiratory Rate
Forced Expiratory Volume 1
Forced Vital Capacity
Peak Expiratory Flow Rate
Inhaler Usage

Body Timeseries

Body Fat
Body Weight
Body Mass Index
Lean Body Mass
Waist Circumference
Body Temperature
Body Temperature Delta
Basal Body Temperature

Diary Timeseries

Note

Nutrition Timeseries

Caffeine
Carbohydrates
Water

Wellness Timeseries

Sleep Apnea Alert
Sleep Breathing Disturbance
Mindfulness Minutes
Stress Level
UV Exposure
Daylight Exposure
Handwashing

event_type

enum<string>

required

Available options:

daily.data.workouts.created,

daily.data.workouts.updated

user_id

string

required

client_user_id

string

required

team_id

string

required

data

object

required

data.id

string

required

data.user_id

string

required

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.

data.calendar_date

string

required

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

data.time_start

string

required

Start time of the workout::time

data.time_end

string

required

End time of the workout::time

data.provider_id

string

required

Provider ID given for that specific workout

data.source

object

required

Source the data has come from.

Example:

{ "provider": "oura", "type": "ring" }

data.created_at

string

required

data.updated_at

string

required

data.title

string | null

Title given for the workout

data.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

data.average_hr

integer | null

Average heart rate during workout::bpm

data.max_hr

integer | null

Max heart rate during workout::bpm

data.distance

number | null

Distance travelled during workout::meters

data.calories

number | null

Calories burned during the workout::kCal

data.sport

object

Sport's name

data.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

data.moving_time

integer | null

Time spent active during the workout::seconds

data.total_elevation_gain

number | null

Elevation gain during the workout::meters

data.elev_high

number | null

Highest point of elevation::meters

data.elev_low

number | null

Lowest point of elevation::meters

data.average_speed

number | null

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

data.max_speed

number | null

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

data.average_watts

number | null

Average watts burned during exercise::watts

data.device_watts

number | null

Watts burned during exercise::watts

data.max_watts

number | null

Max watts burned during exercise::watts

data.weighted_average_watts

number | null

Weighted average watts burned during exercise::watts

data.steps

integer | null

Number of steps accumulated during this workout::count

data.map

object | null

Map of the workout

Example:

{
  "average_hr": 100,
  "average_speed": 4.2,
  "average_watts": 100,
  "calendar_date": "2023-02-27",
  "calories": 300,
  "created_at": "2023-02-27T20:31:24+00:00",
  "device_watts": 80,
  "distance": 1700,
  "elev_high": 20.2,
  "elev_low": -10.2,
  "hr_zones": [100, 90, 10, 10, 200],
  "id": "185d0f34-dfc0-429f-84f9-b24030914bdd",
  "map": {
    "summary_polyline": "agn~Ftb{uOvr@daBunBjdBkHwiD????~Ngn@ha@_N~Ql`@"
  },
  "max_hr": 190,
  "max_speed": 7.8,
  "max_watts": 200,
  "moving_time": 100,
  "source": { "provider": "strava", "type": "unknown" },
  "sport": { "id": 1, "name": "football" },
  "time_end": "2023-02-27T12:31:24+00:00",
  "time_start": "2023-02-27T11:31:24+00:00",
  "total_elevation_gain": 10,
  "updated_at": "2023-02-28T01:22:38+00:00",
  "user_id": "1449752e-0d8a-40e0-9206-91ab099b2537",
  "weighted_average_watts": 250
}

historical.data.sleep_cycle.created daily.data.workouts.updated

{
  "event_type": "daily.data.workouts.created",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "average_hr": 100,
    "average_speed": 4.2,
    "average_watts": 100,
    "calendar_date": "2023-02-27",
    "calories": 300,
    "created_at": "2023-02-27T20:31:24+00:00",
    "device_watts": 80,
    "distance": 1700,
    "elev_high": 20.2,
    "elev_low": -10.2,
    "hr_zones": [
      100,
      90,
      10,
      10,
      200
    ],
    "id": "185d0f34-dfc0-429f-84f9-b24030914bdd",
    "map": {
      "summary_polyline": "agn~Ftb{uOvr@daBunBjdBkHwiD????~Ngn@ha@_N~Ql`@"
    },
    "max_hr": 190,
    "max_speed": 7.8,
    "max_watts": 200,
    "moving_time": 100,
    "source": {
      "provider": "strava",
      "type": "unknown"
    },
    "sport": {
      "id": 1,
      "name": "football"
    },
    "time_end": "2023-02-27T12:31:24+00:00",
    "time_start": "2023-02-27T11:31:24+00:00",
    "total_elevation_gain": 10,
    "updated_at": "2023-02-28T01:22:38+00:00",
    "user_id": "1449752e-0d8a-40e0-9206-91ab099b2537",
    "weighted_average_watts": 250
  }
}