# Oura

> Read sleep, activity, readiness, workouts, stress and other Oura measurements.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/oura

## Actions

### Get daily readiness

Get daily readiness.

**Inputs**

- Record (`document_id`, text, required): Choose a recent record, or enter an ID from an earlier step.

**Outputs**: Response.

- `data` (object): Public object defining daily readiness.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "contributors": {
      "activity_balance": 1,
      "body_temperature": 1,
      "hrv_balance": 1,
      "previous_day_activity": 1,
      "previous_night": 1,
      "recovery_index": 1,
      "resting_heart_rate": 1,
      "sleep_balance": 1,
      "sleep_regularity": 1
    },
    "day": "example",
    "id": "example",
    "score": 1,
    "temperature_deviation": 1,
    "temperature_trend_deviation": 1,
    "timestamp": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get personal info

Get personal info.

**Inputs**: None.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "age": 1,
    "biological_sex": "example",
    "email": "example",
    "height": 1,
    "id": "example",
    "weight": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get sleep

Get sleep.

**Inputs**

- Record (`document_id`, text, required): Choose a recent record, or enter an ID from an earlier step.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "app_sleep_phase_5_min": "example",
    "average_breath": 1,
    "average_heart_rate": 1,
    "average_hrv": 1,
    "awake_time": 1,
    "bedtime_end": "example",
    "bedtime_start": "example",
    "day": "example",
    "deep_sleep_duration": 1,
    "efficiency": 1,
    "heart_rate": {
      "interval": 1,
      "items": [],
      "timestamp": "example"
    },
    "hrv": {
      "interval": 1,
      "items": [],
      "timestamp": "example"
    },
    "id": "example",
    "latency": 1,
    "light_sleep_duration": 1,
    "low_battery_alert": false,
    "lowest_heart_rate": 1,
    "movement_30_sec": "example",
    "period": 1,
    "readiness": {
      "contributors": {
        "activity_balance": 1,
        "body_temperature": 1,
        "hrv_balance": 1,
        "previous_day_activity": 1,
        "previous_night": 1,
        "recovery_index": 1,
        "resting_heart_rate": 1,
        "sleep_balance": 1,
        "sleep_regularity": 1
      },
      "score": 1,
      "temperature_deviation": 1,
      "temperature_trend_deviation": 1
    },
    "readiness_score_delta": 1,
    "rem_sleep_duration": 1,
    "restless_periods": 1,
    "ring_id": "example",
    "sleep_algorithm_version": "v1",
    "sleep_analysis_reason": "foreground_sleep_analysis",
    "sleep_phase_30_sec": "example",
    "sleep_phase_5_min": "example",
    "sleep_score_delta": 1,
    "time_in_bed": 1,
    "total_sleep_duration": 1,
    "type": "deleted"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get workout

Get workout.

**Inputs**

- Record (`document_id`, text, required): Choose a recent record, or enter an ID from an earlier step.

**Outputs**: Response.

- `data` (object): Public model for Workout.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "activity": "example",
    "calories": 1,
    "day": "example",
    "distance": 1,
    "end_datetime": "example",
    "id": "example",
    "intensity": "easy",
    "label": "example",
    "source": "manual",
    "start_datetime": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List daily activity

List daily activity.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `active_calories` (Active calories), `average_met_minutes` (Average met minutes), `class_5_min` (Class 5 min), `contributors`, `day`, `equivalent_walking_distance` (Equivalent walking distance), `high_activity_met_minutes` (High activity met minutes), `high_activity_time` (High activity time), `id`, `inactivity_alerts` (Inactivity alerts), and 16 more.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List daily cardiovascular age

List daily cardiovascular age.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `day`, `id`, `pulse_wave_velocity` (Pulse wave velocity), `vascular_age` (Vascular age).

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List daily readiness

List daily readiness.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `contributors`, `day`, `id`, `score`, `temperature_deviation` (Temperature deviation), `temperature_trend_deviation` (Temperature trend deviation), `timestamp`.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List daily resilience

List daily resilience.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `contributors`, `day`, `id`, `level`.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List daily sleep

List daily sleep.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `contributors`, `day`, `id`, `score`, `timestamp`.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List daily spo2

List daily spo2.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `breathing_disturbance_index` (Breathing disturbance index), `day`, `id`, `spo2_percentage` (Spo2 percentage).

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List daily stress

List daily stress.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `day`, `day_summary` (Day summary), `id`, `recovery_high` (Recovery high), `stress_high` (Stress high).

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List enhanced tag

List enhanced tag.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `comment`, `custom_name` (Custom name), `end_day` (End day), `end_time` (End time), `id`, `start_day` (Start day), `start_time` (Start time), `tag_type_code` (Tag type code).

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List heartrate

List heartrate.

**Inputs**

- Start datetime (`start_datetime`, date and time): Start of the measurement window. Times are sent in UTC.
- End datetime (`end_datetime`, date and time): End of the measurement window. Times are sent in UTC.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Latest (`latest`, true/false): If True, returns most recent sample.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `bpm`, `source`, `timestamp`, `timestamp_unix` (Timestamp unix).

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List rest mode period

List rest mode period.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `end_day` (End day), `end_time` (End time), `episodes`, `id`, `start_day` (Start day), `start_time` (Start time).

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List ring configuration

List ring configuration.

**Inputs**

- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `color`, `design`, `firmware_version` (Firmware version), `hardware_type` (Hardware type), `id`, `set_up_at` (Set up at), `size`.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List session

List session.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `day`, `end_datetime` (End datetime), `heart_rate` (Heart rate), `heart_rate_variability` (Heart rate variability), `id`, `mood`, `motion_count` (Motion count), `start_datetime` (Start datetime), `type`.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List sleep

List sleep.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `app_sleep_phase_5_min` (App sleep phase 5 min), `average_breath` (Average breath), `average_heart_rate` (Average heart rate), `average_hrv` (Average hrv), `awake_time` (Awake time), `bedtime_end` (Bedtime end), `bedtime_start` (Bedtime start), `day`, `deep_sleep_duration` (Deep sleep duration), `efficiency`, and 22 more.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List sleep time

List sleep time.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `day`, `id`, `optimal_bedtime` (Optimal bedtime), `recommendation`, `status`.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List vo2 max

List vo2 max.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `day`, `id`, `timestamp`, `vo2_max` (Vo2 max).

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List workout

List workout.

**Inputs**

- Start date (`start_date`, date and time): First day to include. Leave empty to use Oura’s default range.
- End date (`end_date`, date and time): Last day to include. Leave empty to use Oura’s default range.
- Page token (`next_token`, text): The next_cursor from an earlier response. Leave empty for the first page.
- Fields (`fields`, list): Choose which details to include. Leave empty to get all available details. One or more of: `activity`, `calories`, `day`, `distance`, `end_datetime` (End datetime), `id`, `intensity`, `label`, `source`, `start_datetime` (Start datetime).

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_token": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
