curl --request GET \
--url {{BASE_URL}}/v2/timeseries/{user_id}/carbohydrates/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.carbohydrates_grouped(
user_id="<user_id>",
start_date="2021-10-01",
end_date="2021-10-02"
)
import { VitalClient, VitalEnvironment } from '@tryvital/vital-node';
import { VitalsCarbohydratesGroupedRequest } from '@tryvital/vital-node/api/resources/vitals';
const client = new VitalClient({
apiKey: '<my_api_key>',
environment: VitalEnvironment.Sandbox,
});
const request: VitalsCarbohydratesGroupedRequest = {
startDate: "2022-05-01",
endDate: "2022-06-01"
}
const data = await client.vitals.carbohydratesGrouped(
'<my_user_id>',
request
);
import com.vital.api.Vital;
import com.vital.api.core.Environment;
import com.vital.api.resources.vitals.requests.VitalsCarbohydratesGroupedRequest;
Vital vital = Vital.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
VitalsCarbohydratesGroupedRequest request = VitalsCarbohydratesGroupedRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build();
var data = vital.vitals().carbohydratesGrouped("<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.VitalsCarbohydratesGroupedRequest{
StartDate: "2022-05-01",
EndDate: &EndDate,
}
response, err := client.Vitals.CarbohydratesGrouped(context.TODO(), "*", request)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"groups": {
"oura": [
{
"data": [
{
"end": "2023-02-13T14:30:52+00:00",
"start": "2023-02-13T14:30:52+00:00",
"unit": "g",
"value": 30
}
],
"source": {
"provider": "oura",
"type": "ring"
}
}
]
}
}
Nutrition Timeseries
Carbohydrates
GET
/
v2
/
timeseries
/
{user_id}
/
carbohydrates
/
grouped
curl --request GET \
--url {{BASE_URL}}/v2/timeseries/{user_id}/carbohydrates/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.carbohydrates_grouped(
user_id="<user_id>",
start_date="2021-10-01",
end_date="2021-10-02"
)
import { VitalClient, VitalEnvironment } from '@tryvital/vital-node';
import { VitalsCarbohydratesGroupedRequest } from '@tryvital/vital-node/api/resources/vitals';
const client = new VitalClient({
apiKey: '<my_api_key>',
environment: VitalEnvironment.Sandbox,
});
const request: VitalsCarbohydratesGroupedRequest = {
startDate: "2022-05-01",
endDate: "2022-06-01"
}
const data = await client.vitals.carbohydratesGrouped(
'<my_user_id>',
request
);
import com.vital.api.Vital;
import com.vital.api.core.Environment;
import com.vital.api.resources.vitals.requests.VitalsCarbohydratesGroupedRequest;
Vital vital = Vital.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
VitalsCarbohydratesGroupedRequest request = VitalsCarbohydratesGroupedRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build();
var data = vital.vitals().carbohydratesGrouped("<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.VitalsCarbohydratesGroupedRequest{
StartDate: "2022-05-01",
EndDate: &EndDate,
}
response, err := client.Vitals.CarbohydratesGrouped(context.TODO(), "*", request)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"groups": {
"oura": [
{
"data": [
{
"end": "2023-02-13T14:30:52+00:00",
"start": "2023-02-13T14:30:52+00:00",
"unit": "g",
"value": 30
}
],
"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}/carbohydrates/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.carbohydrates_grouped(
user_id="<user_id>",
start_date="2021-10-01",
end_date="2021-10-02"
)
import { VitalClient, VitalEnvironment } from '@tryvital/vital-node';
import { VitalsCarbohydratesGroupedRequest } from '@tryvital/vital-node/api/resources/vitals';
const client = new VitalClient({
apiKey: '<my_api_key>',
environment: VitalEnvironment.Sandbox,
});
const request: VitalsCarbohydratesGroupedRequest = {
startDate: "2022-05-01",
endDate: "2022-06-01"
}
const data = await client.vitals.carbohydratesGrouped(
'<my_user_id>',
request
);
import com.vital.api.Vital;
import com.vital.api.core.Environment;
import com.vital.api.resources.vitals.requests.VitalsCarbohydratesGroupedRequest;
Vital vital = Vital.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
VitalsCarbohydratesGroupedRequest request = VitalsCarbohydratesGroupedRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build();
var data = vital.vitals().carbohydratesGrouped("<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.VitalsCarbohydratesGroupedRequest{
StartDate: "2022-05-01",
EndDate: &EndDate,
}
response, err := client.Vitals.CarbohydratesGrouped(context.TODO(), "*", request)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"groups": {
"oura": [
{
"data": [
{
"end": "2023-02-13T14:30:52+00:00",
"start": "2023-02-13T14:30:52+00:00",
"unit": "g",
"value": 30
}
],
"source": {
"provider": "oura",
"type": "ring"
}
}
]
}
}
Query Parameters
Response
Successful Response
Was this page helpful?