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

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/data
  • Auth: OAuth 2 (password, token URL /api/v1/auth/login)

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 cover the whole day, so a date-only range includes both boundary days.

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 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

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

Changes

No recorded changes to this operation across all 28 revisions of this API.