Skip to main content
GET
Get trends

Authorizations

Authorization
string
header
required

Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT.

Query Parameters

metrics
enum<string>[]
required

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required array length: 1 - 20 elements
Available options:
measurement:weight,
measurement:height,
measurement:waist_circumference,
measurement:hip_circumference,
measurement:chest_circumference,
measurement:neck_circumference,
measurement:upper_arm_circumference,
measurement:thigh_circumference,
measurement:calf_circumference,
measurement:body_fat_percent,
measurement:fat_mass,
measurement:lean_mass,
measurement:fat_free_mass,
measurement:skeletal_muscle_mass,
measurement:appendicular_lean_mass,
measurement:body_water_percent,
measurement:total_body_water,
measurement:intracellular_water,
measurement:extracellular_water,
measurement:extracellular_total_water_ratio,
measurement:visceral_fat_area,
measurement:visceral_fat_level,
measurement:segmental_fat_mass,
measurement:segmental_lean_mass,
measurement:segmental_body_fat_percent,
measurement:phase_angle,
measurement:skinfold_thickness,
measurement:bmi,
measurement:waist_hip_ratio,
measurement:waist_height_ratio,
measurement:fat_mass_index,
measurement:fat_free_mass_index,
measurement:appendicular_lean_mass_index,
measurement:body_surface_area,
measurement:heart_rate,
measurement:heart_rate_recovery,
measurement:hrv_sdnn,
measurement:hrv_rmssd,
measurement:hrv_pnn50,
measurement:pulse_pressure,
measurement:mean_arterial_pressure,
measurement:pulse_wave_velocity,
measurement:ankle_brachial_index,
measurement:pr_interval,
measurement:qrs_duration,
measurement:qt_interval,
measurement:qtc_interval,
measurement:p_axis,
measurement:qrs_axis,
measurement:t_axis,
measurement:atrial_fibrillation_burden,
measurement:premature_ventricular_contraction_count,
measurement:left_ventricular_ejection_fraction,
measurement:global_longitudinal_strain,
measurement:oxygen_saturation,
measurement:respiratory_rate,
measurement:body_temperature,
measurement:skin_temperature,
measurement:skin_temperature_deviation,
measurement:peripheral_perfusion_index,
measurement:peak_expiratory_flow,
measurement:fev1,
measurement:fvc,
measurement:fev1_fvc_ratio,
measurement:fev1_vc_ratio,
measurement:fef25_75,
measurement:slow_vital_capacity,
measurement:total_lung_capacity,
measurement:residual_volume,
measurement:functional_residual_capacity,
measurement:diffusing_capacity_co,
measurement:carbon_monoxide_transfer_coefficient,
measurement:fractional_exhaled_nitric_oxide,
measurement:blood_glucose,
measurement:interstitial_glucose,
measurement:blood_beta_hydroxybutyrate,
measurement:blood_ketones,
measurement:breath_acetone,
measurement:vo2_max_absolute,
measurement:vo2_max_relative,
measurement:ventilatory_threshold_oxygen_uptake,
measurement:ventilatory_threshold_heart_rate,
measurement:ventilatory_threshold_power,
measurement:grip_strength,
measurement:gait_speed,
measurement:six_minute_walk_distance,
measurement:timed_up_and_go_duration,
measurement:sit_to_stand_repetitions,
measurement:sit_to_stand_duration,
measurement:single_leg_stance_duration,
measurement:bone_mineral_density_areal,
measurement:bone_mineral_content,
measurement:bone_density_t_score,
measurement:bone_density_z_score,
measurement:visual_acuity_snellen,
measurement:visual_acuity_logmar,
measurement:intraocular_pressure,
measurement:spherical_refraction,
measurement:cylindrical_refraction,
measurement:refraction_axis,
measurement:hearing_threshold,
measurement:cgm_summary,
measurement:ambulatory_bp_summary,
measurement:spirometry_summary,
measurement:body_composition_summary,
measurement:dxa_summary,
measurement:ecg_summary,
measurement:echocardiography_summary,
measurement:functional_test_summary,
lab:acth,
lab:active_b12_holotranscobalamin,
lab:albumin,
lab:albumin_globulin_ratio,
lab:aldosterone,
lab:aldosterone_renin_ratio,
lab:allergen_specific_ige,
lab:alp,
lab:alpha_fetoprotein,
lab:alt,
lab:aluminum,
lab:amh,
lab:ammonia,
lab:amylase,
lab:ana_pattern,
lab:ana_screen,
lab:ana_titer,
lab:anca_pattern,
lab:anca_screen,
lab:anca_titer,
lab:androstenedione,
lab:anion_gap,
lab:anti_beta2_glycoprotein_igg,
lab:anti_beta2_glycoprotein_igm,
lab:anti_cardiolipin_igg,
lab:anti_cardiolipin_igm,
lab:anti_ccp,
lab:anti_centromere,
lab:anti_dsdna,
lab:anti_factor_xa,
lab:anti_jo1,
lab:anti_mpo,
lab:anti_pr3,
lab:anti_rnp,
lab:anti_scl70,
lab:anti_smith,
lab:anti_ssa_ro,
lab:anti_ssb_la,
lab:antimicrobial_susceptibility,
lab:antithrombin_activity,
lab:apob_apoa1_ratio,
lab:apolipoprotein_a1,
lab:apolipoprotein_b,
lab:aptt,
lab:aptt_ratio,
lab:arsenic_inorganic,
lab:arsenic_total,
lab:ast,
lab:ast_alt_ratio,
lab:band_neutrophils_absolute,
lab:band_neutrophils_percent,
lab:base_excess,
lab:basophils_absolute,
lab:basophils_percent,
lab:beta2_microglobulin,
lab:beta_carotene,
lab:beta_ctx,
lab:beta_hydroxybutyrate,
lab:bicarbonate,
lab:bile_acids_total,
lab:bilirubin_direct,
lab:bilirubin_indirect,
lab:bilirubin_total,
lab:blood_gas_bicarbonate_standard,
lab:blood_gas_ph,
lab:blood_glucose,
lab:blood_group_abo,
lab:blood_ketones,
lab:bnp,
lab:bone_specific_alp,
lab:bun,
lab:bun_creatinine_ratio,
lab:c3_complement,
lab:c4_complement,
lab:c_peptide,
lab:ca_125,
lab:ca_15_3,
lab:ca_19_9,
lab:cadmium,
lab:calcitonin,
lab:calcium_ionized,
lab:calcium_total,
lab:calculated_osmolality,
lab:carbamazepine,
lab:carbon_dioxide_total,
lab:carboxyhemoglobin,
lab:cea,
lab:ceruloplasmin,
lab:ch50,
lab:chloride,
lab:chromium,
lab:ck_mb_activity,
lab:ck_mb_mass,
lab:copper,
lab:cortisol,
lab:cotinine,
lab:creatine_kinase,
lab:creatinine,
lab:creatinine_clearance,
lab:crp,
lab:cyclosporine,
lab:cystatin_c,
lab:d_dimer_ddu,
lab:d_dimer_feu,
lab:deamidated_gliadin_peptide_iga,
lab:deamidated_gliadin_peptide_igg,
lab:dengue_igg,
lab:dengue_igm,
lab:dengue_ns1_antigen,
lab:dheas,
lab:digoxin,
lab:direct_antiglobulin_test,
lab:drvvt_confirm_ratio,
lab:drvvt_screen_ratio,
lab:egfr,
lab:egfr_creatinine_cystatin_c,
lab:egfr_cystatin_c,
lab:endomysial_antibody_iga,
lab:eosinophils_absolute,
lab:eosinophils_percent,
lab:esr,
lab:estimated_average_glucose,
lab:estradiol,
lab:ethanol,
lab:fecal_calprotectin,
lab:fecal_fat_24h,
lab:fecal_fat_qualitative,
lab:fecal_lactoferrin,
lab:fecal_pancreatic_elastase,
lab:ferritin,
lab:fib4_reported,
lab:fibrin_degradation_products,
lab:fibrinogen_activity,
lab:fibrinogen_antigen,
lab:folate_rbc,
lab:folate_serum,
lab:free_t3,
lab:free_t4,
lab:fructosamine,
lab:fsh,
lab:g6pd_activity,
lab:gastrin,
lab:gastrointestinal_pathogen_pcr,
lab:gentamicin,
lab:ggt,
lab:globulin,
lab:glycated_albumin,
lab:growth_hormone,
lab:haptoglobin,
lab:hba1c,
lab:hcg_qualitative,
lab:hcg_quantitative,
lab:hdl_cholesterol,
lab:hdl_particle_number,
lab:hematocrit,
lab:hemoglobin,
lab:hemoglobin_a2_percent,
lab:hemoglobin_a_percent,
lab:hemoglobin_c_percent,
lab:hemoglobin_e_percent,
lab:hemoglobin_f_percent,
lab:hemoglobin_s_percent,
lab:hemoglobin_variant_identification,
lab:hemolysis_index,
lab:hepatitis_a_antibody_total,
lab:hepatitis_a_igm,
lab:hepatitis_b_core_antibody_igm,
lab:hepatitis_b_core_antibody_total,
lab:hepatitis_b_dna,
lab:hepatitis_b_e_antibody,
lab:hepatitis_b_e_antigen,
lab:hepatitis_b_surface_antibody,
lab:hepatitis_b_surface_antigen,
lab:hepatitis_c_antibody,
lab:hepatitis_c_rna,
lab:hiv_1_2_antigen_antibody,
lab:hiv_1_antibody,
lab:hiv_1_rna,
lab:hiv_2_antibody,
lab:homa_ir_reported,
lab:homocysteine,
lab:hs_crp,
lab:hs_troponin_i,
lab:hs_troponin_t,
lab:icterus_index,
lab:igf_1,
lab:immature_granulocytes_absolute,
lab:immature_granulocytes_percent,
lab:immature_reticulocyte_fraction,
lab:immunoglobulin_a,
lab:immunoglobulin_e_total,
lab:immunoglobulin_g,
lab:immunoglobulin_g1,
lab:immunoglobulin_g2,
lab:immunoglobulin_g3,
lab:immunoglobulin_g4,
lab:immunoglobulin_m,
lab:inhibin_b,
lab:inr,
lab:insulin,
lab:iodine,
lab:ionized_calcium_blood_gas,
lab:iron,
lab:lactate,
lab:ldh,
lab:ldl_cholesterol,
lab:ldl_hdl_ratio,
lab:ldl_particle_number,
lab:ldl_particle_size,
lab:lead,
lab:lh,
lab:lipase,
lab:lipemia_index,
lab:lipoprotein_a_mass,
lab:lipoprotein_a_molar,
lab:lithium,
lab:lupus_anticoagulant_screen,
lab:lymphocytes_absolute,
lab:lymphocytes_percent,
lab:magnesium,
lab:magnesium_rbc,
lab:malaria_parasite_test,
lab:manganese,
lab:mch,
lab:mchc,
lab:mcv,
lab:measured_osmolality,
lab:mercury_total,
lab:metanephrine_free,
lab:methemoglobin,
lab:methylmalonic_acid,
lab:molybdenum,
lab:monocytes_absolute,
lab:monocytes_percent,
lab:mpv,
lab:myoglobin,
lab:neutrophils_absolute,
lab:neutrophils_percent,
lab:non_hdl_cholesterol,
lab:normetanephrine_free,
lab:nt_probnp,
lab:nucleated_rbc_absolute,
lab:nucleated_rbc_per_100_wbc,
lab:organism_culture_identification,
lab:osteocalcin,
lab:oxygen_content,
lab:oxygen_saturation_blood_gas,
lab:pancreatic_amylase,
lab:parathyroid_hormone_intact,
lab:parathyroid_hormone_whole,
lab:partial_pressure_carbon_dioxide,
lab:partial_pressure_oxygen,
lab:pathogen_nucleic_acid,
lab:pdw,
lab:peripheral_smear_findings,
lab:phenytoin_free,
lab:phenytoin_total,
lab:phosphate,
lab:platelet_count,
lab:platelet_large_cell_ratio,
lab:platelet_morphology,
lab:plateletcrit,
lab:potassium,
lab:prealbumin,
lab:procalcitonin,
lab:procollagen_type_1_n_terminal_propeptide,
lab:progesterone,
lab:prolactin,
lab:protein_c_activity,
lab:protein_s_activity,
lab:prothrombin_time,
lab:psa_free,
lab:psa_free_total_ratio,
lab:psa_total,
lab:rbc_count,
lab:rbc_morphology,
lab:rdw_cv,
lab:rdw_sd,
lab:red_cell_antibody_identification,
lab:red_cell_antibody_screen,
lab:remnant_cholesterol,
lab:renin_activity,
lab:renin_concentration,
lab:respiratory_pathogen_pcr,
lab:reticulocyte_hemoglobin,
lab:reticulocytes_absolute,
lab:reticulocytes_percent,
lab:reverse_t3,
lab:rhd_type,
lab:rheumatoid_factor,
lab:rpr_qualitative,
lab:rpr_titer,
lab:selenium,
lab:semen_leukocytes,
lab:semen_liquefaction_time,
lab:semen_ph,
lab:semen_viscosity,
lab:semen_volume,
lab:seventeen_hydroxyprogesterone,
lab:shbg,
lab:sirolimus,
lab:small_ldl_particle_number,
lab:sodium,
lab:soluble_transferrin_receptor,
lab:sperm_agglutination,
lab:sperm_concentration,
lab:sperm_dna_fragmentation_index,
lab:sperm_immotile_percent,
lab:sperm_nonprogressive_motility,
lab:sperm_normal_morphology,
lab:sperm_progressive_motility,
lab:sperm_total_count,
lab:sperm_total_motility,
lab:sperm_vitality,
lab:stool_clostridioides_difficile_toxin,
lab:stool_collection_duration,
lab:stool_collection_mass,
lab:stool_helicobacter_pylori_antigen,
lab:stool_hemoglobin_fit,
lab:stool_occult_blood_guaiac,
lab:stool_ova_parasites,
lab:stool_ph,
lab:stool_rbc,
lab:stool_reducing_substances,
lab:stool_wbc,
lab:syphilis_treponemal_antibody,
lab:tacrolimus,
lab:testosterone_bioavailable,
lab:testosterone_free,
lab:testosterone_total,
lab:thrombin_time,
lab:thyroglobulin,
lab:thyroglobulin_antibodies,
lab:thyroid_stimulating_immunoglobulin,
lab:tibc,
lab:tissue_transglutaminase_iga,
lab:tissue_transglutaminase_igg,
lab:total_cholesterol,
lab:total_cholesterol_hdl_ratio,
lab:total_protein,
lab:total_t3,
lab:total_t4,
lab:tpo_antibodies,
lab:transferrin,
lab:transferrin_saturation,
lab:triglyceride_hdl_ratio,
lab:triglycerides,
lab:troponin_i,
lab:troponin_t,
lab:tsh,
lab:tsh_receptor_antibodies,
lab:uibc,
lab:urea,
lab:uric_acid,
lab:urine_albumin,
lab:urine_albumin_creatinine_ratio,
lab:urine_albumin_excretion_rate,
lab:urine_bacteria,
lab:urine_bilirubin,
lab:urine_blood,
lab:urine_calcium_24h,
lab:urine_calcium_concentration,
lab:urine_clarity,
lab:urine_collection_duration,
lab:urine_collection_volume,
lab:urine_color,
lab:urine_cortisol_free_24h,
lab:urine_creatinine,
lab:urine_creatinine_24h,
lab:urine_crystals,
lab:urine_glucose,
lab:urine_granular_casts,
lab:urine_hyaline_casts,
lab:urine_ketones,
lab:urine_leukocyte_esterase,
lab:urine_mucus,
lab:urine_nitrite,
lab:urine_osmolality,
lab:urine_ph,
lab:urine_phosphate_24h,
lab:urine_phosphate_concentration,
lab:urine_potassium_24h,
lab:urine_potassium_concentration,
lab:urine_protein,
lab:urine_protein_24h,
lab:urine_protein_concentration,
lab:urine_protein_creatinine_ratio,
lab:urine_rbc,
lab:urine_rbc_casts,
lab:urine_renal_epithelial_cells,
lab:urine_sodium_24h,
lab:urine_sodium_concentration,
lab:urine_specific_gravity,
lab:urine_squamous_epithelial_cells,
lab:urine_transitional_epithelial_cells,
lab:urine_urea_nitrogen_24h,
lab:urine_uric_acid_24h,
lab:urine_uric_acid_concentration,
lab:urine_urobilinogen,
lab:urine_waxy_casts,
lab:urine_wbc,
lab:urine_wbc_casts,
lab:urine_yeast,
lab:valproic_acid_free,
lab:valproic_acid_total,
lab:vancomycin,
lab:vitamin_a_retinol,
lab:vitamin_b12,
lab:vitamin_b1_thiamine,
lab:vitamin_b1_thiamine_diphosphate,
lab:vitamin_b2_riboflavin,
lab:vitamin_b6_pyridoxal_phosphate,
lab:vitamin_c,
lab:vitamin_d_1_25_dihydroxy,
lab:vitamin_d_25_oh_d2,
lab:vitamin_d_25_oh_d3,
lab:vitamin_d_25_oh_total,
lab:vitamin_e_alpha_tocopherol,
lab:vitamin_e_gamma_tocopherol,
lab:vitamin_k1,
lab:vldl_cholesterol,
lab:wbc_count,
lab:wbc_morphology,
lab:zinc,
nutrient:energy_kcal,
nutrient:energy_kj,
nutrient:protein_g,
nutrient:fat_g,
nutrient:carbohydrate_g,
nutrient:water_g,
nutrient:ash_g,
nutrient:nitrogen_g,
nutrient:alcohol_g,
nutrient:available_carbohydrate_g,
nutrient:carbohydrate_by_difference_g,
nutrient:starch_g,
nutrient:resistant_starch_g,
nutrient:fiber_g,
nutrient:soluble_fiber_g,
nutrient:insoluble_fiber_g,
nutrient:beta_glucan_g,
nutrient:inulin_g,
nutrient:fructooligosaccharides_g,
nutrient:galactooligosaccharides_g,
nutrient:total_sugars_g,
nutrient:added_sugars_g,
nutrient:free_sugars_g,
nutrient:glucose_g,
nutrient:fructose_g,
nutrient:galactose_g,
nutrient:sucrose_g,
nutrient:lactose_g,
nutrient:maltose_g,
nutrient:trehalose_g,
nutrient:allulose_g,
nutrient:total_sugar_alcohols_g,
nutrient:erythritol_g,
nutrient:sorbitol_g,
nutrient:mannitol_g,
nutrient:xylitol_g,
nutrient:maltitol_g,
nutrient:lactitol_g,
nutrient:isomalt_g,
nutrient:saturated_fat_g,
nutrient:trans_fat_g,
nutrient:monounsaturated_fat_g,
nutrient:polyunsaturated_fat_g,
nutrient:omega_3_g,
nutrient:omega_6_g,
nutrient:omega_9_g,
nutrient:epa_dha_g,
nutrient:cholesterol_mg,
nutrient:butyric_acid_g,
nutrient:caproic_acid_g,
nutrient:caprylic_acid_g,
nutrient:capric_acid_g,
nutrient:lauric_acid_g,
nutrient:myristic_acid_g,
nutrient:palmitic_acid_g,
nutrient:stearic_acid_g,
nutrient:arachidic_acid_g,
nutrient:behenic_acid_g,
nutrient:lignoceric_acid_g,
nutrient:palmitoleic_acid_g,
nutrient:oleic_acid_g,
nutrient:eicosenoic_acid_g,
nutrient:erucic_acid_g,
nutrient:nervonic_acid_g,
nutrient:linoleic_acid_g,
nutrient:ala_g,
nutrient:gamma_linolenic_acid_g,
nutrient:arachidonic_acid_g,
nutrient:epa_g,
nutrient:dpa_n3_g,
nutrient:dha_g,
nutrient:cla_g,
nutrient:fatty_acid_16_1_undifferentiated_g,
nutrient:fatty_acid_18_1_undifferentiated_g,
nutrient:fatty_acid_18_2_undifferentiated_g,
nutrient:fatty_acid_18_3_undifferentiated_g,
nutrient:bcaa_g,
nutrient:alanine_g,
nutrient:arginine_g,
nutrient:aspartic_acid_g,
nutrient:asparagine_g,
nutrient:cysteine_g,
nutrient:cystine_g,
nutrient:glutamic_acid_g,
nutrient:glutamine_g,
nutrient:glycine_g,
nutrient:histidine_g,
nutrient:isoleucine_g,
nutrient:leucine_g,
nutrient:lysine_g,
nutrient:methionine_g,
nutrient:phenylalanine_g,
nutrient:proline_g,
nutrient:serine_g,
nutrient:threonine_g,
nutrient:tryptophan_g,
nutrient:tyrosine_g,
nutrient:valine_g,
nutrient:hydroxyproline_g,
nutrient:taurine_g,
nutrient:sodium_mg,
nutrient:potassium_mg,
nutrient:calcium_mg,
nutrient:magnesium_mg,
nutrient:phosphorus_mg,
nutrient:iron_mg,
nutrient:zinc_mg,
nutrient:copper_mg,
nutrient:manganese_mg,
nutrient:selenium_ug,
nutrient:iodine_ug,
nutrient:chloride_mg,
nutrient:salt_g,
nutrient:salt_equivalent_g,
nutrient:chromium_ug,
nutrient:molybdenum_ug,
nutrient:fluoride_mg,
nutrient:boron_mg,
nutrient:cobalt_ug,
nutrient:nickel_ug,
nutrient:sulfur_mg,
nutrient:vitamin_a_rae_ug,
nutrient:retinol_ug,
nutrient:alpha_carotene_ug,
nutrient:beta_carotene_ug,
nutrient:beta_cryptoxanthin_ug,
nutrient:lycopene_ug,
nutrient:lutein_ug,
nutrient:zeaxanthin_ug,
nutrient:lutein_zeaxanthin_ug,
nutrient:vitamin_d_ug,
nutrient:vitamin_d2_ug,
nutrient:vitamin_d3_ug,
nutrient:vitamin_d_25_oh_d3_ug,
nutrient:vitamin_e_alpha_tocopherol_mg,
nutrient:beta_tocopherol_mg,
nutrient:gamma_tocopherol_mg,
nutrient:delta_tocopherol_mg,
nutrient:alpha_tocotrienol_mg,
nutrient:beta_tocotrienol_mg,
nutrient:gamma_tocotrienol_mg,
nutrient:delta_tocotrienol_mg,
nutrient:vitamin_k_ug,
nutrient:vitamin_k1_ug,
nutrient:dihydrophylloquinone_ug,
nutrient:vitamin_k2_mk4_ug,
nutrient:vitamin_k2_mk7_ug,
nutrient:vitamin_c_mg,
nutrient:thiamin_b1_mg,
nutrient:riboflavin_b2_mg,
nutrient:niacin_b3_mg,
nutrient:niacin_equivalents_mg,
nutrient:pantothenic_acid_b5_mg,
nutrient:vitamin_b6_mg,
nutrient:biotin_b7_ug,
nutrient:folate_ug,
nutrient:folate_dfe_ug,
nutrient:food_folate_ug,
nutrient:folic_acid_ug,
nutrient:five_mthf_ug,
nutrient:vitamin_b12_ug,
nutrient:choline_mg,
nutrient:choline_free_mg,
nutrient:choline_from_glycerophosphocholine_mg,
nutrient:choline_from_phosphocholine_mg,
nutrient:choline_from_phosphatidylcholine_mg,
nutrient:choline_from_sphingomyelin_mg,
nutrient:betaine_mg,
nutrient:caffeine_mg,
nutrient:theobromine_mg,
nutrient:phytosterols_mg,
nutrient:beta_sitosterol_mg,
nutrient:campesterol_mg,
nutrient:stigmasterol_mg,
nutrient:total_isoflavones_mg,
nutrient:daidzein_mg,
nutrient:genistein_mg,
nutrient:glycitein_mg,
nutrient:total_oxalate_mg,
nutrient:soluble_oxalate_mg,
nutrient:phytate_mg,
nutrient:total_purines_mg,
hydration:total_fluids_ml,
hydration:water_ml,
sleep:sleep_seconds,
activity:steps,
activity:distance_m,
activity:active_energy_kcal
start_date
string<date>
required

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
end_date
string<date>
required

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
granularity
enum<string>

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Available options:
day,
week
include_preliminary
boolean

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

source_type
enum<string>

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Available options:
manual,
device,
laboratory,
calculated,
other
specimen_type
enum<string>

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Available options:
whole_blood,
serum,
plasma,
capillary_blood,
arterial_blood,
venous_blood,
urine,
stool,
saliva,
semen,
swab,
csf,
tissue,
other,
unknown
method_name
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 200
measurement_site
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 200
resting_state
enum<string>

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Available options:
resting,
exercise,
recovery,
sleep,
unknown

Response

Successful domain response

catalog_version
string
required
Allowed value: "1.0.4"
start_date
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
end_date
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
granularity
enum<string>
required
Available options:
day,
week
metrics
object[]
required
Maximum array length: 20