curl --request GET \
--url {{BASE_URL}}/v2/timeseries/{user_id}/stress_level/grouped?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from vital.client import Vital
from vital.environment import VitalEnvironment
client = Vital(
api_key="YOUR_API_KEY",
environment=VitalEnvironment.SANDBOX
)
data = client.vitals.stress_level_grouped(
user_id="<user_id>",
start_date="2021-10-01",
end_date="2021-10-02"
)
import { VitalClient, VitalEnvironment } from '@tryvital/vital-node';
import { VitalsStressLevelGroupedRequest } from '@tryvital/vital-node/api/resources/vitals';
const client = new VitalClient({
apiKey: '<my_api_key>',
environment: VitalEnvironment.Sandbox,
});
const request: VitalsStressLevelGroupedRequest = {
startDate: "2022-05-01",
endDate: "2022-06-01"
}
const data = await client.vitals.stressLevelGrouped(
'<my_user_id>',
request
);
import com.vital.api.Vital;
import com.vital.api.core.Environment;
import com.vital.api.resources.vitals.requests.VitalsStressLevelGroupedRequest;
Vital vital = Vital.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
VitalsStressLevelGroupedRequest request = VitalsStressLevelGroupedRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build();
var data = vital.vitals().stressLevelGrouped("<user_id>", request);
import (
"context"
vital "github.com/tryVital/vital-go"
vitalclient "github.com/tryVital/vital-go/client"
)
client := vitalclient.NewClient(
vitalclient.WithApiKey("<YOUR_API_KEY>"),
vitalclient.WithBaseURL(vital.Environments.Sandbox),
)
EndDate := "2022-06-01"
request := &vital.VitalsStressLevelGroupedRequest{
StartDate: "2022-05-01",
EndDate: &EndDate,
}
response, err := client.Vitals.StressLevelGrouped(context.TODO(), "*", request)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"groups": {
"oura": [
{
"data": [
{
"timestamp": "2023-02-13T14:30:52+00:00",
"unit": "%",
"value": 35
}
],
"source": {
"provider": "oura",
"type": "ring"
}
}
]
}
}
Wellness Timeseries
Stress Level
GET
/
v2
/
timeseries
/
{user_id}
/
stress_level
/
grouped
curl --request GET \
--url {{BASE_URL}}/v2/timeseries/{user_id}/stress_level/grouped?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from vital.client import Vital
from vital.environment import VitalEnvironment
client = Vital(
api_key="YOUR_API_KEY",
environment=VitalEnvironment.SANDBOX
)
data = client.vitals.stress_level_grouped(
user_id="<user_id>",
start_date="2021-10-01",
end_date="2021-10-02"
)
import { VitalClient, VitalEnvironment } from '@tryvital/vital-node';
import { VitalsStressLevelGroupedRequest } from '@tryvital/vital-node/api/resources/vitals';
const client = new VitalClient({
apiKey: '<my_api_key>',
environment: VitalEnvironment.Sandbox,
});
const request: VitalsStressLevelGroupedRequest = {
startDate: "2022-05-01",
endDate: "2022-06-01"
}
const data = await client.vitals.stressLevelGrouped(
'<my_user_id>',
request
);
import com.vital.api.Vital;
import com.vital.api.core.Environment;
import com.vital.api.resources.vitals.requests.VitalsStressLevelGroupedRequest;
Vital vital = Vital.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
VitalsStressLevelGroupedRequest request = VitalsStressLevelGroupedRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build();
var data = vital.vitals().stressLevelGrouped("<user_id>", request);
import (
"context"
vital "github.com/tryVital/vital-go"
vitalclient "github.com/tryVital/vital-go/client"
)
client := vitalclient.NewClient(
vitalclient.WithApiKey("<YOUR_API_KEY>"),
vitalclient.WithBaseURL(vital.Environments.Sandbox),
)
EndDate := "2022-06-01"
request := &vital.VitalsStressLevelGroupedRequest{
StartDate: "2022-05-01",
EndDate: &EndDate,
}
response, err := client.Vitals.StressLevelGrouped(context.TODO(), "*", request)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"groups": {
"oura": [
{
"data": [
{
"timestamp": "2023-02-13T14:30:52+00:00",
"unit": "%",
"value": 35
}
],
"source": {
"provider": "oura",
"type": "ring"
}
}
]
}
}
View Full Response Schema »
The Response section on the page still needs work. Click here to check out the complete schema.
curl --request GET \
--url {{BASE_URL}}/v2/timeseries/{user_id}/stress_level/grouped?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from vital.client import Vital
from vital.environment import VitalEnvironment
client = Vital(
api_key="YOUR_API_KEY",
environment=VitalEnvironment.SANDBOX
)
data = client.vitals.stress_level_grouped(
user_id="<user_id>",
start_date="2021-10-01",
end_date="2021-10-02"
)
import { VitalClient, VitalEnvironment } from '@tryvital/vital-node';
import { VitalsStressLevelGroupedRequest } from '@tryvital/vital-node/api/resources/vitals';
const client = new VitalClient({
apiKey: '<my_api_key>',
environment: VitalEnvironment.Sandbox,
});
const request: VitalsStressLevelGroupedRequest = {
startDate: "2022-05-01",
endDate: "2022-06-01"
}
const data = await client.vitals.stressLevelGrouped(
'<my_user_id>',
request
);
import com.vital.api.Vital;
import com.vital.api.core.Environment;
import com.vital.api.resources.vitals.requests.VitalsStressLevelGroupedRequest;
Vital vital = Vital.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
VitalsStressLevelGroupedRequest request = VitalsStressLevelGroupedRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build();
var data = vital.vitals().stressLevelGrouped("<user_id>", request);
import (
"context"
vital "github.com/tryVital/vital-go"
vitalclient "github.com/tryVital/vital-go/client"
)
client := vitalclient.NewClient(
vitalclient.WithApiKey("<YOUR_API_KEY>"),
vitalclient.WithBaseURL(vital.Environments.Sandbox),
)
EndDate := "2022-06-01"
request := &vital.VitalsStressLevelGroupedRequest{
StartDate: "2022-05-01",
EndDate: &EndDate,
}
response, err := client.Vitals.StressLevelGrouped(context.TODO(), "*", request)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"groups": {
"oura": [
{
"data": [
{
"timestamp": "2023-02-13T14:30:52+00:00",
"unit": "%",
"value": 35
}
],
"source": {
"provider": "oura",
"type": "ring"
}
}
]
}
}
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
The cursor for fetching the next page, or null to fetch the first page.
The cursor for fetching the next page, or null to fetch the first page.
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
For each matching provider or lab, a list of grouped timeseries values.
Show child attributes
Show child attributes
The cursor for fetching the next page, or null if there is no more data.
The cursor for fetching the next page, or null if there is no more data.
Was this page helpful?
⌘I