API Reference

Respiration Rates

22 views 0

The Respiration Rate resource represents the number of breaths (inhalation-exhalation cycles) taken within a set amount of time (typically 60 seconds).

Overview

Property Type Description
code String The id of the respiration rate
user_code String The global code of the user
record_time Datetime with Timezone The original date and time of the measurement
source String The source service for the measurement, where it was created
value Number The value of the measurement in the unit specified
unit String The unit of the measurement value. See Unit System.
created_at Datetime with Timezone The time the measurement was created on the ZivaCare API server
updated_at Datetime with Timezone The time the measurement was updated on the ZivaCare API server

Example

GET https://api.zivacare.com/api/v2/human/respiration_rates?access_token=demo
{
  "respirationRates": [
    {
      "code": "a9b0fa1b-60cd-46aa-beb5-10ab0484a005",
      "value": 15,
      "unit": "breaths per minute",
      "source": "fitbit",
      "record_time": "2014-11-16 15:52:01+00",
      "user_code": "e231e984-2209-4a10-b634-2257b89c200f",
      "created_at": "2016-05-30 06:14:12+00"
    },
    {
      "code": "78d70123-af79-4486-91c4-f21d88d5bda0",
      "value": 13,
      "unit": "breaths per minute",
      "source": "fitbit",
      "record_time": "2014-09-16 15:52:01+00",
      "user_code": "e231e984-2209-4a10-b634-2257b89c200f",
      "created_at": "2016-05-30 06:13:55+00"
    }
  ], 
  "total": 2
}
curl -X POST -H 'Content-Type: application/json' https://api.zivacare.com/api/v2/human/respiration_rates?access_token=demo -d '{ 
  "source": "fitbit",
  "record_time": "2014-09-16T15:52:01+0000",
  "value": 16,
  "unit": "breaths per minute"
}'
GET https://api.zivacare.com/api/v2/human/respiration_rates/daily/2014-11-16?access_token=demo
{
  "respirationRates": [
    {
      "code": "a9b0fa1b-60cd-46aa-beb5-10ab0484a005",
      "value": 15,
      "unit": "breaths per minute",
      "source": "fitbit",
      "record_time": "2014-11-16 15:52:01+00",
      "user_code": "e231e984-2209-4a10-b634-2257b89c200f",
      "created_at": "2016-05-30 06:14:12+00"
    }
  ], 
  "total": 1
}
GET https://api.zivacare.com/api/v2/human/respiration_rates/period/2014-09-16/2014-10-16?access_token=demo
{
  "respirationRates": [
    {
      "code": "78d70123-af79-4486-91c4-f21d88d5bda0",
      "value": 13,
      "unit": "breaths per minute",
      "source": "fitbit",
      "record_time": "2014-09-16 15:52:01+00",
      "user_code": "e231e984-2209-4a10-b634-2257b89c200f",
      "created_at": "2016-05-30 06:13:55+00"
    }
  ], 
  "total": 1
}
GET https://api.zivacare.com/api/v2/human/respiration_rates/a9b0fa1b-60cd-46aa-beb5-10ab0484a005?access_token=demo
{
  "respirationRate": 
    {
      "code": "a9b0fa1b-60cd-46aa-beb5-10ab0484a005",
      "value": 15,
      "unit": "breaths per minute",
      "source": "fitbit",
      "record_time": "2014-11-16 15:52:01+00",
      "user_code": "e231e984-2209-4a10-b634-2257b89c200f",
      "created_at": "2016-05-30 06:14:12+00"
    }
}
curl -X PUT -H 'Content-Type: application/json' https://api.zivacare.com/api/v2/human/respiration_rates/a9b0fa1b-60cd-46aa-beb5-10ab0484a005/a9b0fa1b-60cd-46aa-beb5-10ab0484a005?access_token=demo -d '{ 
  "source": "fitbit",
  "record_time": "2014-09-16T15:52:01+0000",
  "value": 16,
  "unit": "breaths per minute"
}'

Was this helpful?

By continuing to use the site, you agree to the use of cookies. More information

The cookie settings on this website are set to "allow cookies" to give you the best browsing experience possible. If you continue to use this website without changing your cookie settings or you click "Accept" below then you are consenting to this.

Close