Sign in
External: Summaries

Get Recovery Summary

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

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

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

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.

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

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

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.

cursorstring nullable
limitinteger

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

Example response

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