Get a list of daily heart rate summaries for a user.
Returns a list of heart rate summaries
GET https://api.humanapi.co/v1/human/heart_rate/summaries
Returns a heart rate summary by id
GET https://api.humanapi.co/v1/human/heart_rate/summaries/{id}
Returns a heart rate summary by date
GET https://api.humanapi.co/v1/human/heart_rate/summaries/{YYYY-MM-DD}
# Returns a json array of heart rate summaries:
[
{
"id": "550b8a8e834dd16f259683b2",
"userId": "52e20cb2fff56aac62000001",
"date": "2017-06-29",
"zones": [
{
"name": "Out of Range",
"max": 97,
"min": 30,
"duration": 45600,
"caloriesBurned": 1497.92
},
{
"name": "Fat Burn",
"max": 135,
"min": 97,
"duration": 5040,
"caloriesBurned": 557.41
},
{
"name": "Cardio",
"max": 164,
"min": 135,
"duration": 180,
"caloriesBurned": 34.98
},
{
"name": "Peak",
"max": 220,
"min": 164,
"duration": 0,
"caloriesBurned": 0
}
],
"restingHR": 58,
"averageHR": 66,
"maxHR": 158,
"minHR": 45,
"source": "fitbit",
"sourceData": {},
"createdAt": "2017-07-07T20:39:18.346Z",
"updatedAt": "2017-07-07T20:39:18.346Z",
"humanId": "5dc2527186aaf9de560e5841f1a44bd6"
}
]
# Get the heart rate summaries associated with the user
curl -H "Authorization: Bearer demo" "https://api.humanapi.co/v1/human/heart_rate/summaries"
Property | Type | Description |
---|---|---|
id | String | The id of the resource. |
userId | String | [deprecated - use humanId] |
humanId | String | Unique user identifier |
zones | Array[Object] | Array of heart rate zones for the day (see ‘Zone Object’ below) |
date | Date | The date that the heart rate summary corresponds to (format: YYYY-MM-DD) |
source | String | The source service for the measurement, where it was created |
value | Number | The value of the measurement in the unit specified |
restingHR | Number | The user’s resting heart rate for the day in beats per minute (optional) |
averageHR | Number | The user’s average heart rate for the day in beats per minute (optional) |
maxHR | Number | The maximum heart rate reading recorded for the day in beats per minute (optional) |
minHR | Number | The maximum heart rate reading recorded for the day in beats per minute (optional) |
sourceData | Object | Additional data from the source that does not fit into the Human API model |
createdAt | Date | The time the measurement was created on the Human API server |
updatedAt | Date | The time the measurement was updated on the Human API server |
Zone Object
Zones are defined at the source and may vary, including zone names and ranges.
Property | Type | Description |
---|---|---|
name | String | Name of the zone |
max | Number | Maximum heart rate applicable to the zone in beats per minute |
min | Number | Minimum heart rate applicable to the zone in beats per minute |
duration | Number | Duration that the user’s heart rate remained in the zone in seconds |
caloriesBurned | Number | Calories burned while within the zone |