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

​
event_type
const string
required

Constant: daily.data.workout_stream.created

​
team_id
string
required
​
user_id
string
required
​
client_user_id
string
required
​
data
ClientFacingShallowWorkoutStream
required
​
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.

​
workout_id
string
required
​
provider_id
string
required
​
message
string | null
​
source
ClientFacingSource
required

Source the data has come from.

​
provider
string
required

Provider slug. e.g., oura, fitbit, garmin.

​
type
string | null

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

​
app_id
anyOf | null

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
​
name
string | null
deprecated

Deprecated. Subject to removal after 1 Jan 2024.

​
slug
string | null
deprecated

Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.

Deprecated. Subject to removal after 1 Jan 2024.

​
sport
ClientFacingSport | null

Sport’s name

​
id
integer
requireddeprecated

This ID is unstable across environments. Use the slug instead.

​
name
string
required

Sport’s name

​
slug
string
required

Slug for designated sport

historical.data.workouts.createddaily.data.workout_stream.updated