Skip to main content
GET
Get Activity Totals

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowPassword
Token URL
/api/v1/auth/login

Headers

X-Open-Wearables-API-Key
string | null

Path Parameters

user_id
string<uuid>
required

Query Parameters

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

Examples:

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

"2023-11-07"

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

Examples:

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

"2023-11-07"

Response

Successful Response

The period's daily activity added up: the same days the daily summaries return.

days
integer
required

Days with activity data, one per date after source priority

Example:

365

steps
integer
required

Sum of daily steps

Example:

2841230

distance_meters
number
required

Sum of daily distance

Example:

2104380.5

active_calories_kcal
number
required

Sum of daily active energy

Example:

152340

avg_steps
integer | null

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

Example:

7784