Preparing search index...
The search index is not available
terra-api
terra-api
models/Body
Body
Interface Body
Hierarchy
Body
Index
Properties
blood_
pressure_
data
device_
data
glucose_
data
heart_
data
hydration_
data
ketone_
data
measurements_
data
metadata
oxygen_
data
temperature_
data
Properties
blood_
pressure_
data
blood_
pressure_
data
:
{
blood_pressure_samples
:
BloodPressureSample
[]
}
Type declaration
blood_
pressure_
samples
:
BloodPressureSample
[]
device_
data
device_
data
:
{
activation_timestamp
:
Option
<
string
>
;
hardware_version
:
Option
<
string
>
;
manufacturer
:
Option
<
string
>
;
name
:
Option
<
string
>
;
other_devices
:
OtherDeviceData
[]
;
serial_number
:
Option
<
string
>
;
software_version
:
Option
<
string
>
}
Type declaration
activation_
timestamp
:
Option
<
string
>
hardware_
version
:
Option
<
string
>
manufacturer
:
Option
<
string
>
name
:
Option
<
string
>
other_
devices
:
OtherDeviceData
[]
serial_
number
:
Option
<
string
>
software_
version
:
Option
<
string
>
glucose_
data
glucose_
data
:
{
blood_glucose_samples
:
GlucoseDataSample
[]
;
day_avg_blood_glucose_mg_per_dL
:
Option
<
number
>
;
detailed_blood_glucose_samples
:
GlucoseDataSample
[]
}
Type declaration
blood_
glucose_
samples
:
GlucoseDataSample
[]
day_
avg_
blood_
glucose_
mg_
per_
dL
:
Option
<
number
>
detailed_
blood_
glucose_
samples
:
GlucoseDataSample
[]
heart_
data
heart_
data
:
{
afib_classification_samples
:
AFibClassificationSample
[]
;
ecgsignal
:
ECGreading
[]
;
heart_rate_data
:
{
detailed
:
{
hr_samples
:
HeartRateDataSample
[]
;
hrv_samples_rmssd
:
HeartRateVariabilityDataSampleRMSSD
[]
;
hrv_samples_sdnn
:
HeartRateVariabilityDataSampleSDNN
[]
}
;
summary
:
{
avg_hr_bpm
:
Option
<
number
>
;
avg_hrv_rmssd
:
Option
<
number
>
;
avg_hrv_sdnn
:
Option
<
number
>
;
max_hr_bpm
:
Option
<
number
>
;
min_hr_bpm
:
Option
<
number
>
;
resting_hr_bpm
:
Option
<
number
>
;
user_max_hr_bpm
:
Option
<
number
>
}
}
;
pulse_wave_velocity_samples
:
PulseVelocitySample
[]
}
Type declaration
afib_
classification_
samples
:
AFibClassificationSample
[]
ecgsignal
:
ECGreading
[]
heart_
rate_
data
:
{
detailed
:
{
hr_samples
:
HeartRateDataSample
[]
;
hrv_samples_rmssd
:
HeartRateVariabilityDataSampleRMSSD
[]
;
hrv_samples_sdnn
:
HeartRateVariabilityDataSampleSDNN
[]
}
;
summary
:
{
avg_hr_bpm
:
Option
<
number
>
;
avg_hrv_rmssd
:
Option
<
number
>
;
avg_hrv_sdnn
:
Option
<
number
>
;
max_hr_bpm
:
Option
<
number
>
;
min_hr_bpm
:
Option
<
number
>
;
resting_hr_bpm
:
Option
<
number
>
;
user_max_hr_bpm
:
Option
<
number
>
}
}
detailed
:
{
hr_samples
:
HeartRateDataSample
[]
;
hrv_samples_rmssd
:
HeartRateVariabilityDataSampleRMSSD
[]
;
hrv_samples_sdnn
:
HeartRateVariabilityDataSampleSDNN
[]
}
hr_
samples
:
HeartRateDataSample
[]
hrv_
samples_
rmssd
:
HeartRateVariabilityDataSampleRMSSD
[]
hrv_
samples_
sdnn
:
HeartRateVariabilityDataSampleSDNN
[]
summary
:
{
avg_hr_bpm
:
Option
<
number
>
;
avg_hrv_rmssd
:
Option
<
number
>
;
avg_hrv_sdnn
:
Option
<
number
>
;
max_hr_bpm
:
Option
<
number
>
;
min_hr_bpm
:
Option
<
number
>
;
resting_hr_bpm
:
Option
<
number
>
;
user_max_hr_bpm
:
Option
<
number
>
}
avg_
hr_
bpm
:
Option
<
number
>
avg_
hrv_
rmssd
:
Option
<
number
>
avg_
hrv_
sdnn
:
Option
<
number
>
max_
hr_
bpm
:
Option
<
number
>
min_
hr_
bpm
:
Option
<
number
>
resting_
hr_
bpm
:
Option
<
number
>
user_
max_
hr_
bpm
:
Option
<
number
>
pulse_
wave_
velocity_
samples
:
PulseVelocitySample
[]
hydration_
data
hydration_
data
:
{
day_total_water_consumption_ml
:
Option
<
number
>
;
hydration_amount_samples
:
HydrationLevelSample
[]
;
hydration_level_samples
:
HydrationMeasurementSample
[]
}
Type declaration
day_
total_
water_
consumption_
ml
:
Option
<
number
>
hydration_
amount_
samples
:
HydrationLevelSample
[]
hydration_
level_
samples
:
HydrationMeasurementSample
[]
ketone_
data
ketone_
data
:
{
ketone_samples
:
KetoneDataSample
[]
}
Type declaration
ketone_
samples
:
KetoneDataSample
[]
measurements_
data
measurements_
data
:
{
measurements
:
MeasurementDataSample
[]
}
Type declaration
measurements
:
MeasurementDataSample
[]
metadata
metadata
:
{
end_time
:
string
;
start_time
:
string
}
Type declaration
end_
time
:
string
start_
time
:
string
oxygen_
data
oxygen_
data
:
{
avg_saturation_percentage
:
Option
<
number
>
;
saturation_samples
:
OxygenSaturationSample
[]
;
vo2_samples
:
Vo2MaxSample
[]
;
vo2max_ml_per_min_per_kg
:
Option
<
number
>
}
Type declaration
avg_
saturation_
percentage
:
Option
<
number
>
saturation_
samples
:
OxygenSaturationSample
[]
vo2_
samples
:
Vo2MaxSample
[]
vo2max_
ml_
per_
min_
per_
kg
:
Option
<
number
>
temperature_
data
temperature_
data
:
{
ambient_temperature_samples
:
TemperatureSample
[]
;
body_temperature_samples
:
TemperatureSample
[]
;
skin_temperature_samples
:
TemperatureSample
[]
}
Type declaration
ambient_
temperature_
samples
:
TemperatureSample
[]
body_
temperature_
samples
:
TemperatureSample
[]
skin_
temperature_
samples
:
TemperatureSample
[]
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
terra-
api
API/
Athlete
API/
Auth
User
API/
Data
API/
Generate
Auth
Token
API/
Generate
Widget
Sessions
API/
Helpers
API/
Providers
API/
Subscribers
API/
Terra
API/
User
Info
API/
Webhook
Events
models/
Activity
models/
Athlete
models/
Body
models/
Daily
models/
Menstruation
models/
Nutrition
models/
Sleep
models/
Terra
User
models/enums/AFib
Flag
models/enums/
Activity
Level
models/enums/
Activity
Type
models/enums/
Glucose
Flag
models/enums/
Heart
Rate
Zone
models/enums/
Ketone
Sample
Type
models/enums/
Menstruation
Flow
models/enums/
Nutrition
Units
models/enums/
Recovery
Level
models/enums/
Sleep
Level
models/enums/
Sleep
Upload
Type
models/enums/
Stroke
Type
models/enums/
Trend
Arrow
models/enums/
Upload
Type
models/samples/AFib
Classification
Sample
models/samples/
Activity
Level
Sample
models/samples/
Blood
Pressure
Sample
models/samples/
Breath
Sample
models/samples/
Cadence
Sample
models/samples/
Calorie
Sample
models/samples/
Distance
Sample
models/samples/ECGReading
models/samples/
Elevation
Sample
models/samples/
Floors
Climbed
Sample
models/samples/
Glucose
Data
Sample
models/samples/
Heart
Rate
Data
Sample
models/samples/
Heart
Rate
Variability
Data
SampleRMSSD
models/samples/
Heart
Rate
Variability
Data
SampleSDNN
models/samples/
Heart
Rate
Zone
Data
models/samples/
Hydration
Level
Sample
models/samples/
Hydration
Measurement
Sample
models/samples/
Ketone
Data
Sample
models/samples/
Lap
Sample
models/samples/METSample
models/samples/
Meal
models/samples/
Measurement
Data
Sample
models/samples/
Menstruation
Flow
Sample
models/samples/
Other
Device
Data
models/samples/
Oxygen
Saturation
Sample
models/samples/
Position
Sample
models/samples/
Power
Sample
models/samples/
Pulse
Velocity
Sample
models/samples/
RawECGSample
models/samples/
Sleep
Hypnogram
Sample
models/samples/
Snoring
Sample
models/samples/
Speed
Sample
models/samples/
Step
Sample
models/samples/
Stress
Sample
models/samples/TSSSample
models/samples/
Tag
Entry
models/samples/
Temperature
Sample
models/samples/
Vo2
Max
Sample
Body
blood_
pressure_
data
device_
data
glucose_
data
heart_
data
hydration_
data
ketone_
data
measurements_
data
metadata
oxygen_
data
temperature_
data
Generated using
TypeDoc