WHOOP · Schema

Cycle

The collection of records in this page.

FitnessWearablesHealthRecoverySleepWorkoutStrainHeart RatePerformance

Properties

Name	Type	Description
id	integer	Unique identifier for the physiological cycle
user_id	integer	The WHOOP User for the physiological cycle
created_at	string	The time the cycle was recorded in WHOOP
updated_at	string	The time the cycle was last updated in WHOOP
start	string	Start time bound of the cycle
end	string	End time bound of the cycle. If not present, the user is currently in this cycle
timezone_offset	string	The user's timezone offset at the time the cycle was recorded. Follows format for Time Zone Designator (TZD) - '+hh:mm', '-hh:mm', or 'Z'.
score_state	string	`SCORED` means the cycle was scored and the measurement values will be present. `PENDING_SCORE` means WHOOP is currently evaluating the cycle. `UNSCORABLE` means this activity could not be scored for
score	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/whoop/main/json-schema/whoop-cycle-schema.json",
  "title": "Cycle",
  "description": "The collection of records in this page.",
  "required": [
    "created_at",
    "id",
    "score_state",
    "start",
    "timezone_offset",
    "updated_at",
    "user_id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique identifier for the physiological cycle",
      "format": "int64",
      "example": 93845
    },
    "user_id": {
      "type": "integer",
      "description": "The WHOOP User for the physiological cycle",
      "format": "int64",
      "example": 10129
    },
    "created_at": {
      "type": "string",
      "description": "The time the cycle was recorded in WHOOP",
      "format": "date-time",
      "example": "2022-04-24T11:25:44.774Z"
    },
    "updated_at": {
      "type": "string",
      "description": "The time the cycle was last updated in WHOOP",
      "format": "date-time",
      "example": "2022-04-24T14:25:44.774Z"
    },
    "start": {
      "type": "string",
      "description": "Start time bound of the cycle",
      "format": "date-time",
      "example": "2022-04-24T02:25:44.774Z"
    },
    "end": {
      "type": "string",
      "description": "End time bound of the cycle. If not present, the user is currently in this cycle",
      "format": "date-time",
      "example": "2022-04-24T10:25:44.774Z"
    },
    "timezone_offset": {
      "type": "string",
      "description": "The user's timezone offset at the time the cycle was recorded. Follows format for Time Zone Designator (TZD) - '+hh:mm', '-hh:mm', or 'Z'.",
      "example": "-05:00",
      "externalDocs": {
        "description": "Learn more about the Time Zone Designator from the W3C Standard",
        "url": "https://www.w3.org/TR/NOTE-datetime"
      }
    },
    "score_state": {
      "type": "string",
      "description": "`SCORED` means the cycle was scored and the measurement values will be present. `PENDING_SCORE` means WHOOP is currently evaluating the cycle. `UNSCORABLE` means this activity could not be scored for some reason - commonly because there is not enough user metric data for the time range.",
      "example": "SCORED",
      "enum": [
        "SCORED",
        "PENDING_SCORE",
        "UNSCORABLE"
      ]
    },
    "score": {
      "$ref": "#/components/schemas/CycleScore"
    }
  }
}