curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.sleep.get(
"<user_id>",
start_date="2021-01-01",
end_date="2021-01-02",
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.sleep.get({
userId: "<user_id>",
startDate: "2021-01-01",
endDate: "2021-01-02",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.sleep.requests.GetSleepRequest;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.sleep().get(
"<user_id>",
GetSleepRequest.builder()
.startDate("2021-01-01")
.endDate("2021-01-02")
.build()
);
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
endDate := "2021-01-02"
response, err := c.Sleep.Get(context.TODO(), &junction.GetSleepRequest{
UserId: "<user_id>",
StartDate: "2021-01-01",
EndDate: &endDate,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"sleep": [
{
"average_hrv": 78,
"awake": 2400,
"bedtime_start": "2023-02-27T12:31:24+00:00",
"bedtime_stop": "2023-02-27T12:31:24+00:00",
"calendar_date": "2023-02-27",
"created_at": "2023-02-27T20:31:24+00:00",
"date": "2023-02-27T12:31:24+00:00",
"deep": 2400,
"duration": 28800,
"efficiency": 0.97,
"hr_average": 50,
"hr_lowest": 43,
"id": "e2e0eb04-6641-4858-9de5-649efb41b346",
"latency": 1000,
"light": 2400,
"recovery_readiness_score": 82,
"rem": 2400,
"respiratory_rate": 14,
"skin_temperature": 36.5,
"source": {
"device_id": "550e8400-e29b-41d4-a716-446655440000",
"provider": "oura",
"type": "unknown"
},
"temperature_delta": -0.2,
"timezone_offset": 2400,
"total": 28800,
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
]
}{
"detail": "<unknown>"
}Sleep
Summary
Retrieve processed sleep summary data for a specific user, including duration, efficiency, and quality scores.
GET
/
v2
/
summary
/
sleep
/
{user_id}
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.sleep.get(
"<user_id>",
start_date="2021-01-01",
end_date="2021-01-02",
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.sleep.get({
userId: "<user_id>",
startDate: "2021-01-01",
endDate: "2021-01-02",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.sleep.requests.GetSleepRequest;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.sleep().get(
"<user_id>",
GetSleepRequest.builder()
.startDate("2021-01-01")
.endDate("2021-01-02")
.build()
);
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
endDate := "2021-01-02"
response, err := c.Sleep.Get(context.TODO(), &junction.GetSleepRequest{
UserId: "<user_id>",
StartDate: "2021-01-01",
EndDate: &endDate,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"sleep": [
{
"average_hrv": 78,
"awake": 2400,
"bedtime_start": "2023-02-27T12:31:24+00:00",
"bedtime_stop": "2023-02-27T12:31:24+00:00",
"calendar_date": "2023-02-27",
"created_at": "2023-02-27T20:31:24+00:00",
"date": "2023-02-27T12:31:24+00:00",
"deep": 2400,
"duration": 28800,
"efficiency": 0.97,
"hr_average": 50,
"hr_lowest": 43,
"id": "e2e0eb04-6641-4858-9de5-649efb41b346",
"latency": 1000,
"light": 2400,
"recovery_readiness_score": 82,
"rem": 2400,
"respiratory_rate": 14,
"skin_temperature": 36.5,
"source": {
"device_id": "550e8400-e29b-41d4-a716-446655440000",
"provider": "oura",
"type": "unknown"
},
"temperature_delta": -0.2,
"timezone_offset": 2400,
"total": 28800,
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
]
}{
"detail": "<unknown>"
}curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.sleep.get(
"<user_id>",
start_date="2021-01-01",
end_date="2021-01-02",
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.sleep.get({
userId: "<user_id>",
startDate: "2021-01-01",
endDate: "2021-01-02",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.sleep.requests.GetSleepRequest;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.sleep().get(
"<user_id>",
GetSleepRequest.builder()
.startDate("2021-01-01")
.endDate("2021-01-02")
.build()
);
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
endDate := "2021-01-02"
response, err := c.Sleep.Get(context.TODO(), &junction.GetSleepRequest{
UserId: "<user_id>",
StartDate: "2021-01-01",
EndDate: &endDate,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
Provider oura/strava etc
Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
Response
Successful Response
Show child attributes
Show child attributes
Was this page helpful?
⌘I