{
  "event_type": "daily.data.respiratory_rate.created",
  "team_id": "e89cc9fe-e1c0-41bc-a83a-728b8cb1056f",
  "user_id": "fac593ed-f371-4aea-9210-9332f1b19bec",
  "client_user_id": "3Zru4O8cBEiwGTsXgUQGaQ==",
  "data": {
    "data": [
      {
        "start": "2023-02-13T14:30:52+00:00",
        "end": "2023-02-13T14:57:24+00:00",
        "timezone_offset": null,
        "value": 15.5,
        "type": null,
        "unit": "bpm"
      }
    ],
    "source_id": 1,
    "source": {
      "provider": "oura",
      "type": "ring"
    },
    "provider": {
      "name": "Oura",
      "slug": "oura",
      "logo": "https://logo_url.com"
    },
    "user_id": "dffadfff-e42c-4505-accf-7507b01b30e3"
  }
}

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., (respiratory_rate, 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.respiratory_rate.created

team_id
string
required
user_id
string
required
client_user_id
string
required
data
TimeseriesData
required
data
ClientFacingTimeseries[]
required
id
integer | null

Deprecated

timezone_offset
integer | 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.

type
string | null

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

unit
string
required

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

timestamp
string
required

The timestamp of the measurement.

value
number
required

The value of the measurement.

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

name
string
required

[⚠️ Deprecated] Deprecated. Subject to removal after 1 Jan 2024.

slug
string
required

[⚠️ Deprecated] Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.

logo
string
required

[⚠️ 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