External: Summaries

Get Activity Totals

Changed on

Returns the period's daily activity added up: days, steps, distance and active energy.

The same days the daily summaries return, one per date after source priority, so a total matches what paging through them would add up to.

get/api/v1/users/{user_id}/summaries/activity/totals

Request

  • Base URL: https://api.openwearables.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.openwearables.io/api/v1/users/{user_id}/summaries/activity/totals
  • Auth: OAuth 2 (password, token URL /api/v1/auth/login)

Path parameters

user_idstring uuid required

Query parameters

start_datestring date-time required

ISO 8601 datetime (e.g. 2023-11-07T05:31:56Z) or Unix timestamp in seconds. Date-only strings (e.g. 2023-11-07) are also accepted and cover the whole day, so a date-only range includes both boundary days.

Example:2023-11-07T05:31:56Z
end_datestring date-time required

ISO 8601 datetime (e.g. 2023-11-07T05:31:56Z) or Unix timestamp in seconds. Date-only strings (e.g. 2023-11-07) are also accepted and cover the whole day, so a date-only range includes both boundary days.

Example:2023-11-07T05:31:56Z

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

daysinteger required

Days with activity data, one per date after source priority

stepsinteger required

Sum of daily steps

distance_metersnumber required

Sum of daily distance

active_calories_kcalnumber required

Sum of daily active energy

avg_stepsinteger nullable

Mean steps over the days that report steps; null when none do

Example response

{
  "days": 365,
  "steps": 2841230,
  "distance_meters": 2104380.5,
  "active_calories_kcal": 152340,
  "avg_steps": 7784
}

Changes