Skip to main content
GET
Get Data Timeline

Authorizations

Authorization
string
header
required

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

Headers

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

Path Parameters

user_id
string<uuid>
required

Query Parameters

start_date
string<date-time> | null

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_date
string<date-time> | null

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"

bucket
enum<string>
default:day

Bucket width.

Available options:
day,
week
group_by
enum<string>
default:provider

What each series counts.

Available options:
provider,
series_type,
workout_type
provider
enum<string> | null

Supported data providers.

Available options:
apple,
samsung,
garmin,
health_connect,
google_health,
polar,
suunto,
whoop,
strava,
oura,
fitbit,
ultrahuman,
sensorbio,
withings,
unknown,
internal

Response

Successful Response

Per-user data density over time. Sparse: buckets with no data are omitted.

bucket
enum<string>
required

Width of one bucket in a per-user data timeline.

Available options:
day,
week
group_by
enum<string>
required

What a timeline series is keyed by.

Available options:
provider,
series_type,
workout_type
series
TimelineSeries · object[]