WHOOP · Example Payload

Whoop Sleep Example

Example WHOOP sleep activity response

FitnessWearablesHealthRecoverySleepWorkoutStrainHeart RatePerformance

Whoop Sleep Example is an example object payload from WHOOP, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionendpointmethodresponse

Example Payload

{
  "description": "Example WHOOP sleep activity response",
  "endpoint": "/v2/activity/sleep",
  "method": "GET",
  "response": {
    "records": [
      {
        "id": 10235,
        "user_id": 10129,
        "created_at": "2022-04-24T11:25:44.774Z",
        "updated_at": "2022-04-24T14:25:44.774Z",
        "start": "2022-04-24T01:00:00.000Z",
        "end": "2022-04-24T08:00:00.000Z",
        "timezone_offset": "-05:00",
        "nap": false,
        "score_state": "SCORED",
        "score": {
          "stage_summary": {
            "total_in_bed_time_milli": 25200000,
            "total_awake_time_milli": 1500000,
            "total_no_data_time_milli": 0,
            "total_light_sleep_time_milli": 7200000,
            "total_slow_wave_sleep_time_milli": 3600000,
            "total_rem_sleep_time_milli": 5400000,
            "sleep_cycle_count": 4,
            "disturbance_count": 3
          },
          "sleep_needed": {
            "baseline_milli": 27120740,
            "need_from_sleep_debt_milli": 0,
            "need_from_recent_strain_milli": 0,
            "need_from_recent_nap_milli": -8647416
          },
          "respiratory_rate": 16.11328125,
          "sleep_performance_percentage": 98,
          "sleep_consistency_percentage": 65,
          "sleep_efficiency_percentage": 91.69533
        }
      }
    ],
    "next_token": null
  }
}