curl --request GET \
--url {{BASE_URL}}/v2/summary/electrocardiogram/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.electrocardiogram.get(
"<user_id>",
start_date="2022-05-01",
end_date="2022-06-01",
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.electrocardiogram.get({
userId: "<user_id>",
startDate: "2022-05-01",
endDate: "2022-06-01",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.electrocardiogram.requests.GetElectrocardiogramRequest;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.electrocardiogram().get(
"<user_id>",
GetElectrocardiogramRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build()
);
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
endDate := "2022-06-01"
response, err := c.Electrocardiogram.Get(context.TODO(), &junction.GetElectrocardiogramRequest{
UserId: "<user_id>",
StartDate: "2022-05-01",
EndDate: &endDate,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"electrocardiogram": [
{
"classification": "sinus_rhythm",
"created_at": "2023-02-27T20:31:24+00:00",
"heart_rate_mean": 73,
"id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
"sampling_frequency_hz": 505,
"session_end": "2022-01-01T08:00:00",
"session_start": "2022-01-01T00:00:00",
"source": {
"device_id": "550e8400-e29b-41d4-a716-446655440000",
"provider": "apple_health_kit",
"type": "watch"
},
"source_provider": "oura",
"source_type": "ring",
"time_zone": "America/Los_Angeles",
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
"voltage_sample_count": 1600
}
]
}{
"detail": "<unknown>"
}Electrocardiogram
Summary
Retrieve electrocardiogram summary data for a specific user from their connected wearable provider.
GET
/
v2
/
summary
/
electrocardiogram
/
{user_id}
curl --request GET \
--url {{BASE_URL}}/v2/summary/electrocardiogram/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.electrocardiogram.get(
"<user_id>",
start_date="2022-05-01",
end_date="2022-06-01",
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.electrocardiogram.get({
userId: "<user_id>",
startDate: "2022-05-01",
endDate: "2022-06-01",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.electrocardiogram.requests.GetElectrocardiogramRequest;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.electrocardiogram().get(
"<user_id>",
GetElectrocardiogramRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build()
);
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
endDate := "2022-06-01"
response, err := c.Electrocardiogram.Get(context.TODO(), &junction.GetElectrocardiogramRequest{
UserId: "<user_id>",
StartDate: "2022-05-01",
EndDate: &endDate,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"electrocardiogram": [
{
"classification": "sinus_rhythm",
"created_at": "2023-02-27T20:31:24+00:00",
"heart_rate_mean": 73,
"id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
"sampling_frequency_hz": 505,
"session_end": "2022-01-01T08:00:00",
"session_start": "2022-01-01T00:00:00",
"source": {
"device_id": "550e8400-e29b-41d4-a716-446655440000",
"provider": "apple_health_kit",
"type": "watch"
},
"source_provider": "oura",
"source_type": "ring",
"time_zone": "America/Los_Angeles",
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
"voltage_sample_count": 1600
}
]
}{
"detail": "<unknown>"
}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.curl --request GET \
--url {{BASE_URL}}/v2/summary/electrocardiogram/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.electrocardiogram.get(
"<user_id>",
start_date="2022-05-01",
end_date="2022-06-01",
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.electrocardiogram.get({
userId: "<user_id>",
startDate: "2022-05-01",
endDate: "2022-06-01",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.electrocardiogram.requests.GetElectrocardiogramRequest;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.electrocardiogram().get(
"<user_id>",
GetElectrocardiogramRequest.builder()
.startDate("2022-05-01")
.endDate("2022-06-01")
.build()
);
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
endDate := "2022-06-01"
response, err := c.Electrocardiogram.Get(context.TODO(), &junction.GetElectrocardiogramRequest{
UserId: "<user_id>",
StartDate: "2022-05-01",
EndDate: &endDate,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
Start date in YYYY-MM-DD
End date (inclusive) in YYYY-MM-DD
Provider oura/strava etc
Response
Successful Response
Show child attributes
Show child attributes
Was this page helpful?
⌘I