v3

latestOpenAPI 3.1.02026-07-31121144224.9 KB
External: Summaries

Get Data Summary

Returns per-user data counts grouped by series type, event type, and provider.

Optionally scope the counts to a date window via start_date / end_date (data points are filtered by recorded_at, events by their start time). Omitting both returns all-time counts.

get/api/v1/users/{user_id}/summaries/data

Path parameters

user_idstring uuid required

Query parameters

start_datestring date-time nullable

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_datestring date-time nullable

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

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

user_idstring required
total_data_pointsinteger required
total_workoutsinteger required
total_sleep_eventsinteger required
series_type_countsobject required
workout_type_countsobject required
has_womens_health_databoolean