Skip to main content
GET
Get Data Summary

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 normalized to midnight UTC.

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 normalized to midnight UTC.

Example:

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

Response

Successful Response

Per-user data summary with counts by type and provider.

user_id
string
required
total_data_points
integer
required
total_workouts
integer
required
total_sleep_events
integer
required
series_type_counts
Series Type Counts · object
required
workout_type_counts
Workout Type Counts · object
required
by_provider
ProviderDataCount · object[]
required
has_womens_health_data
boolean
default:false