website logo
⌘K
Quickstart
User
Metrics
Webhooks
Mobile SDK
V2
React Native
Flutter
Android (Kotlin)
Swift
V1
Errors
FAQ
Docs powered by
Archbee
Metrics
API Version 2 (V2)

Breathing Rate

You can retrieve user's breathing rate by user_id and filter by date range


Get a breathing rate data by user_id
GET
Params
Query Parameters
user_id
required
String
User ID returned by add integration request. This key should be stored in your database against the user and used for all interactions with the Spike API.
start_date
required
String
Date from in YYYY-MM-DD format
end_date
required
String
Date to in YYYY-MM-DD format
Header Parameters
authorizationtoken
optional
String
Client access token (deprecated)
x-spike-auth
required
String
Client access token
Python
Node.js
Ruby
Java
Curl
|
require 'net/http'
require 'openssl'

url = URI("https://api.spikeapi.com/v2/metrics/breathing/?user_id=282812818&start_date=2020-05-01&end_date=2020-05-03")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-spike-auth"] = 'fa0b3803-1111-2222-9788-eccce210d30c'

response = http.request(request)
puts response.read_body
RESPONSES
200
|
{
    "user_id": "19291291291",
    "start_date": "2020-05-01",
    "end_date": "2020-05-03",
    "type": "breathing",
    "source": [
        {
            "name": "fitbit",
            "status": "ok"
        }
    ],
    "data": [
        {
            "date": "2020-05-01",
            "avg_value": 1234,
             "intraday_data": [
                  {
                     "time": "2022-05-01T00:00:00",
                     "value": 1234
                  }
             ],
            "source": "fitbit"
        },
        {
            "date": "2020-05-02",
            "avg_value": 2321,
             "intraday_data": [
                  {
                     "time": "2022-05-02T00:00:00",
                     "value": 2321
                  }
             ],
            "source": "fitbit"
        },
        {
            "date": "2020-05-03",
            "avg_value": 1212,
             "intraday_data": [
                  {
                     "time": "2022-05-02T00:00:00",
                     "value": 1212
                  }
             ],
            "source": "fitbit"
        }
    ]
}

<style>
@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@300&display=swap');

.h2, .h3, .list, .description{
	font-family: 'Poppins', sans-serif;
	font-weight: 500;
}

.h2 {
    margin-top: -20px;
    margin-bottom: 20px;

    font-size: 30px;
}

.h3 {
    font-size: 22px;
	margin-top: -20px;
}

.list-wrapper {
    white-space: normal;
     margin-top: -10px;
}

.list, .description {
    font-size: 14px;
}

</style>
<h2 class="h2">Fields</h2>
<h3 class="h3">Breathing.date</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date, YYYY-MM-DD</li>
    <li class="list">Example: 2020-05-01</li>
</ul><p class="description">Date of measurement</p>

<h3 class="h3">Breathing.avg_value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 14</li>
</ul><p class="description">The average number of breaths taken per minute</p>

<h3 class="h3">Breathing.intraday_data.time</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
 <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>

<h3 class="h3">Breathing.intraday_data.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 14</li>

<h3 class="h3">Breathing.source</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: fitbit</li>
</ul><p class="description">Data source</p>




Did this page help you?
PREVIOUS
Stress
NEXT
Oxygen Saturation (SP02)
Docs powered by
Archbee
Get breathing rate data
TABLE OF CONTENTS
GET
Get breathing rate data
Docs powered by
Archbee