GET

/v2/timeseries/{user_id}/caffeine

x-vital-api-key*
curl --request GET \
     --url {{BASE_URL}}/v2/timeseries/{user_id}/caffeine?start_date={{START_DATE}}&end_date={{END_DATE}} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

[
  {
    "id": null,
    "timestamp": "2022-04-20T13:02:01.123771+00:00",
    "start": "2022-04-20T13:02:01.123771+00:00",
    "end": "2022-04-20T13:03:01.123771+00:00",
    "value": 42,
    "type": null,
    "unit": "g"
  }
]

Path Parameters

user_idrequired
string

Query Parameters

resourcerequired
enum<string>

The REST API name of timeseries resources Should match vital_core.ee.schemas.webhook.ClientFacingResource unless there is a strong reason not to.

Available options:
calories_active,
calories_basal,
distance,
blood_oxygen,
blood_pressure,
body/fat,
body/weight,
cholesterol,
cholesterol/ldl,
cholesterol/hdl,
cholesterol/total,
cholesterol/triglycerides,
floors_climbed,
glucose,
heartrate,
hrv,
heartrate_variability,
hypnogram,
ige,
igg,
respiratory_rate,
steps,
stress_level,
vo2_max,
water,
caffeine,
mindfulness_minutes
provider
Default: ""
string

Provider oura/strava etc

start_daterequired
string

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

end_date
string

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

200 - application/json
endrequired
string

The end timestamp of the measurement.

id
integer

Measurement id. Note, this field has been deprecated and is no longer used

startrequired
string

The start timestamp of the measurement.

timestamprequired
string

Depracated. The timestamp of the measurement.

timezone_offset
integer

Time zone UTC offset of the measurement. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.

type
string

The reading type of the measurement. This is applicable only to Cholesterol, IGG and IGE.

unitrequired
string

Measured in grams.

valuerequired
number

Quantity of caffeine consumed during the time period.