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.activity.created

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

​
id
string
required
​
date
string
requireddeprecated

Date of the specified record, formatted as ISO8601 datetime string in UTC 00:00. Deprecated in favour of calendar_date.

​
calendar_date
string
required

Date of the summary in the YYYY-mm-dd format.

​
calories_total
anyOf | null

Total energy consumption during the day including Basal Metabolic Rate in kilocalories::kilocalories Any of:

  • number
  • null
​
calories_active
anyOf | null

Energy consumption caused by the physical activity of the day in kilocalories::kilocalories Any of:

  • number
  • null
​
steps
anyOf | null

Total number of steps registered during the day::steps Any of:

  • integer
  • null
​
daily_movement
anyOf | null
deprecated

Deprecated. Daily physical activity as equal meters i.e. amount of walking needed to get the same amount of activity::meters Any of:

  • number
  • null
​
distance
anyOf | null

Distance traveled during activities throughout the day::meters Any of:

  • number
  • null
​
low
anyOf | null

Number of minutes during the day with low intensity activity (e.g. household work)::minutes Any of:

  • number
  • null
​
medium
anyOf | null

Number of minutes during the day with medium intensity activity (e.g. walking)::minutes Any of:

  • number
  • null
​
high
anyOf | null

Number of minutes during the day with high intensity activity (e.g. running)::minutes Any of:

  • number
  • 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.

​
floors_climbed
anyOf | null

Number of floors climbed by the user::count Any of:

  • integer
  • null
​
time_zone
anyOf | null

[DEPRECATED] The time zone full identifier for the data. Example: ‘Europe/London’. Any of:

  • string
  • null
​
timezone_offset
anyOf | 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
​
heart_rate
anyOf | null

Heart rate daily summary. Any of:

  • ClientFacingHeartRate
  • null
provider.connection.errordaily.data.activity.updated