External: Summaries

Get Recovery Summary

Changed on

Returns daily recovery metrics (recovery score, HRV, resting HR, SpO2).

Warning - known limitation: this endpoint currently returns data only for WHOOP. Metrics are read from stored recovery-score records, which today are produced solely by WHOOP, so users connected only to other providers (e.g. Apple Health) receive an empty result even when the underlying resting HR, HRV and SpO2 are available. This is a bug.

These values will soon be computed from the timeseries we already store in the database rather than from what a single provider reports, at which point recovery metrics will be returned for all providers that supply the underlying data.

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

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

Path parameters

user_idstring uuid required

Query parameters

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

Example:2023-11-07T05:31:56Z
end_datestring 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.

Example:2023-11-07T05:31:56Z
cursorstring nullable
limitinteger

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

Example response

{
  "data": [
    {
      "source": {
        "provider": "apple",
        "source": "Connect",
        "device": "iPhone15,2",
        "device_id": "R9ZW30ABC12"
      }
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0cyI6MTcwNDA2NzIwMH0",
    "total_count": 150
  }
}

Changes

  • bc25a1359b11Revision changes
    • info

      added the optional property /// to the response with the status

  • 4eaceca2333dRevision changes
    • warning

      added the new bike_computer enum value to the //// response property for the response status

    • warning

      added the new bp_monitor enum value to the //// response property for the response status

    • warning

      added the new chest_strap enum value to the //// response property for the response status

    • warning

      added the new fitness_machine enum value to the //// response property for the response status

    • warning

      added the new glasses enum value to the //// response property for the response status

    • warning

      added the new glucose_meter enum value to the //// response property for the response status

    • warning

      added the new head_mounted enum value to the //// response property for the response status

    • warning

      added the new headphones enum value to the //// response property for the response status

    • warning

      added the new hr_sensor enum value to the //// response property for the response status

    • warning

      added the new sleep_monitor enum value to the //// response property for the response status

    • warning

      added the new smart_display enum value to the //// response property for the response status

    • warning

      added the new tablet enum value to the //// response property for the response status

    • warning

      added the new thermometer enum value to the //// response property for the response status