Multiple Heartrate Documents
GET
/v2/usercollection/heartrate
# The '+' symbol in the timezone must be escaped to `%2B` if included.curl --location --request GET 'https://api.ouraring.com/v2/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>'import requestsurl = 'https://api.ouraring.com/v2/usercollection/heartrate'params={ 'start_datetime': '2021-11-01T00:00:00-08:00', 'end_datetime': '2021-12-01T00:00:00-08:00', 'fields': 'timestamp,bpm'}headers = { 'Authorization': 'Bearer <token>'}response = requests.request('GET', url, headers=headers, params=params)print(response.text)var myHeaders = new Headers();myHeaders.append('Authorization', 'Bearer <token>');var requestOptions = { method: 'GET', headers: myHeaders,};fetch('https://api.ouraring.com/v2/usercollection/heartrate?start_datetime=2021-11-01T00:00:00-08:00&end_datetime=2021-12-01T00:00:00-08:00&fields=timestamp,bpm', requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error));OkHttpClient client = new OkHttpClient().newBuilder() .build();Request request = new Request.Builder() .url("https://api.ouraring.com/v2/usercollection/heartrate?start_datetime=2021-11-01T00:00:00-08:00&end_datetime=2021-12-01T00:00:00-08:00&fields=timestamp,bpm") .method("GET", null) .addHeader("Authorization", "Bearer <token>") .build();Response response = client.newCall(request).execute();Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Responses
Section titled “Responses”Successful Response
Media typeapplication/json
Any of:
TimeSeriesResponse[PublicHeartRateRow]
object
data
required
Data
Array<object>
PublicHeartRateRowHeart 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
Example
{ "data": [ { "source": "awake" } ]}Client Exception
Unauthorized access exception. Usually means the access token is expired, malformed or revoked.
Access forbidden. Usually means the user’s subscription to Oura has expired and their data is not available via the API.
Validation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}Request Rate Limit Exceeded.