Nest Changelog
1.30.1 PRE
6/13/2023
1.30.2 PRE
6/13/2023
6 changed endpoints Collapse changed endpoints
GET /users/{userId}/workouts/items 
Get workout summaries for user
Response Body
{
data: List<{
content?: {
description?: string,
duration?: number,
guid?: string,
image?: {
default?: string,
hd?: string,
portrait?: string,
sd?: string,
square?: string,
},
instructors?: List<{
id?: number,
name?: string,
}>,
legacy?: {
id?: number,
type?: 'reflect' | 'connect',
},
name?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
dateEnd?: number,
dateStart?: number,
duration?: {
percentage?: number,
text?: string,
value?: number,
},
guid?: string,
output?: number,
ranking?: {
place?: number,
total?: number,
},
stats?: {
calories: number,
distance: number,
heartRate: number,
heartRateMax: number,
hrPoints: number,
incline: number,
joules: number,
resistance: number,
rpm: number,
speed: number,
spm: number,
},
status?: 'incomplete' | 'complete',
}>,
pagination: {
page?: number,
skip?: number,
take?: number,
total?: {
pages?: number,
rows?: number,
},
},
}GET /users/{userId}/workouts/items
Get workout summaries for user
Response Body
{
data: List<{
content?: {
description?: string,
duration?: number,
guid?: string,
image?: {
default?: string,
hd?: string,
portrait?: string,
sd?: string,
square?: string,
},
instructors?: List<{
id?: number,
name?: string,
}>,
legacy?: {
id?: number,
type?: 'reflect' | 'connect',
},
name?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
dateEnd?: number,
dateStart?: number,
duration?: {
percentage?: number,
text?: string,
value?: number,
},
guid?: string,
output?: number,
+ percentile?: number,
ranking?: {
place?: number,
total?: number,
},
stats?: {
calories: number,
distance: number,
heartRate: number,
heartRateMax: number,
hrPoints: number,
incline: number,
joules: number,
resistance: number,
rpm: number,
speed: number,
spm: number,
},
status?: 'incomplete' | 'complete',
}>,
pagination: {
page?: number,
skip?: number,
take?: number,
total?: {
pages?: number,
rows?: number,
},
},
}GET /users/{userId}/workouts/aggregations
Get workout aggregations for user
Response Body
{
data: {
furthestDistance?: number,
highestOutput?: number,
mostRecent?: {
content?: {
description?: string,
duration?: number,
guid?: string,
image?: {
default?: string,
hd?: string,
portrait?: string,
sd?: string,
square?: string,
},
instructors?: List<{
id?: number,
name?: string,
}>,
legacy?: {
id?: number,
type?: 'reflect' | 'connect',
},
name?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
dateEnd?: number,
dateStart?: number,
duration?: {
percentage?: number,
text?: string,
value?: number,
},
guid?: string,
output?: number,
ranking?: {
place?: number,
total?: number,
},
stats?: {
calories: number,
distance: number,
heartRate: number,
heartRateMax: number,
hrPoints: number,
incline: number,
joules: number,
resistance: number,
rpm: number,
speed: number,
spm: number,
},
status?: 'incomplete' | 'complete',
},
personalBest?: {
content?: {
description?: string,
duration?: number,
guid?: string,
image?: {
default?: string,
hd?: string,
portrait?: string,
sd?: string,
square?: string,
},
instructors?: List<{
id?: number,
name?: string,
}>,
legacy?: {
id?: number,
type?: 'reflect' | 'connect',
},
name?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
dateEnd?: number,
dateStart?: number,
duration?: {
percentage?: number,
text?: string,
value?: number,
},
guid?: string,
output?: number,
ranking?: {
place?: number,
total?: number,
},
stats?: {
calories: number,
distance: number,
heartRate: number,
heartRateMax: number,
hrPoints: number,
incline: number,
joules: number,
resistance: number,
rpm: number,
speed: number,
spm: number,
},
status?: 'incomplete' | 'complete',
},
totalClasses?: number,
totalDistance?: number,
totalDuration?: number,
},
}GET /users/{userId}/workouts/aggregations
Get workout aggregations for user
Response Body
{
data: {
furthestDistance?: number,
highestOutput?: number,
mostRecent?: {
content?: {
description?: string,
duration?: number,
guid?: string,
image?: {
default?: string,
hd?: string,
portrait?: string,
sd?: string,
square?: string,
},
instructors?: List<{
id?: number,
name?: string,
}>,
legacy?: {
id?: number,
type?: 'reflect' | 'connect',
},
name?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
dateEnd?: number,
dateStart?: number,
duration?: {
percentage?: number,
text?: string,
value?: number,
},
guid?: string,
output?: number,
+ percentile?: number,
ranking?: {
place?: number,
total?: number,
},
stats?: {
calories: number,
distance: number,
heartRate: number,
heartRateMax: number,
hrPoints: number,
incline: number,
joules: number,
resistance: number,
rpm: number,
speed: number,
spm: number,
},
status?: 'incomplete' | 'complete',
},
personalBest?: {
content?: {
description?: string,
duration?: number,
guid?: string,
image?: {
default?: string,
hd?: string,
portrait?: string,
sd?: string,
square?: string,
},
instructors?: List<{
id?: number,
name?: string,
}>,
legacy?: {
id?: number,
type?: 'reflect' | 'connect',
},
name?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
dateEnd?: number,
dateStart?: number,
duration?: {
percentage?: number,
text?: string,
value?: number,
},
guid?: string,
output?: number,
+ percentile?: number,
ranking?: {
place?: number,
total?: number,
},
stats?: {
calories: number,
distance: number,
heartRate: number,
heartRateMax: number,
hrPoints: number,
incline: number,
joules: number,
resistance: number,
rpm: number,
speed: number,
spm: number,
},
status?: 'incomplete' | 'complete',
},
totalClasses?: number,
totalDistance?: number,
totalDuration?: number,
},
}POST /workouts/items
Post a Workout
Request Body
{
content: {
guid?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
device?: {
appVersion?: string,
model?: string,
os?: string,
osVersion?: string,
},
legacyProduct?: string,
localTime?: string,
peripherals?: List<{
firmwareVersion?: string,
guid?: string,
hardwareVersion?: string,
modelId?: string,
name?: string,
serialNO?: string,
type?: 'bike' | 'rower' | 'treadmill',
}>,
ranking: {
place?: number,
total?: number,
},
stats?: List<{
classState?: 'warmup' | 'in-session' | 'overflow' | 'ended',
dateLoggedMs?: number,
output?: {
distance: number,
incrementalDistance: number,
joules: number,
RPM: number,
strokesPerMinute: number,
time500Meters: number,
watts: number,
},
peripheral: {
guid: string,
incline: number,
resistance: number,
speed: number,
},
physiology?: {
calories: number,
heartRate: number,
hrPoints: number,
},
playbackState?: 'playing' | 'paused' | 'stopped' | 'buffering',
}>,
user?: {
id?: number,
},
}POST /workouts/items
Post a Workout
Request Body
{
content: {
guid?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
device?: {
appVersion?: string,
model?: string,
os?: string,
osVersion?: string,
},
legacyProduct?: string,
localTime?: string,
+ percentile: number,
peripherals?: List<{
firmwareVersion?: string,
guid?: string,
hardwareVersion?: string,
modelId?: string,
name?: string,
serialNO?: string,
type?: 'bike' | 'rower' | 'treadmill',
}>,
ranking: {
place?: number,
total?: number,
},
stats?: List<{
classState?: 'warmup' | 'in-session' | 'overflow' | 'ended',
dateLoggedMs?: number,
output?: {
distance: number,
incrementalDistance: number,
joules: number,
RPM: number,
strokesPerMinute: number,
time500Meters: number,
watts: number,
},
peripheral: {
guid: string,
incline: number,
resistance: number,
speed: number,
},
physiology?: {
calories: number,
heartRate: number,
hrPoints: number,
},
playbackState?: 'playing' | 'paused' | 'stopped' | 'buffering',
}>,
user?: {
id?: number,
},
}PUT /workouts/items/{guid}
Put a Workout
Request Body
{
content: {
guid?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
device?: {
appVersion?: string,
model?: string,
os?: string,
osVersion?: string,
},
legacyProduct?: string,
localTime?: string,
peripherals?: List<{
firmwareVersion?: string,
guid?: string,
hardwareVersion?: string,
modelId?: string,
name?: string,
serialNO?: string,
type?: 'bike' | 'rower' | 'treadmill',
}>,
ranking: {
place?: number,
total?: number,
},
stats?: List<{
classState?: 'warmup' | 'in-session' | 'overflow' | 'ended',
dateLoggedMs?: number,
output?: {
distance: number,
incrementalDistance: number,
joules: number,
RPM: number,
strokesPerMinute: number,
time500Meters: number,
watts: number,
},
peripheral: {
guid: string,
incline: number,
resistance: number,
speed: number,
},
physiology?: {
calories: number,
heartRate: number,
hrPoints: number,
},
playbackState?: 'playing' | 'paused' | 'stopped' | 'buffering',
}>,
user?: {
id?: number,
},
}PUT /workouts/items/{guid}
Put a Workout
Request Body
{
content: {
guid?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
device?: {
appVersion?: string,
model?: string,
os?: string,
osVersion?: string,
},
legacyProduct?: string,
localTime?: string,
+ percentile: number,
peripherals?: List<{
firmwareVersion?: string,
guid?: string,
hardwareVersion?: string,
modelId?: string,
name?: string,
serialNO?: string,
type?: 'bike' | 'rower' | 'treadmill',
}>,
ranking: {
place?: number,
total?: number,
},
stats?: List<{
classState?: 'warmup' | 'in-session' | 'overflow' | 'ended',
dateLoggedMs?: number,
output?: {
distance: number,
incrementalDistance: number,
joules: number,
RPM: number,
strokesPerMinute: number,
time500Meters: number,
watts: number,
},
peripheral: {
guid: string,
incline: number,
resistance: number,
speed: number,
},
physiology?: {
calories: number,
heartRate: number,
hrPoints: number,
},
playbackState?: 'playing' | 'paused' | 'stopped' | 'buffering',
}>,
user?: {
id?: number,
},
}POST /workouts/process
Process workout - Internal use only
Request Body
{
rideIndex?: {
appversion: string,
avgcadence: number,
avgresistance: number,
classimage: string,
classname: string,
datecreated: string,
device: string,
dnf: bool,
finalrank: number,
incline: number,
instanceuuid?: string,
instructorname: string,
iscomplete: bool,
osversion: string,
product?: string,
rideid: number,
ridetype?: string,
source: string,
totalcalories: number,
totaldistance: number,
totalhrpoints: number,
totaloutput: number,
totalriders: number,
userid?: number,
},
rideIndexById?: {
appversion: string,
avgcadence: number,
avgheartrate: number,
avgresistance: number,
classimage: string,
classname: string,
datecreated: string,
device: string,
dnf: bool,
duration: number,
encore: bool,
finalrank: number,
incline: number,
instanceuuid?: string,
instructorname: string,
iscomplete: bool,
osversion: string,
product?: string,
rideid: number,
ridetype: string,
source: string,
totalcalories: number,
totaldistance: number,
totalhrpoints: number,
totaloutput: number,
totalriders: number,
userid: number,
},
segment?: {
activity_type: string,
bike_statistics: {
cadence?: number,
calories?: number,
distance?: number,
output?: {
average?: number,
best?: number,
total?: number,
},
resistance?: {
average?: number,
maximum?: number,
},
speed?: number,
},
class_length: number,
class_name: string,
content_id: string,
content_type: 'live' | 'vod' | 'encore' | 'freestyle',
email?: string,
equipment_type: 'bike' | 'fitpass' | 'reflect' | 'row' | 'stride',
first_name?: string,
fitpass_statistics: {
calories?: number,
heart_rate_points?: number,
},
instructor_id: number,
instructor_name: string,
last_name?: string,
metric_preference?: 'imperial' | 'metric',
music_genre: string,
place: number,
platform?: string,
reflect_statistics: {
calories?: number,
heart_rate_points?: number,
},
rowing_statistics: {
calories?: number,
distance?: number,
output?: {
average?: number,
best?: number,
total?: number,
},
resistance?: {
average?: number,
maximum?: number,
},
speed?: number,
stroke?: {
average?: number,
maximum?: number,
},
},
stride_statistics: {
calories?: number,
distance?: number,
incline?: {
average?: number,
maximum?: number,
},
output?: {
average?: number,
best?: number,
total?: number,
},
speed?: {
average?: number,
maximum?: number,
},
},
user_id?: number,
},
workoutEntity?: {
buffering?: number,
commercialCode?: string,
completion?: number,
contentDuration?: number,
contentGuid?: string,
dateDeleted?: number,
dateEnd?: number,
dateStart?: number,
duration?: number,
format?: string,
guid?: string,
output?: number,
rankingPlace?: number,
rankingTotal?: number,
stats?: record,
timeOffset?: number,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
userId?: number,
},
}POST /workouts/process
Process workout - Internal use only
Request Body
{
rideIndex?: {
appversion: string,
avgcadence: number,
avgresistance: number,
classimage: string,
classname: string,
datecreated: string,
device: string,
+ distancetype?: string,
dnf: bool,
finalrank: number,
incline: number,
instanceuuid?: string,
instructorname: string,
iscomplete: bool,
osversion: string,
product?: string,
rideid: number,
ridetype?: string,
source: string,
totalcalories: number,
totaldistance: number,
totalhrpoints: number,
totaloutput: number,
totalriders: number,
userid?: number,
},
rideIndexById?: {
appversion: string,
avgcadence: number,
avgheartrate: number,
avgresistance: number,
classimage: string,
classname: string,
datecreated: string,
device: string,
+ distancetype?: string,
dnf: bool,
duration: number,
encore: bool,
finalrank: number,
incline: number,
instanceuuid?: string,
instructorname: string,
iscomplete: bool,
osversion: string,
product?: string,
rideid: number,
ridetype: string,
source: string,
totalcalories: number,
totaldistance: number,
totalhrpoints: number,
totaloutput: number,
totalriders: number,
userid: number,
},
segment?: {
activity_type: string,
bike_statistics: {
cadence?: number,
calories?: number,
distance?: number,
output?: {
average?: number,
best?: number,
total?: number,
},
resistance?: {
average?: number,
maximum?: number,
},
speed?: number,
},
class_length: number,
class_name: string,
content_id: string,
content_type: 'live' | 'vod' | 'encore' | 'freestyle',
email?: string,
equipment_type: 'bike' | 'fitpass' | 'reflect' | 'row' | 'stride',
first_name?: string,
fitpass_statistics: {
calories?: number,
heart_rate_points?: number,
},
instructor_id: number,
instructor_name: string,
last_name?: string,
metric_preference?: 'imperial' | 'metric',
music_genre: string,
place: number,
platform?: string,
reflect_statistics: {
calories?: number,
heart_rate_points?: number,
},
rowing_statistics: {
calories?: number,
distance?: number,
output?: {
average?: number,
best?: number,
total?: number,
},
resistance?: {
average?: number,
maximum?: number,
},
speed?: number,
stroke?: {
average?: number,
maximum?: number,
},
},
stride_statistics: {
calories?: number,
distance?: number,
incline?: {
average?: number,
maximum?: number,
},
output?: {
average?: number,
best?: number,
total?: number,
},
speed?: {
average?: number,
maximum?: number,
},
},
user_id?: number,
},
workoutEntity?: {
buffering?: number,
commercialCode?: string,
completion?: number,
contentDuration?: number,
contentGuid?: string,
dateDeleted?: number,
dateEnd?: number,
dateStart?: number,
duration?: number,
format?: string,
guid?: string,
output?: number,
+ percentile?: number,
rankingPlace?: number,
rankingTotal?: number,
stats?: record,
timeOffset?: number,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
userId?: number,
},
}GET /workouts/items/{guid}/summary
Get summary view of a workout
Response Body
{
data: {
content?: {
description?: string,
duration?: number,
guid?: string,
image?: {
default?: string,
hd?: string,
portrait?: string,
sd?: string,
square?: string,
},
instructors?: List<{
id?: number,
name?: string,
}>,
legacy?: {
id?: number,
type?: 'reflect' | 'connect',
},
name?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
dateEnd?: number,
dateStart?: number,
duration?: {
percentage?: number,
text?: string,
value?: number,
},
guid?: string,
output?: number,
ranking?: {
place?: number,
total?: number,
},
stats?: {
calories: number,
distance: number,
heartRate: number,
heartRateMax: number,
hrPoints: number,
incline: number,
joules: number,
resistance: number,
rpm: number,
speed: number,
spm: number,
},
status?: 'incomplete' | 'complete',
user?: {
id?: number,
},
},
}GET /workouts/items/{guid}/summary
Get summary view of a workout
Response Body
{
data: {
content?: {
description?: string,
duration?: number,
guid?: string,
image?: {
default?: string,
hd?: string,
portrait?: string,
sd?: string,
square?: string,
},
instructors?: List<{
id?: number,
name?: string,
}>,
legacy?: {
id?: number,
type?: 'reflect' | 'connect',
},
name?: string,
type?: 'live' | 'vod' | 'encore' | 'freestyle',
},
dateEnd?: number,
dateStart?: number,
duration?: {
percentage?: number,
text?: string,
value?: number,
},
guid?: string,
output?: number,
+ percentile?: number,
ranking?: {
place?: number,
total?: number,
},
stats?: {
calories: number,
distance: number,
heartRate: number,
heartRateMax: number,
hrPoints: number,
incline: number,
joules: number,
resistance: number,
rpm: number,
speed: number,
spm: number,
},
status?: 'incomplete' | 'complete',
user?: {
id?: number,
},
},
}