Each sample is uniquely identified by a triple key (3-tuple) comprising of its resource type name, its source (ID or slug) and its timestamp. e.g., (calories_basal, fitbit, 2023-01-23T12:34:56Z).

If multiple samples are received at the same triple key, the last sample received replaces all its previous versions.

​
Properties

event_type
const string
required

Constant: daily.data.calories_basal.updated

team_id
string
required
user_id
string
required
client_user_id
string
required
data
TimeseriesData
required
data
ClientFacingCaloriesBasalTimeseries[]
required
id
anyOf | null

Deprecated Any of:

  • integer
  • null
timezone_offset
anyOf | null

Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. Any of:

  • integer
  • null
type
anyOf | null

The reading type of the measurement. This is applicable only to Cholesterol, IGG, IGE and InsulinInjection. Any of:

  • string
  • null
unit
const string
required

Constant: kcalMeasured in kilocalories (kcal)

timestamp
string
required

The timestamp of the measurement.

value
number
required

Basal Metabolic Rate at the time or interval::kilocalories

source_id
integer
required
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.

logo
string | null
deprecated

Deprecated. Subject to removal after 1 Jan 2024.

provider
ClientFacingProvider
required
name
string
required

Name of source of information

slug
string
required

Slug for designated source

logo
string
required

URL for source logo

user_id
string
required
daily.data.calories_basal.createdhistorical.data.calories_basal.created