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 1 (V1)

Oxygen Saturation (SP02)

You can retrieve user oxygen saturation by user_id and filter by date range


Get a oxygen saturation 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
|
import requests

url = "https://api.spikeapi.com/metrics/oxygen_saturation/?user_id=282812818&start_date=2020-05-01&end_date=2020-05-03"
headers = {}
headers['x-spike-auth'] = 'fa0b3803-1111-2222-9788-eccce210d30c'
response = requests.request("GET", url, headers=headers)

print(response.text)
RESPONSES
200
|
{
    "user_key": "19291291291",
    "start_date": "2020-05-01",
    "end_date": "2020-05-03",
    "type": "oxygen_saturation",
    "sources": [
        {
            "name": "fitbit",
            "status": "ok"
        }
    ],
    "data": [
        {
            "date": "2020-05-01",
            "avg": 97.2,
            "min": 95.1,
            "max": 99.2,
            "source": "fitbit"
        },
        {
            "date": "2020-05-02",
            "avg": 96.2,
            "min": 91.1,
            "max": 99.2,
            "source": "fitbit"
        },
        {
            "date": "2020-05-03",
            "avg": 97.4,
            "min": 95.1,
            "max": 99.2,
            "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">Oxygen_saturation.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. For Whoop, date when the cycle ende</p>

<h3 class="h3">Oxygen_saturation.avg</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 97.5</li>
</ul><p class="description">The mean of the 1 minute SpO2 levels calculated as a percentage value.</p>

<h3 class="h3">Oxygen_saturation.min</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 96</li>
</ul><p class="description">The minimum daily SpO2 level calculated as a percentage value.</p>

<h3 class="h3">Oxygen_saturation.max</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 100</li>
</ul><p class="description">The maximum daily SpO2 level calculated as a percentage value.</p>

<h3 class="h3">Oxygen_saturation.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
Breathing Rate
NEXT
Audio
Docs powered by
Archbee
Get oxygen saturation data
TABLE OF CONTENTS
GET
Get oxygen saturation data
Docs powered by
Archbee