Sleep

You can retrieve user sleep data by user_id and filter by date range
﻿
Get a sleep data by user_id
GET
Request
Query Parameters
user_id
String
required
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
String
required
Date from in YYYY-MM-DD format
end_date
String
required
Date to in YYYY-MM-DD format
Header Parameters
authorizationtoken
String
optional
Client access token (deprecated)
x-spike-auth
String
required
Client access token
Python
Node.js
Ruby
Java
Curl
import requests

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

print(response.text)
import requests

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

print(response.text)
Responses
200
{
    "user_id": "fa1e3803-6068-4ea7-9788-eccce210d30c",
    "start_date": "2024-10-23",
    "end_date": "2024-10-24",
    "type": "sleep",
    "source": [
        {
            "name": "oura",
            "status": "ok"
        }
    ],
    "data": [{
    "date": "2024-10-24",
    "bedtime_start": "2024-10-23T23:26:02",
    "bedtime_end": "2024-10-24T08:13:37",
    "timezone_offset": 7200,
    "bedtime_duration": 33360,
    "total_sleep": 30420,
    "awake": 2940,
    "light": 8190,
    "rem": 6780,
    "deep": 15450,
    "hr_lowest": 56,
    "hr_average": 61,
    "efficiency": 0.91,
    "latency": 900,
    "temperature_delta": -0.04,
    "average_hrv": 44,
    "respiratory_rate": 14.875,
    "standardized_sleep_score": 10,
    "source_specific_sleep_score": 88,
    "source": "oura", 
    "levels": [
        {
            "date_time": "2024-10-23T23:26:02",
            "level": "awake",
            "seconds": 300
        }, {
            "date_time": "2024-10-23T23:31:02",
            "level": "awake",
            "seconds": 300
        }, {
            ...EDITED...
        }, {
            "date_time": "2024-10-23T23:41:02",
            "level": "light",
            "seconds": 300
        }, {
            "date_time": "2024-10-23T23:46:02",
            "level": "light",
            "seconds": 300
        }, {
            "date_time": "2024-10-23T23:51:02",
            "level": "deep",
            "seconds": 300
        }, {
            "date_time": "2024-10-23T23:56:02",
            "level": "deep",
            "seconds": 300
        }, {
            ...EDITED...
        }, {
            "date_time": "2024-10-24T00:36:02",
            "level": "rem",
            "seconds": 300
        },
            ...EDITED...
        ]
   },
 ]
}
{
    "user_id": "fa1e3803-6068-4ea7-9788-eccce210d30c",
    "start_date": "2024-10-23",
    "end_date": "2024-10-24",
    "type": "sleep",
    "source": [
        {
            "name": "oura",
            "status": "ok"
        }
    ],
    "data": [{
    "date": "2024-10-24",
    "bedtime_start": "2024-10-23T23:26:02",
    "bedtime_end": "2024-10-24T08:13:37",
    "timezone_offset": 7200,
    "bedtime_duration": 33360,
    "total_sleep": 30420,
    "awake": 2940,
    "light": 8190,
    "rem": 6780,
    "deep": 15450,
    "hr_lowest": 56,
    "hr_average": 61,
    "efficiency": 0.91,
    "latency": 900,
    "temperature_delta": -0.04,
    "average_hrv": 44,
    "respiratory_rate": 14.875,
    "standardized_sleep_score": 10,
    "source_specific_sleep_score": 88,
    "source": "oura", 
    "levels": [
        {
            "date_time": "2024-10-23T23:26:02",
            "level": "awake",
            "seconds": 300
        }, {
            "date_time": "2024-10-23T23:31:02",
            "level": "awake",
            "seconds": 300
        }, {
            ...EDITED...
        }, {
            "date_time": "2024-10-23T23:41:02",
            "level": "light",
            "seconds": 300
        }, {
            "date_time": "2024-10-23T23:46:02",
            "level": "light",
            "seconds": 300
        }, {
            "date_time": "2024-10-23T23:51:02",
            "level": "deep",
            "seconds": 300
        }, {
            "date_time": "2024-10-23T23:56:02",
            "level": "deep",
            "seconds": 300
        }, {
            ...EDITED...
        }, {
            "date_time": "2024-10-24T00:36:02",
            "level": "rem",
            "seconds": 300
        },
            ...EDITED...
        ]
   },
 ]
}
﻿
On older Apple devices that don't support sleep phases, unknown phase appears. It returns "inBed" or "asleepUnspecified" status.
﻿
FieldsSleep.dateType: String
Format: YYYY-MM-DD
Example: 2021-05-01
The date when the sleep period ended
Sleep.bedtime_startType: String
Format: Date time, YYYY-MM-DDThh:mm:ss
Example: 2021-05-01T01:12:13
Local time when the sleep period started
Sleep.bedtime_endType: String
Format: Date time, YYYY-MM-DDThh:mm:ss
Example: 2021-05-01T09:36:13
Local time when the sleep period ended
Sleep.timezone_offsetType: Int
Unit: Seconds
Example: 2400
Time zone offset from UTC as seconds
Sleep.bedtime_durationType: Int
Unit: Seconds
Example: 28000
Total duration of the sleep period (duration = bedtime_end - bedtime_start)
Sleep.total_sleepType: Int
Unit: Seconds
Example: 26000
Total amount of sleep registered during the sleep period (total = rem + light + deep)
Sleep.awakeType: Int
Unit: Seconds
Example: 2800
Total amount of awake time registered during the sleep period
Sleep.lightType: Int
Unit: Seconds
Example: 18000
Total amount of light sleep registered during the sleep period
Sleep.remType: Int
Unit: Seconds
Example: 5000
Total amount of rem sleep registered during the sleep period
Sleep.deepType: Int
Unit: Seconds
Example: 3000
Total amount of deep sleep registered during the sleep period
Sleep.hr_lowestType: Int
Unit: Beats per minute
Example: 50
The lowest heart rate (5 minutes sliding average) registered during the sleep period
Sleep.hr_averageType: Int
Unit: Beats per minute
Example: 55
The average heart rate registered during the sleep period
Sleep.efficiencyType: Float
Range: 0.0 - 1.0
Example: 0.9
Sleep efficiency is the coefficient of the sleep period spent asleep (total_sleep / bedtime_duration)
Sleep.latencyType: Int
Unit: Seconds
Example: 758
Detected latency from bedtime_start to the beginning of the first five minutes of persistent sleep
Sleep.temperature_deltaType: Float
Unit: Celcius
Example: -0.1
Skin temperature deviation from the long-term temperature average
Sleep.average_hrvType: Int
Unit: Milliseconds
Example: 78
The average HRV(Heart Rate Variability) calculated with rMSSD method
Sleep.respiratory_rateType: Float
Unit: Breaths per minute
Example: 14
Average respiratory rate
Sleep.standardized_sleep_scoreType: Int
Range: 0-100
Example: 88
Standardized sleep score
Sleep.source_specific_sleep_scoreType: Int
Range: 0-100
Example: 88
Specific sleep score by data provider
Sleep.levels.date_timeType: String
Format: Date time, YYYY-MM-DDThh:mm:ss
Example: 2021-05-01T01:52:13
Date and time the user started in sleep level
Sleep.levels.levelType: String
Values: deep | light | rem | awake
The sleep level the user entered
Sleep.levels.secondsType: Int
Unit: Seconds
Example: 320
The length of time the user was in the sleep level
<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">Sleep.date</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: YYYY-MM-DD</li>
    <li class="list">Example: 2021-05-01</li>
