Sandbox - Multiple Heartrate Documents

GET

/v2/sandbox/usercollection/heartrate

# The '+' symbol in the timezone must be escaped to `%2B` if included.
curl --location --request GET 'https://api.ouraring.com/v2/sandbox/usercollection/heartrate?start_datetime=2021-11-01T00:00:00-08:00&end_datetime=2021-12-01T00:00:00-08:00&fields=timestamp,bpm' \
--header 'Authorization: Bearer <token>'

• Oura API

Authorizations

• BearerAuth

Parameters

Query Parameters

start_datetime

Any of:

string

string format: date-time

null

null

end_datetime

Any of:

string

string format: date-time

null

null

next_token

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

Any of:

TimeSeriesResponse[PublicHeartRateRow]

TimeSeriesResponse[PublicHeartRateRow]

object

data

required

Data

Array<object>

PublicHeartRateRow

Heart rate sample

object

timestamp

required

Timestamp of the discrete sample.

string

timestamp_unix

required

Timestamp of the discrete sample as unix time in milliseconds.

integer

bpm

required

Heart rate as beats per minute.

integer

source

required

Source of the sample.

string

Allowed values: awake workout rest sleep live session

next_token

Any of:

string

string

null

null

TimeSeriesResponseDict

TimeSeriesResponseDict

object

data

required

Data

Array<object>

object

key

additional properties

any

next_token

Any of:

string

string

null

null

Example

{
  "data": [
    {
      "source": "awake"
    }
  ]
}

400

Client Exception

401

Unauthorized access exception. Usually means the access token is expired, malformed or revoked.

403

Access forbidden. Usually means the user’s subscription to Oura has expired and their data is not available via the API.

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

429

Request Rate Limit Exceeded.