Get Sleep Metrics
curl --request GET \
--url https://api.example.com/api/v1/sleep_metrics/{user_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/sleep_metrics/{user_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/sleep_metrics/{user_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/sleep_metrics/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/sleep_metrics/{user_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/sleep_metrics/{user_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/sleep_metrics/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Get Sleep Metrics
Get detailed sleep and recovery metrics including:
- Sleep stage distribution (deep, light, REM)
- Sleep latency and WASO
- Sleep efficiency
- Night events (out-of-bed counts)
GET
/
api
/
v1
/
sleep_metrics
/
{user_id}
Get Sleep Metrics
curl --request GET \
--url https://api.example.com/api/v1/sleep_metrics/{user_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/sleep_metrics/{user_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/sleep_metrics/{user_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/sleep_metrics/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/sleep_metrics/{user_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/sleep_metrics/{user_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/sleep_metrics/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get Sleep Metrics
Get detailed sleep and recovery metrics including sleep stage distribution (deep, light, REM), sleep latency and WASO, sleep efficiency, and night events (out-of-bed counts).Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| authorization | string | Yes | API authorization token (Bearer token) |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | Yes | The ID of the patient |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| days | integer | No | Number of past days to fetch data for (default: 7) |
Responses
| Status | Description | Content Type |
|---|---|---|
| 200 | Successful Response | application/json |
| 422 | Validation Error | application/json |
Sample Request
curl -X GET "https://api.covita.com/api/v1/sleep_metrics/User1?days=7" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Sample Response
{
"user_id": "User1",
"days": 7,
"sleep_metrics": {
"average_sleep_duration": 7.2,
"average_sleep_efficiency": 83.5,
"sleep_stages": {
"deep_sleep_percentage": 20,
"light_sleep_percentage": 55,
"rem_sleep_percentage": 25
},
"sleep_latency_minutes": 12,
"waso_minutes": 45,
"out_of_bed_events": 1.5
},
"daily_breakdown": [
{
"date": "2023-08-15",
"deep_sleep_minutes": 90,
"light_sleep_minutes": 248,
"rem_sleep_minutes": 112,
"sleep_latency": 10,
"waso": 40,
"out_of_bed_count": 1
}
]
}
⌘I