Make your product
work with UP.

Heart Rate

Get resting heart rate for a user.

Returns a single resting heart rate measurement captured at a specific, non-configurable time via an UP3 device. Note: This is an UP3-only feature -- UP, UP24, and UP MOVE do not support heart rate.

URI Method Response Type Returns
/nudge/api/v.1.1/users/@me/heartrates GET application/json Collection>Cardiac
Parameter Type Description
date string Date, formatted as YYYYMMDD. If omitted, returns the information for today..
page_token int Timestamp used to paginate the list of events. The Developer must use the "next" link provided in the "links" section.
start_time int To be used along with end_time. Epoch timestamp that denotes the start of the time range queried for events.
end_time int To be used with start_time. Epoch timestamp that denotes the end of the time range queried for events.
updated_after int Epoch timestamp to list events that have been updated later than the timestamp.
limit int Maximum number of results to return

Example:

GET https://jawbone.com/nudge/api/v.1.1/users/@me/heartrates
HTTP/1.1
Host: jawbone.com
Content-Type: application/x-www-form-urlencoded
	

Will return:

HTTP 200 OK
{
   "meta": 
   {
      "user_xid": "6xl39CsoVp2KirfHwVq_Fx",
      "message": "OK",
      "code": 200
      "time": 1382377526
   },
  “data”:
   {
      "items": 
      [{
         "xid": "40F7_htRRnT8Vo7nRBZO1X",
         "title": "My resting heart rate on December 10th, 2014",
         "time_created": 1384963500,
         "time_updated": 1385049599,
         "date": 20141210,
         "place_lat": "37.451572",
         "place_lon": "-122.184435",
         "place_acc": 10,
         "place_name": "",
         "resting_heartrate": 55,
         "details": 
         {
            "tz": "America/Los_Angeles"
         }
      },
      {
      ... more items ....
      }],
      "links": 
      {
         "next": "/nudge/api/v.1.1/users/6xl39CsoVp2KirfHwVq_Fx/heartrates?page_token=1384390680"
      },
      “size”: 10
   }   
}
	
Data Value Type Description
xid string Unique ID for this event. Can be used to retrieve data for this specific event, see below.
title string Title of this cardiac event
time_created int Epoch timestamp when this cardiac event was created.
time_updated int Epoch timestamp when this cardiac event was updated.
date int Date when this cardiac event was created, formatted as YYYYMMDD.
place_lat float Latitude of location where cardiac event was logged.
place_lon float Longitude of location where cardiac event was logged.
place_acc int Accuracy of location where cardiac event was logged, in meters.
place_name string Name of location where cardiac event was logged.
resting_heartrate int Resting heart rate of user for the day.
tz int Time zone when this event was generated. Whenever possible, Olson format (e.g., "America/Los Angeles") will be returned, otherwise the GMT offset (e.g., "GMT+0800") will be returned.
size int Number of items in this list.
next URI Link to next page of data (relative, add https://jawbone.com as prefix).