Stream

Retrieve timeseries workouts stream via the Junction API. Requires authentication with your team API key.

GET /v2/timeseries/workouts/{workout_id}/stream

cURL

curl --request GET \
     --url {{BASE_URL}}/v2/summary/workouts/{workout_id}/stream \
     --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.workouts.get_by_workout_id("<workout_id>")

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.workouts.getByWorkoutId({ workoutId: "<workout_id>" });

import com.junction.api.Junction;
import com.junction.api.core.Environment;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.workouts().getByWorkoutId("<workout_id>");

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),
)

response, err := c.Workouts.GetByWorkoutId(context.TODO(), &junction.GetByWorkoutIdWorkoutsRequest{
    WorkoutId: "<workout_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

200

{
  "altitude": [
    10,
    20,
    30,
    40,
    50
  ],
  "cadence": [
    10,
    12,
    12,
    11,
    10
  ],
  "distance": [
    12,
    15,
    18,
    20,
    25
  ],
  "heartrate": [
    120,
    125,
    125,
    130,
    135
  ],
  "lat": [
    10,
    20,
    30,
    40,
    50
  ],
  "lng": [
    10,
    20,
    30,
    40,
    50
  ],
  "power": [
    100,
    100,
    100,
    100,
    100
  ],
  "resistance": [
    10,
    20,
    30,
    40,
    50
  ],
  "time": [
    1626625123,
    1626625140,
    1626625145,
    1626625150,
    162662560
  ],
  "velocity_smooth": [
    10,
    20,
    30,
    40,
    50
  ]
}

{
  "detail": "<unknown>"
}

cURL

curl --request GET \
     --url {{BASE_URL}}/v2/summary/workouts/{workout_id}/stream \
     --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.workouts.get_by_workout_id("<workout_id>")

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.workouts.getByWorkoutId({ workoutId: "<workout_id>" });

import com.junction.api.Junction;
import com.junction.api.core.Environment;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.workouts().getByWorkoutId("<workout_id>");

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),
)

response, err := c.Workouts.GetByWorkoutId(context.TODO(), &junction.GetByWorkoutIdWorkoutsRequest{
    WorkoutId: "<workout_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Path Parameters

workout_id · string<uuid> · required

The Vital ID for the workout

Response

200

application/json

Successful Response

cadence · (number | null)[] number[]

RPM for cycling, Steps per minute for running

time · integer[] | null

Corresponding time stamp in unix time for datapoint

altitude · (number | null)[] number[]

Data points for altitude

velocity_smooth · (number | null)[] number[]

Velocity in m/s

heartrate · (integer | null)[] integer[]

Heart rate in bpm

lat · (number | null)[] number[]

Latitude for data point

lng · (number | null)[] number[]

Longitude for data point

distance · (number | null)[] number[]

Cumulated distance for exercise

power · (number | null)[] number[]

Power in watts

resistance · (number | null)[] number[]

Resistance on bike

temperature · (number | null)[] number[]

Temperature stream measured by device in Celsius