Series Types

Using seriesType

Use any key from the exported SERIES_TYPES constant as a seriesType in:

• time-series queries
• storage policy rules
• SDK push payloads

import { SERIES_TYPES, type SeriesType } from "@clipin/convex-wearables";

const metric: SeriesType = "heart_rate";
console.log(SERIES_TYPES.heart_rate);
// { id: 1, unit: "bpm" }

Common categories

Heart and cardiovascular

• heart_rate
• resting_heart_rate
• heart_rate_variability_sdnn
• heart_rate_variability_rmssd
• heart_rate_recovery_one_minute
• walking_heart_rate_average
• recovery_score

Blood and respiratory

• oxygen_saturation
• blood_glucose
• blood_pressure_systolic
• blood_pressure_diastolic
• respiratory_rate
• sleeping_breathing_disturbances
• blood_alcohol_content
• peripheral_perfusion_index
• forced_vital_capacity
• forced_expiratory_volume_1
• peak_expiratory_flow_rate

Body composition

• height
• weight
• body_fat_percentage
• body_mass_index
• lean_body_mass
• body_temperature
• skin_temperature
• waist_circumference
• body_fat_mass
• skeletal_muscle_mass

Fitness

• vo2_max
• six_minute_walk_test_distance

Activity

• steps
• energy
• basal_energy
• stand_time
• exercise_time
• physical_effort
• flights_climbed
• average_met
• distance_walking_running
• distance_cycling
• distance_swimming
• distance_downhill_snow_sports
• distance_other

Walking, running, and swimming detail

• walking_step_length
• walking_speed
• running_power
• running_speed
• running_stride_length
• swimming_stroke_count
• underwater_depth

Environmental

• environmental_audio_exposure
• headphone_audio_exposure
• time_in_daylight
• water_temperature
• uv_exposure
• weather_temperature
• weather_humidity

Garmin-specific

• garmin_stress_level
• garmin_skin_temperature
• garmin_fitness_age
• garmin_body_battery

Practical guidance

• Use a provider-specific rule when a metric behaves very differently by provider.
• Keep sparse metrics like weight or body_fat_percentage raw forever unless you have a hard retention requirement.
• Apply rollups first to dense metrics like heart_rate, steps, oxygen_saturation, or provider-specific stress/body battery signals.

For storage and retention examples, see Storage Policies.