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., (water, 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_typerequired
const string

Constant: daily.data.water.created

datarequired
TimeseriesData
datarequired
ClientFacingIntervalSample[]
id
integer | null

Measurement id. Note, this field has been deprecated and is no longer used

timezone_offset
integer | null

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

valuerequired
number

The value of the measurement.

type
string | null

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

unitrequired
string

The unit of the value. We use SI units where possible, e.g. mmol/L for glucose/cholesterol, bpm for heart rate, etc.

timestamprequired
string

Depracated. The timestamp of the measurement.

startrequired
string

The start timestamp of the measurement.

endrequired
string

The end timestamp of the measurement.

source_idrequired
integer
sourcerequired
ClientFacingSource
providerrequired
string

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

namerequired
string

[⚠️ Deprecated] Deprecated.

slugrequired
string

[⚠️ Deprecated] Deprecated.

logorequired
string

[⚠️ Deprecated] Deprecated.

user_idrequired
string

​
Examples

{
  "event_type": "daily.data.water.created",
  "data": {
    "data": [
      {
        "timestamp": "2023-09-19T13:06:04.278631+00:00",
        "timezone_offset": null,
        "value": 400,
        "type": null,
        "unit": "ml"
      }
    ],
    "source_id": 1,
    "source": {
      "name": "Oura",
      "slug": "oura",
      "logo": "https://logo_url.com"
    },
    "user_id": "198de1b7-da81-4e7e-b9fe-371e7b545d13"
  }
}