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.body.updated

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

​
weight
anyOf | null

Weight in kg::kg Any of:

  • number
  • null
​
fat
anyOf | null

Total body fat percentage::perc Any of:

  • number
  • null
​
water_percentage
anyOf | null

Water percentage in the body::perc Any of:

  • number
  • null
​
muscle_mass_percentage
anyOf | null

Muscle mass percentage in the body::perc Any of:

  • number
  • null
​
visceral_fat_index
anyOf | null

Visceral fat index::scalar Any of:

  • number
  • null
​
bone_mass_percentage
anyOf | null

Bone mass percentage in the body::perc Any of:

  • number
  • null
​
source
ClientFacingSource
required
​
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.

daily.data.body.createdhistorical.data.body.created