Vital home pagelight logo
Summaries
daily.data.activity.updated

Each summary object is uniquely identified by its id.

If multiple events are received at the same id, the last event received replaces all its previous versions.

​
Properties

event_typerequired
const string

Constant: daily.data.activity.updated

datarequired
ClientFacingActivity
user_idrequired
string

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.

user_key
string | null

[⚠️ Deprecated] User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.

idrequired
string
daterequired
string

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

calendar_daterequired
string

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

calories_total
number | null

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

calories_active
number | null

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

steps
integer | null

Total number of steps registered during the day::steps

daily_movement
number | null

[⚠️ Deprecated] Deprecated. Daily physical activity as equal meters i.e. amount of walking needed to get the same amount of activity::meters

distance
number | null

Cumulated distance for exercise

low
number | null

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

medium
number | null

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

high
number | null

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

sourcerequired
ClientFacingSource

Source the data has come from.

namerequired
string

Name of source of information

slugrequired
string

Slug for designated source

logorequired
string

URL for source logo

floors_climbed
integer | null

Number of floors climbed by the user::count

time_zone
string | null

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

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

​
Examples

{
  "event_type": "daily.data.activity.updated",
  "data": {
    "date": "2023-05-26T20:56:48.319668+00:00",
    "calendar_date": "2023-05-26",
    "calories_total": 100,
    "calories_active": 2000,
    "steps": 10000,
    "daily_movement": 200,
    "low": 6400,
    "medium": 6400,
    "high": 6000,
    "floors_climbed": 10,
    "timezone_offset": 3600,
    "time_zone": "Europe/London",
    "source": {
      "name": "Oura",
      "slug": "oura",
      "logo": "https://logo_url.com"
    },
    "user_id": "8f81ca7a-6255-49c2-a6cb-6232e4308d9a"
  }
}