Summary

The Electrocardiogram summary type does not embed the voltage measurements.

Use the Get Electrocardiogram Voltage endpoint with the session_start and session-end timestamps to query the voltage measurements.

Authorizations

x-vital-api-key

string

headerrequired

Vital Team API Key

Path Parameters

user_id

string

required

Query Parameters

start_date

string

required

Start date in YYYY-MM-DD

end_date

string | null

End date (inclusive) in YYYY-MM-DD

provider

string

default:

Provider oura/strava etc

Response

200 - application/json

electrocardiogram

object[]

required

electrocardiogram.id

string

required

electrocardiogram.session_start

string

required

electrocardiogram.session_end

string

required

electrocardiogram.voltage_sample_count

integer

required

electrocardiogram.heart_rate_mean

integer | null

electrocardiogram.sampling_frequency_hz

number | null

electrocardiogram.classification

enum<string> | null

Available options:

sinus_rhythm,

atrial_fibrillation,

inconclusive

electrocardiogram.inconclusive_cause

enum<string> | null

Available options:

high_heart_rate,

low_heart_rate,

poor_reading

electrocardiogram.algorithm_version

string | null

electrocardiogram.time_zone

string | null

electrocardiogram.source_provider

required

Available options:

oura,

fitbit,

garmin,

whoop,

strava,

renpho,

peloton,

wahoo,

zwift,

freestyle_libre,

abbott_libreview,

freestyle_libre_ble,

eight_sleep,

withings,

apple_health_kit,

manual,

ihealth,

google_fit,

beurer_api,

beurer_ble,

omron,

omron_ble,

onetouch_ble,

accuchek_ble,

contour_ble,

dexcom,

dexcom_v3,

hammerhead,

my_fitness_pal,

health_connect,

polar,

cronometer,

kardia,

whoop_v2,

ultrahuman,

my_fitness_pal_v2,

map_my_fitness

electrocardiogram.source_type

enum<string>

required

Available options:

unknown,

phone,

watch,

app,

multiple_sources,

fingerprick,

cuff,

manual_scan,

automatic,

scale,

chest_strap,

ring,

lab

electrocardiogram.source_app_id

string | null

electrocardiogram.source_device_model

string | null

electrocardiogram.user_id

string

required

electrocardiogram.source

object

required

Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.

Debugging

Sleep

Sleep Cycle

Meal

Workouts

Profile

Activity

Body

Menstrual Cycle

Electrocardiogram

Vitals Timeseries

Body Timeseries

Activity Timeseries

Wellness Timeseries

Diary Timeseries

Nutrition Timeseries

Authorizations

Path Parameters

Query Parameters

Response