</ul><p class="description">The date when the sleep period ended</p>

<h3 class="h3">Sleep.bedtime_start</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-01T01:12:13</li>
</ul><p class="description">Local time when the sleep period started</p>

<h3 class="h3">Sleep.bedtime_end</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>
</ul><p class="description">Local time when the sleep period ended</p>

<h3 class="h3">Sleep.timezone_offset</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 2400</li>
</ul><p class="description">Time zone offset from UTC as seconds</p>

<h3 class="h3">Sleep.bedtime_duration</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 28000</li>
</ul><p class="description">Total duration of the sleep period (duration = bedtime_end - bedtime_start)</p>

<h3 class="h3">Sleep.total_sleep</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 26000</li>
</ul><p class="description">Total amount of sleep registered during the sleep period (total = rem + light + deep)</p>

<h3 class="h3">Sleep.awake</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 2800</li>
</ul><p class="description">Total amount of awake time registered during the sleep period</p>

<h3 class="h3">Sleep.light</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 18000</li>
</ul><p class="description">Total amount of light sleep registered during the sleep period</p>

<h3 class="h3">Sleep.rem</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 5000</li>
</ul><p class="description">Total amount of rem sleep registered during the sleep period</p>

<h3 class="h3">Sleep.deep</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 3000</li>
</ul><p class="description">Total amount of deep sleep registered during the sleep period</p>

<h3 class="h3">Sleep.hr_lowest</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Beats per minute</li>
    <li class="list">Example: 50</li>
</ul><p class="description">The lowest heart rate (5 minutes sliding average) registered during the sleep period</p>

<h3 class="h3">Sleep.hr_average</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Beats per minute</li>
    <li class="list">Example: 55</li>
</ul><p class="description">The average heart rate registered during the sleep period</p>

<h3 class="h3">Sleep.efficiency</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Range: 0.0 - 1.0</li>
    <li class="list">Example: 0.9</li>
</ul><p class="description">Sleep efficiency is the coefficient of the sleep period spent asleep (total_sleep / bedtime_duration)</p>

<h3 class="h3">Sleep.latency</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 758</li>
</ul><p class="description">Detected latency from bedtime_start to the beginning of the first five minutes of persistent sleep</p>

<h3 class="h3">Sleep.temperature_delta</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Unit: Celcius</li>
    <li class="list">Example: -0.1</li>
</ul><p class="description">Skin temperature deviation from the long-term temperature average</p>

<h3 class="h3">Sleep.average_hrv</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Milliseconds</li>
    <li class="list">Example: 78</li>
</ul><p class="description">The average HRV(Heart Rate Variability) calculated with rMSSD method</p>

<h3 class="h3">Sleep.respiratory_rate</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Unit: Breaths per minute</li>
    <li class="list">Example: 14</li>
</ul><p class="description">Average respiratory rate</p>

<h3 class="h3">Sleep.standardized_sleep_score</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Range: 0-100</li>
    <li class="list">Example: 88</li>
</ul><p class="description">Standardized sleep score</p>

<h3 class="h3">Sleep.source_specific_sleep_score</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Range: 0-100</li>
    <li class="list">Example: 88</li>
</ul><p class="description">Specific sleep score by data provider</p>

<h3 class="h3">Sleep.levels.date_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-01T01:52:13</li>
</ul><p class="description">Date and time the user started in sleep level</p>

<h3 class="h3">Sleep.levels.level</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Values: deep | light | rem | awake</li>
</ul><p class="description">The sleep level the user entered</p>

<h3 class="h3">Sleep.levels.seconds</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 320</li>
</ul><p class="description">The length of time the user was in the sleep level</p>

<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">Sleep.date</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: YYYY-MM-DD</li>
    <li class="list">Example: 2021-05-01</li>
</ul><p class="description">The date when the sleep period ended</p>

<h3 class="h3">Sleep.bedtime_start</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-01T01:12:13</li>
</ul><p class="description">Local time when the sleep period started</p>

<h3 class="h3">Sleep.bedtime_end</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>
</ul><p class="description">Local time when the sleep period ended</p>

<h3 class="h3">Sleep.timezone_offset</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 2400</li>
</ul><p class="description">Time zone offset from UTC as seconds</p>

<h3 class="h3">Sleep.bedtime_duration</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 28000</li>
</ul><p class="description">Total duration of the sleep period (duration = bedtime_end - bedtime_start)</p>

<h3 class="h3">Sleep.total_sleep</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 26000</li>
</ul><p class="description">Total amount of sleep registered during the sleep period (total = rem + light + deep)</p>

<h3 class="h3">Sleep.awake</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 2800</li>
</ul><p class="description">Total amount of awake time registered during the sleep period</p>

<h3 class="h3">Sleep.light</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 18000</li>
</ul><p class="description">Total amount of light sleep registered during the sleep period</p>

<h3 class="h3">Sleep.rem</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 5000</li>
</ul><p class="description">Total amount of rem sleep registered during the sleep period</p>

<h3 class="h3">Sleep.deep</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 3000</li>
</ul><p class="description">Total amount of deep sleep registered during the sleep period</p>

<h3 class="h3">Sleep.hr_lowest</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Beats per minute</li>
    <li class="list">Example: 50</li>
</ul><p class="description">The lowest heart rate (5 minutes sliding average) registered during the sleep period</p>

<h3 class="h3">Sleep.hr_average</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Beats per minute</li>
    <li class="list">Example: 55</li>
</ul><p class="description">The average heart rate registered during the sleep period</p>

<h3 class="h3">Sleep.efficiency</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Range: 0.0 - 1.0</li>
    <li class="list">Example: 0.9</li>
</ul><p class="description">Sleep efficiency is the coefficient of the sleep period spent asleep (total_sleep / bedtime_duration)</p>

<h3 class="h3">Sleep.latency</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 758</li>
</ul><p class="description">Detected latency from bedtime_start to the beginning of the first five minutes of persistent sleep</p>

<h3 class="h3">Sleep.temperature_delta</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Unit: Celcius</li>
    <li class="list">Example: -0.1</li>
</ul><p class="description">Skin temperature deviation from the long-term temperature average</p>

<h3 class="h3">Sleep.average_hrv</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Milliseconds</li>
    <li class="list">Example: 78</li>
</ul><p class="description">The average HRV(Heart Rate Variability) calculated with rMSSD method</p>

<h3 class="h3">Sleep.respiratory_rate</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Unit: Breaths per minute</li>
    <li class="list">Example: 14</li>
</ul><p class="description">Average respiratory rate</p>

<h3 class="h3">Sleep.standardized_sleep_score</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Range: 0-100</li>
    <li class="list">Example: 88</li>
</ul><p class="description">Standardized sleep score</p>

<h3 class="h3">Sleep.source_specific_sleep_score</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Range: 0-100</li>
    <li class="list">Example: 88</li>
</ul><p class="description">Specific sleep score by data provider</p>

<h3 class="h3">Sleep.levels.date_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-01T01:52:13</li>
</ul><p class="description">Date and time the user started in sleep level</p>

<h3 class="h3">Sleep.levels.level</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Values: deep | light | rem | awake</li>
</ul><p class="description">The sleep level the user entered</p>

<h3 class="h3">Sleep.levels.seconds</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 320</li>
</ul><p class="description">The length of time the user was in the sleep level</p>
﻿
﻿
Did this page help you?
Activities Summary
Daily Calories