Labs
The analyses of the app's Labs pages, under /labs: athlete boards, team comparisons, VBT, jump, sprint and reaction insights.
These endpoints return the same figures as the Labs pages of the Vitruve app, computed the same way. Use them when you want what a coach sees in Labs; for one metric across many athletes, the trend and ranking endpoints are simpler.
- Labs add-on. Every endpoint needs it. Without it, or when the role can't read the analysis, the answer is
403. - Dates.
fromandtoare required and inclusive (except forGET /labs/vbt/equations, which has no period). Bare dates are read intimezone, which also sets where days, weeks and months start. - Structured options travel as JSON in one query parameter each, URL-encoded: metric specs (
metrics,columns,x,y,spec),settings,comparisonandsegment. Lists of ids (userIds,serieIds,picks) are comma-separated. - Athletes are checked first. An athlete in
userIdoruserIdsthat isn't in your organization answers404. WithoutuserIds, a team analysis reads every athlete of your organization. - Errors. A malformed option, or one that doesn't apply to the endpoint, answers
400andmessagenames it. Not paginated. - Units. Values are in each metric's stored unit, never converted to display units.
Athlete
Get an athlete's Labs board
One athlete’s board of up to 16 metrics over a period, as the athlete page of Vitruve Labs shows it: each metric bucketed over the period, with the newest reading. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/athlete?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/athlete?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/athlete?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"granularity": "week",
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"metrics": [
{
"index": 0,
"spec": {
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"calculation": "max",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"queryType": "max"
},
"buckets": [
{
"bucketStart": "2026-01-04T00:00:00.000Z",
"value": 0.78
},
{
"bucketStart": "2026-01-11T00:00:00.000Z",
"value": 0.81
}
],
"latest": {
"value": 0.81,
"date": "2026-03-27T09:12:44.000Z",
"origin": "tracked"
}
}
]
}
}Query parameters
fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. metricsstringrequired- Array of 1–16 metric specs, one per metric on the board. A metric spec is
{ "metricId", "calculation", "exerciseId"?, "repetitionType"?, "percentile"?, "origin"? }:calculationis one oflatest,avg,max,min,count,median,percentile(withpercentile0–100) orstdDev;repetitionTypeisconcentricoreccentric;originismanualortracked. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
dateRangedatetime[]- Start and end of the period read.
granularitystring- Bucket size the period implies:
day,weekormonth. Buckets start intimezone. metrics[].indexinteger- Position of the spec in
metrics. metrics[].specobject- The spec as read.
metrics[].spec.queryTypestring- The aggregate the calculation runs: the calculation itself, except
count, which runssum. metrics[].errorstringnullable- Why this metric could not be read. The others are still answered.
metrics[].buckets[]object[]{ bucketStart, value }per period with a value, oldest first.metrics[].latestobjectnullable- The newest reading in the period:
value,dateand, when known,origin(manualortracked).
Failures are described in error codes.
Get an athlete's records
One athlete’s best value of each metric per period, flagging the periods that set a new record. “Best” follows each metric: higher, or lower where less is better. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/athlete/records?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/athlete/records?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/athlete/records?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"granularity": "week",
"records": [
{
"index": 0,
"spec": {
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7"
},
"isHigherBetter": true,
"buckets": [
{
"bucketStart": "2026-01-04T00:00:00.000Z",
"value": 0.79,
"isRecord": true
},
{
"bucketStart": "2026-01-11T00:00:00.000Z",
"value": 0.77,
"isRecord": false
}
]
}
]
}
}Query parameters
fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. metricsstringrequired- Array of 1–12 metric specs, one per metric on the board. A metric spec is
{ "metricId", "calculation", "exerciseId"?, "repetitionType"?, "percentile"?, "origin"? }:calculationis one oflatest,avg,max,min,count,median,percentile(withpercentile0–100) orstdDev;repetitionTypeisconcentricoreccentric;originismanualortracked. Records take nocalculationorpercentile: the best value is always read. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
dateRangedatetime[]- Start and end of the period read.
granularitystring- Bucket size the period implies:
day,weekormonth. Buckets start intimezone. records[].isHigherBetterboolean- Whether a higher value is a better one for this metric.
records[].errorstringnullable- Why this metric could not be read. The others are still answered.
records[].buckets[]object[]{ bucketStart, value, isRecord }per period with a value, oldest first.isRecordmarks a period whose best beat every earlier one.
Failures are described in error codes.
Rank an athlete among peers
Where one athlete stands among a group on each metric over a period: rank, group average, leader and the spread of the group’s values. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/athlete/ranks?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&calculation=max&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/athlete/ranks?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&calculation=max&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/athlete/ranks?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&calculation=max&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"granularity": "week",
"calculation": "max",
"metrics": [
{
"index": 0,
"spec": {
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"calculation": "max",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"queryType": "max"
},
"isHigherBetter": true,
"rank": 2,
"measured": 9,
"total": 12,
"value": 0.81,
"date": "2026-03-27T09:12:44.000Z",
"groupAverage": 0.74,
"leader": {
"userId": "c81d5f07-92ab-4e63-b0d4-7a3e6c1f9e28",
"value": 0.86
},
"distribution": [
0.62,
0.68,
0.71,
0.74,
0.75,
0.77,
0.79,
0.81,
0.86
],
"recent": [
{
"bucketStart": "2026-03-15T00:00:00.000Z",
"value": 0.79
},
{
"bucketStart": "2026-03-22T00:00:00.000Z",
"value": 0.81
}
]
}
]
}
}Query parameters
fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. userIdsstring- The group to rank against. Comma-separated athlete ids, 1–100. Defaults to every athlete of your organization you can see. One outside it answers
404. calculationavg | max | min | countrequired- How each athlete’s values in the period are combined.
metricsstringrequired- Array of 1–12 metric specs, one per metric on the board. A metric spec is
{ "metricId", "calculation", "exerciseId"?, "repetitionType"?, "percentile"?, "origin"? }:calculationis one oflatest,avg,max,min,count,median,percentile(withpercentile0–100) orstdDev;repetitionTypeisconcentricoreccentric;originismanualortracked. A spec’s owncalculationis optional here:calculationapplies to all. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
dateRangedatetime[]- Start and end of the period read.
granularitystring- Bucket size the period implies:
day,weekormonth. Buckets start intimezone. metrics[].rankintegernullable- The athlete’s place, 1 being best; ties share a place.
nullwhen the athlete has no value in the period. metrics[].measuredinteger- Athletes of the group with a value.
metrics[].totalinteger- Athletes in the group, measured or not.
metrics[].valuenumbernullable- The athlete’s value.
metrics[].datedatetimenullable- When the value was measured. Only
maxandminhave one. metrics[].leaderobjectnullable{ userId, value }of the best athlete of the group.metrics[].distributionnumber[]- Every measured value of the group, ascending, without who it belongs to.
metrics[].recent[]object[]{ bucketStart, value }of the athlete’s last periods with a value (up to 8), oldest first.metrics[].errorstringnullable- Why this metric could not be read. The others are still answered.
Failures are described in error codes.
Get an athlete's trends
One athlete’s metrics over a period as a table: one row per metric, one column per period, and the change from the first to the last period with a value. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/athlete/trends?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/athlete/trends?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/athlete/trends?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&metrics=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"granularity": "month",
"bucketStarts": [
"2026-01-01T00:00:00.000Z",
"2026-02-01T00:00:00.000Z",
"2026-03-01T00:00:00.000Z"
],
"rows": [
{
"index": 0,
"spec": {
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"calculation": "max",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"queryType": "max"
},
"buckets": [
0.76,
null,
0.81
],
"change": 6.58
}
]
}
}Query parameters
fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. metricsstringrequired- Array of 1–16 metric specs, one per metric on the board. A metric spec is
{ "metricId", "calculation", "exerciseId"?, "repetitionType"?, "percentile"?, "origin"? }:calculationis one oflatest,avg,max,min,count,median,percentile(withpercentile0–100) orstdDev;repetitionTypeisconcentricoreccentric;originismanualortracked. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
dateRangedatetime[]- Start and end of the period read.
granularitystring- Bucket size the period implies:
day,weekormonth. Buckets start intimezone. bucketStartsdatetime[]- Start of every period, oldest first.
rows[].buckets(number | null)[]- The value per period, aligned with
bucketStarts;nullfor a period without one. rows[].changenumbernullable- Percent change from the first to the last period with a value.
rows[].errorstringnullable- Why this metric could not be read. The others are still answered.
Failures are described in error codes.
Team
Compare athletes on several metrics
A table of athletes by metric columns over a period, as the comparison board of Vitruve Labs shows it. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/comparison?from=2026-01-01&to=2026-03-31&userIds=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62%2Cc81d5f07-92ab-4e63-b0d4-7a3e6c1f9e28&columns=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/comparison?from=2026-01-01&to=2026-03-31&userIds=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62%2Cc81d5f07-92ab-4e63-b0d4-7a3e6c1f9e28&columns=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/comparison?from=2026-01-01&to=2026-03-31&userIds=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62%2Cc81d5f07-92ab-4e63-b0d4-7a3e6c1f9e28&columns=%5B%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D%5D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"total": 2,
"athletes": [
"3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"c81d5f07-92ab-4e63-b0d4-7a3e6c1f9e28"
],
"columns": [
{
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"calculation": "max",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"queryType": "max"
}
],
"cells": [
{
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"column": 0,
"value": 0.81,
"date": "2026-03-27T09:12:44.000Z"
},
{
"userId": "c81d5f07-92ab-4e63-b0d4-7a3e6c1f9e28",
"column": 0,
"value": 0.86,
"date": "2026-03-20T10:03:11.000Z"
}
]
}
}Query parameters
fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. userIdsstring- Comma-separated athlete ids, 1–100. Defaults to every athlete of your organization you can see. One outside it answers
404. columnsstringrequired- Array of metric specs, at least one: one column each. A metric spec is
{ "metricId", "calculation", "exerciseId"?, "repetitionType"?, "percentile"?, "origin"? }:calculationis one oflatest,avg,max,min,count,median,percentile(withpercentile0–100) orstdDev;repetitionTypeisconcentricoreccentric;originismanualortracked. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
dateRangedatetime[]- Start and end of the period read.
totalinteger- Athletes the comparison covered.
athletesuuid[]- The athletes, as rows.
columns[]object[]- The specs as read, in order, each with its
queryTypeand, when it could not be read, anerror. cells[]object[]{ userId, column, value, date? }:columnis the position incolumns;dateis present when the value is a single measurement.
Failures are described in error codes.
Relate two metrics across athletes
Two metric specs per athlete over a period, for a scatter plot, and their correlation. An athlete missing either value is left out. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/relationship?from=2026-01-01&to=2026-03-31&x=%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D&y=%7B%22metricId%22%3A%226e0c2b94-7a1f-4d58-b3e6-0f9d8a21c7b5%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/relationship?from=2026-01-01&to=2026-03-31&x=%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D&y=%7B%22metricId%22%3A%226e0c2b94-7a1f-4d58-b3e6-0f9d8a21c7b5%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/relationship?from=2026-01-01&to=2026-03-31&x=%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D&y=%7B%22metricId%22%3A%226e0c2b94-7a1f-4d58-b3e6-0f9d8a21c7b5%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"x": {
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"calculation": "max",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"queryType": "max"
},
"y": {
"metricId": "6e0c2b94-7a1f-4d58-b3e6-0f9d8a21c7b5",
"calculation": "max",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"queryType": "max"
},
"points": [
{
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"x": 0.81,
"y": 140
},
{
"userId": "c81d5f07-92ab-4e63-b0d4-7a3e6c1f9e28",
"x": 0.86,
"y": 155
}
],
"correlation": 0.72
}
}Query parameters
fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. userIdsstring- Comma-separated athlete ids, 1–100. Defaults to every athlete of your organization you can see. One outside it answers
404. xstringrequired- The metric spec of the x axis. A metric spec is
{ "metricId", "calculation", "exerciseId"?, "repetitionType"?, "percentile"?, "origin"? }:calculationis one oflatest,avg,max,min,count,median,percentile(withpercentile0–100) orstdDev;repetitionTypeisconcentricoreccentric;originismanualortracked. JSON, URL-encoded. ystringrequired- The metric spec of the y axis. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
dateRangedatetime[]- Start and end of the period read.
points[]object[]{ userId, x, y }, one per athlete with both values.correlationnumbernullable- Correlation coefficient of the points, −1 to 1.
nullwhen there are too few points.
Failures are described in error codes.
Get a metric's distribution
One metric spec’s value per athlete over a period: how it spreads across the group. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/snapshot?from=2026-01-01&to=2026-03-31&spec=%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/snapshot?from=2026-01-01&to=2026-03-31&spec=%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/snapshot?from=2026-01-01&to=2026-03-31&spec=%7B%22metricId%22%3A%22d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63%22%2C%22calculation%22%3A%22max%22%2C%22exerciseId%22%3A%221c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7%22%7D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"total": 12,
"series": {
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"calculation": "max",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"queryType": "max"
},
"values": [
{
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"value": 0.81,
"lastMeasuredAt": "2026-03-27T09:12:44.000Z"
},
{
"userId": "c81d5f07-92ab-4e63-b0d4-7a3e6c1f9e28",
"value": 0.86,
"lastMeasuredAt": "2026-03-20T10:03:11.000Z"
}
]
}
}Query parameters
fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. userIdsstring- Comma-separated athlete ids, 1–100. Defaults to every athlete of your organization you can see. One outside it answers
404. specstringrequired- The metric spec to read. A metric spec is
{ "metricId", "calculation", "exerciseId"?, "repetitionType"?, "percentile"?, "origin"? }:calculationis one oflatest,avg,max,min,count,median,percentile(withpercentile0–100) orstdDev;repetitionTypeisconcentricoreccentric;originismanualortracked. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
dateRangedatetime[]- Start and end of the period read.
totalinteger- Athletes the snapshot covered.
seriesobject- The spec as read, with its
queryType. values[]object[]{ userId, value, lastMeasuredAt }per athlete.lastMeasuredAtis when the value was measured, forlatest,maxandmin.
Failures are described in error codes.
VBT
Get load-velocity profile history
How an athlete’s load-velocity profile on an exercise moved: one automatic profile per four-week window of the period, plus one per test session, each graded and with its estimated 1RM. The Labs VBT profile page.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/profile?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/profile?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/profile?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2025-12-31T23:00:00.000Z",
"2026-03-31T21:59:59.999Z"
],
"historyFrom": "2024-04-01T22:00:00.000Z",
"exercise": {
"name": "Back squat",
"defaultMetricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"key": "mv",
"mvt": 0.3,
"mvtSource": "exercise"
},
"isEmpty": false,
"timeline": {
"windows": [
{
"from": "2026-01-01T00:00:00.000Z",
"to": "2026-01-28T23:59:59.999Z",
"grade": "A",
"e1rm": 142.5,
"maxLoad": 120,
"v0": 1.62,
"l0": 201.3,
"r2": 0.97,
"loads": [
60,
80,
100,
120
],
"fails": []
},
{
"from": "2026-01-29T00:00:00.000Z",
"to": "2026-02-25T23:59:59.999Z",
"grade": "X",
"e1rm": null,
"maxLoad": 100,
"v0": null,
"l0": null,
"r2": null,
"loads": [
80,
100
],
"fails": [
{
"code": "loads",
"value": 2,
"min": 3
}
]
}
],
"tests": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"from": "2026-03-10T00:00:00.000Z",
"to": "2026-03-10T23:59:59.999Z",
"grade": "A",
"e1rm": 147,
"maxLoad": 130,
"v0": 1.65,
"l0": 205.8,
"r2": 0.98,
"loads": [
60,
90,
110,
130
],
"fails": []
}
]
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. metricIduuid- Velocity metric the profiles are read on: mean velocity (MV), mean propulsive velocity (MPV) or peak velocity. Defaults to the exercise’s own.
mvtnumber- Velocity at 1RM (minimum velocity threshold), 0.05–1 m/s. Defaults to the exercise’s own, else Vitruve’s default.
minLoadsintegerdefault3- Distinct loads a profile needs, 2–8.
minSpreadnumberdefault0.4- Velocity range (m/s) between the lightest and heaviest load a profile needs, 0.1–1.2.
minR2numberdefault0.9- Goodness of fit a profile needs, 0.5–0.99.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- The period must last at least 7 days.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
- Grades, failures and verdicts are codes, not sentences, so you can word them in your own language.
Response fields
dateRangedatetime[]- Start and end of the period read.
isEmptyboolean- The athlete has no data on the exercise in the period.
historyFromdatetime- Earliest date the history is read from.
exercise.namestring- Exercise name.
exercise.keystring- Velocity the profiles are read on:
mv,mpvorpv. exercise.mvtnumbernullable- Velocity at 1RM used, in m/s.
exercise.mvtSourcestringnullable- Where
mvtcame from:settings(yourmvt),exerciseordefault. timeline.windows[]object[]- One automatic profile per four-week window, oldest first.
timeline.windows[].gradestringAmeets every threshold,Bis usable with reservations,Xis not a profile (seefails).timeline.windows[].e1rmnumbernullable- Estimated 1RM in kg, read at
mvt. timeline.windows[].fails[]object[]- Thresholds missed:
codeisloads,spread,r2(withvalueandmin) orslope(velocity doesn’t fall with load). timeline.tests[]object[]- One profile per test session, with its
workoutId.
Failures are described in error codes.
Fit a load-velocity profile
The load-velocity line fitted on the period’s points, as the app’s automatic profile: one point per load and day (its fastest rep), its quality, and the equation ready to save with POST /equations.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/auto-profile?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&excluded=%5B%222026-02-03%3A120%22%5D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/auto-profile?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&excluded=%5B%222026-02-03%3A120%22%5D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/auto-profile?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&excluded=%5B%222026-02-03%3A120%22%5D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2025-12-31T23:00:00.000Z",
"2026-03-31T21:59:59.999Z"
],
"isEmpty": false,
"exercise": {
"name": "Back squat",
"defaultMetricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"key": "mv"
},
"settings": {
"minLoads": 3,
"minSpread": 0.4,
"minR2": 0.9,
"oneRmVelocity": 0.3,
"oneRmVelocitySource": "exercise"
},
"points": [
{
"id": "2026-02-03:80",
"day": "2026-02-03",
"date": "2026-02-03T08:12:00.000Z",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"load": 80,
"v": 0.92,
"sets": 2,
"isIncluded": true,
"repId": "e19a4d83-5b60-4c27-a8f1-0d7c3e52b946",
"isAutoRep": true,
"reps": [
{
"id": "e19a4d83-5b60-4c27-a8f1-0d7c3e52b946",
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-02-03T08:12:00.000Z",
"setIndex": 0,
"rep": 1,
"v": 0.92
}
]
}
],
"isRepresentative": true,
"quality": {
"ok": true,
"grade": "A",
"loads": 4,
"spread": 0.58,
"r2": 0.97,
"fit": {
"v0": 1.62,
"slope": -0.0081,
"r2": 0.97
},
"params": {
"v0": 1.62,
"l0": 200,
"slope": -0.0081,
"aline": 1.3,
"e1rm": 162.9,
"maxLoad": 120
},
"fails": [],
"hint": null
},
"equation": {
"a": 0,
"b": -0.6139,
"c": 118.4,
"r2": 0.97,
"oneRm": 162.9,
"oneRmVelocity": 0.3,
"series": [
{
"weight": 80,
"velocity": 0.92,
"order": 0
},
{
"weight": 162.9,
"velocity": 0.3,
"order": 4
}
]
},
"block": null
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. metricIduuid- Velocity metric the profiles are read on: mean velocity (MV), mean propulsive velocity (MPV) or peak velocity. Defaults to the exercise’s own.
minLoadsintegerdefault3- Distinct loads a profile needs, 2–8.
minSpreadnumberdefault0.4- Velocity range (m/s) between the lightest and heaviest load a profile needs, 0.1–1.2.
minR2numberdefault0.9- Goodness of fit a profile needs, 0.5–0.99.
excludedstring- Array of point
ids to leave out of the fit, at most 500. JSON, URL-encoded. pickedstring- Array of
{ "pointId", "repId" }, at most 500: the rep to read a point on instead of its fastest one. JSON, URL-encoded. oneRmVelocitynumber- Velocity the 1RM is lifted at, 0.05–1 m/s: the 1RM is the load the line reaches it at. Defaults to the exercise’s own, else Vitruve’s default.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
Response fields
dateRangedatetime[]- Start and end of the period read.
isEmptyboolean- The athlete has no data on the exercise in the period.
exercise.namestring- Exercise name.
exercise.keystring- Velocity the profiles are read on:
mv,mpvorpv. settingsobject- Thresholds and 1RM velocity applied, with
oneRmVelocitySource:settings,exerciseordefault. points[]object[]- One point per load and day.
idis whatexcludedandpickedtake;repIdis the rep read (isAutoRepfalse when you picked it) andrepsevery rep it could be read on, fastest first. isRepresentativeboolean- With every point in, the data has enough loads and velocity range for a profile.
qualityobject- Grade (
A,B,X), thresholds missed (fails) and the fitted line.hintiswarmupwhen more loads or a wider velocity range would unlock a profile. equationobjectnullable- The equation in the shape
POST /equationstakes, the 1RM as the last of itsseries. Null when the points give none (block). blockstringnullableprofilewhen the points don’t make a profile.
Failures are described in error codes.
Compare saved load-velocity profiles
Every load-velocity profile saved for an athlete on an exercise and metric, oldest first, each read as a line, and what changed between two of them. Takes no period.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/equations?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/equations?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/equations?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"exercise": {
"name": "Back squat",
"defaultMetricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"key": "mv"
},
"settings": {
"swc": 0.04
},
"isEmpty": false,
"otherMetrics": 0,
"equations": [
{
"id": "4b1e7c90-d25a-4f38-8a6e-0c9f3d72b815",
"name": "Pre-season",
"createdAt": "2025-09-02T08:00:00.000Z",
"isSelected": false,
"isPersonal": false,
"type": "linear",
"r2": 0.96,
"oneRm": 140,
"points": [
{
"load": 60,
"v": 1.08
},
{
"load": 100,
"v": 0.68
}
],
"params": {
"v0": 1.66,
"l0": 194.2,
"slope": -0.0086,
"aline": 1.29,
"e1rm": 140,
"minLoad": 60,
"maxLoad": 100
}
},
{
"id": "ad30e6f9-8c47-4b12-a5d8-e91f2c7b4063",
"name": "March test",
"createdAt": "2026-03-10T09:00:00.000Z",
"isSelected": true,
"isPersonal": false,
"type": "linear",
"r2": 0.98,
"oneRm": 147,
"points": [
{
"load": 60,
"v": 1.12
},
{
"load": 130,
"v": 0.43
}
],
"params": {
"v0": 1.65,
"l0": 205.8,
"slope": -0.008,
"aline": 1.36,
"e1rm": 147,
"minLoad": 60,
"maxLoad": 130
}
}
],
"comparison": {
"isAvailable": true,
"aId": "ad30e6f9-8c47-4b12-a5d8-e91f2c7b4063",
"bId": "4b1e7c90-d25a-4f38-8a6e-0c9f3d72b815",
"verdict": "heavy",
"tone": "heavy",
"range": [
60,
100
],
"isExtrapolated": false,
"light": {
"load": 65,
"delta": 0.01
},
"heavy": {
"load": 95,
"delta": 0.05
},
"grid": [
{
"load": 60,
"delta": 0.01,
"pct": 0.9
},
{
"load": 100,
"delta": 0.06,
"pct": 8.8
}
]
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. metricIduuid- Velocity metric the profiles are read on: mean velocity (MV), mean propulsive velocity (MPV) or peak velocity. Defaults to the exercise’s own.
swcnumberdefault0.04- Smallest worthwhile change in velocity (m/s), 0.01–0.2: smaller differences count as no change.
auuid- Profile to read against
b. Defaults to the newest profile with a line. buuid- Profile
ais compared with. Defaults to the newest one with a line beforea.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
- Grades, failures and verdicts are codes, not sentences, so you can word them in your own language.
Response fields
exercise.namestring- Exercise name.
exercise.keystring- Velocity the profiles are read on:
mv,mpvorpv. isEmptyboolean- The athlete has no saved profile on this metric.
otherMetricsinteger- Profiles of this exercise saved on another metric.
equations[]object[]- Saved profiles, oldest first.
isPersonalmarks one the athlete saved outside your organization.paramsis null without a 1RM or when velocity rises with load. comparisonobjectaagainstb. WithisAvailablefalse,reasonisfewer-than-twoorno-line.comparison.verdictstringup,heavy,light,down-all,down-heavy,down-lightorflat: where along the load rangeais faster or slower thanb.comparison.grid[]object[]- Velocity difference (
delta, m/s, andpct) at loads across the common range.
Failures are described in error codes.
Get velocity loss
Velocity loss within the sets and sessions of an athlete on an exercise, judged against each set’s target. The Labs VBT fatigue page.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/fatigue?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&settings=%7B%22vlTarget%22%3A25%7D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/fatigue?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&settings=%7B%22vlTarget%22%3A25%7D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/fatigue?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&settings=%7B%22vlTarget%22%3A25%7D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2025-12-31T23:00:00.000Z",
"2026-03-31T21:59:59.999Z"
],
"exercise": {
"name": "Back squat",
"vlKey": "mv"
},
"settings": {
"vlDef": "best",
"vlTarget": 25,
"usePrescribed": true
},
"isEmpty": false,
"fatigue": {
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"name": "Lower body A",
"isTest": false,
"sets": 4,
"maxLoad": 110,
"meanVl": 18.4
}
],
"selected": null,
"axis": "pct",
"scatter": [
{
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"setIndex": 0,
"load": 100,
"reps": 5,
"rep1": 0.71,
"best": 0.72,
"last": 0.59,
"vl": 18.1,
"target": 20,
"targetSource": "prescribed",
"isWithin": true,
"x": 68
}
],
"within": 14,
"total": 16,
"prescribed": 10,
"withinSession": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"load": 100,
"first": 0.72,
"last": 0.66,
"drop": 8.3
}
],
"repsToTarget": [
{
"start": "2026-03-09T00:00:00.000Z",
"sets": 4,
"targets": [
20
],
"intensity": 70,
"reps": 5
}
]
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "vlDef", "vlTarget", "usePrescribed" }:vlDefisbest(default, loss from the fastest rep) orfirst;vlTargetthe default target in %, 5–50 (default 20);usePrescribed(defaulttrue) judges a set against its prescribed velocity loss when it has one. JSON, URL-encoded.workoutIduuid- One session of the period to detail in
selected. Defaults to none.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
Response fields
dateRangedatetime[]- Start and end of the period read.
isEmptyboolean- The athlete has no data on the exercise in the period.
exercise.namestring- Exercise name.
exercise.vlKeystring- Velocity the velocity loss is read on:
mvorpv. fatigue.sessions[]object[]- Sessions of the period with their mean velocity loss.
fatigue.selectedobjectnullable- The sets of
workoutId, when you pass it. fatigue.scatter[]object[]- Every set: velocity of the first, best and last rep, its loss
vl(%), thetargetit was judged against (prescribedordefault) andisWithin.xis the load as % of 1RM whenaxisispct, else kg. fatigue.withininteger- Sets within their target, out of
total. fatigue.withinSession[]object[]- Velocity drop (%) between the first and last set at the same load in a session.
fatigue.repsToTarget[]object[]- Per week: reps performed before reaching the target.
Failures are described in error codes.
Get velocity at a reference load
Readiness and training zones of an athlete on an exercise: velocity at a reference load across sessions against the athlete’s recent baseline, and the weekly reps per velocity zone. The Labs VBT load page.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/load?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&refLoad=100" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/load?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&refLoad=100',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/load?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&refLoad=100",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2025-12-31T23:00:00.000Z",
"2026-03-31T21:59:59.999Z"
],
"historyFrom": "2025-10-01T00:00:00.000Z",
"exercise": {
"name": "Back squat",
"vlKey": "mv"
},
"settings": {
"baseN": 6,
"readyBand": 0.03,
"zones": [
0.5,
0.75,
1,
1.3
],
"zonesPV": [
1.5,
1.8,
2.1,
2.4
]
},
"isEmpty": false,
"load": {
"readiness": {
"key": "mv",
"candidates": [
{
"load": 100,
"sessions": 14
},
{
"load": 80,
"sessions": 9
}
],
"load": 100,
"source": "coach",
"series": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"v": 0.72,
"base": 0.68,
"status": "above",
"isInPeriod": true
}
],
"latest": {
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"v": 0.72,
"base": 0.68,
"status": "above",
"isInPeriod": true
}
},
"zones": {
"key": "mv",
"bounds": [
0.5,
0.75,
1,
1.3
],
"weeks": [
{
"start": "2026-03-09T00:00:00.000Z",
"end": "2026-03-15T23:59:59.999Z",
"counts": [
2,
10,
8,
4,
0
],
"reps": 24,
"tonnage": 2120
}
],
"totals": [
18,
96,
71,
40,
3
],
"slow": 7.8,
"fast": 18.9
}
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "baseN", "readyBand", "zones", "zonesPV", "readinessKey" }:baseNsessions in the baseline, 3–15 (default 6);readyBandthe band around it in m/s, 0.01–0.15 (default 0.03);zonesandzonesPVfour increasing velocity limits in m/s (defaults[0.5, 0.75, 1, 1.3]and[1.5, 1.8, 2.1, 2.4]for peak velocity);readinessKeymv,mpvorpv(default the exercise’s own). JSON, URL-encoded.refLoadnumber- Reference load in kg. Defaults to the load most sessions of the history were lifted at.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
Response fields
dateRangedatetime[]- Start and end of the period read.
isEmptyboolean- The athlete has no data on the exercise in the period.
historyFromdatetime- Earliest date the baseline history is read from.
load.readiness.loadnumbernullable- Reference load read, in kg: yours (
sourcecoach) or the most frequent (auto).candidateslists the loads with their session counts. load.readiness.series[]object[]- Velocity at the reference load per session, its baseline
baseandstatus:above,belowornormalagainst the baseline band. load.zones.weeks[]object[]- Per week: reps in each of the five velocity zones
boundsdelimit, slowest first, total reps and tonnage (kg). load.zones.slownumbernullable- Share (%) of reps in the two slowest zones;
fast, in the two fastest.
Failures are described in error codes.
Get a VBT metric per set
One VBT metric of an athlete on an exercise, set by set and session by session, with how sets at each load spread. The Labs VBT metric page.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/metric?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&metric=mv&summary=best" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/metric?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&metric=mv&summary=best',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/metric?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&metric=mv&summary=best",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2025-12-31T23:00:00.000Z",
"2026-03-31T21:59:59.999Z"
],
"exercise": {
"name": "Back squat",
"vlKey": "mv"
},
"metric": "mv",
"summary": "best",
"settings": {
"vlDef": "best",
"range": {
"min": null,
"max": null
}
},
"isEmpty": false,
"board": {
"unit": null,
"metricId": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"axis": "pct",
"sets": [
{
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"setIndex": 0,
"isTest": false,
"load": 100,
"reps": 5,
"value": 0.72,
"min": 0.59,
"max": 0.72,
"isWithin": true,
"target": null,
"targetSource": null,
"loss": null,
"x": 68
}
],
"byLoad": [
{
"load": 100,
"n": 14,
"mean": 0.7,
"median": 0.7,
"min": 0.64,
"max": 0.75,
"q1": 0.68,
"q3": 0.72,
"sd": 0.03,
"cv": 4.3,
"band": null
}
],
"band": null,
"range": null,
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"name": "Lower body A",
"isTest": false,
"sets": 4,
"counted": 4,
"maxLoad": 110,
"mean": 0.69,
"min": 0.61,
"max": 0.72
}
],
"selected": null,
"mean": 0.7,
"sd": 0.05,
"cv": 7.1,
"within": 16,
"total": 16,
"split": 90,
"light": {
"median": 0.86,
"n": 22
},
"heavy": {
"median": 0.61,
"n": 18
},
"rom": null
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. metricstringdefaultvl- What each set is read through:
vl(velocity loss), one ofmv,mpv,pv,mp,pp,rom, or the id of a VBT repetition metric fromGET /metrics. summarymean | best | first | lastdefaultmean- How a set’s reps are summarised for a repetition metric.
settingsstring{ "vlDef", "range" }:vlDefisbest(default) orfirst;range{ "min", "max" }is your band for the metric in its stored unit (percent for velocity loss). Without a bound, sets are read, not judged. JSON, URL-encoded.workoutIduuid- One session of the period to detail in
selected. Defaults to none.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
Response fields
dateRangedatetime[]- Start and end of the period read.
isEmptyboolean- The athlete has no data on the exercise in the period.
metricstringvlor the id of the metric read.board.unitstringnullablepctfor velocity loss; otherwise null and values are in the unit ofboard.metricId.board.sets[]object[]- Every set: its
value, lowest and highest rep, whether it is within your band (isWithin), and for velocity loss thetargetand the velocities it was read from (loss).xis % of 1RM whenaxisispct, else kg. board.byLoad[]object[]- Distribution of the sets at each load: count, mean, median, quartiles, standard deviation and coefficient of variation (%).
board.sessions[]object[]- Per session: sets, sets counted and the metric’s mean, min and max.
board.lightobject- Median of the sets below the
splitload;heavy, of those at or above it.
Failures are described in error codes.
Get repetition curves
Repetition-level velocity, power and force curves of an athlete on an exercise, compared by load, session, set or free pick. The Labs VBT reps page.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/reps?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&mode=load&load=100" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/reps?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&mode=load&load=100',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/reps?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&mode=load&load=100",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2025-12-31T23:00:00.000Z",
"2026-03-31T21:59:59.999Z"
],
"historyFrom": "2025-10-01T00:00:00.000Z",
"exercise": {
"name": "Back squat",
"vlKey": "mv"
},
"isEmpty": false,
"reps": {
"isAvailable": true,
"mode": "load",
"workoutId": null,
"serieId": null,
"load": 100,
"options": {
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"isTest": false,
"loads": 3
}
],
"sets": [],
"loads": [
{
"load": 100,
"sessions": 14
}
]
},
"curves": [
{
"repId": "e19a4d83-5b60-4c27-a8f1-0d7c3e52b946",
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"load": 100,
"setIndex": 0,
"repIndex": 0,
"mv": 0.72,
"pv": 1.21,
"rom": 0.58,
"v20": 0.64,
"peakPower": 1580,
"peakPos": 62,
"peakTimeMs": 410,
"brakingPct": 14,
"sticking": {
"pos": 28,
"v": 0.55
},
"durationMs": 790,
"samples": [
{
"x": 0,
"t": 0,
"v": 0,
"p": 0,
"f": 981,
"a": 0,
"d": 0
},
{
"x": 50,
"t": 395,
"v": 0.81,
"p": 1350,
"f": 1667,
"a": 0.7,
"d": 0.29
}
]
}
],
"delta": {
"mv": 0.03,
"mvPct": 4.3,
"v20": 0.02,
"v20Pct": 3.2,
"peakPower": 60,
"peakPowerPct": 3.9,
"peakPos": -2,
"peakTimeMs": -15,
"brakingPct": -1
}
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. modeload | session | set | freedefaultload- What the curves compare: sessions at one
load, the reps of a session (workoutId) or of a set (serieId), or reps you pick (picks). workoutIduuid- Session to read in
sessionandsetmodes. serieIduuid- Set to read in
setmode. loadnumber- Load in kg for
loadmode. Defaults to the most frequent. picksstring- Comma-separated repetition ids for
freemode, at most 6.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
Response fields
dateRangedatetime[]- Start and end of the period read.
isEmptyboolean- The athlete has no data on the exercise in the period.
reps.isAvailableboolean- Curves were found for the selection.
reps.optionsobject- Sessions, sets (with their reps) and loads you can pick from.
reps.curves[]object[]- One curve per rep: summary figures (mean and peak velocity, velocity over the first 20 %, peak power and where and when it happens, braking %, sticking point, duration) and
samples. reps.curves[].samples[]object[]- 101 samples, one per 1 % (
x) of the concentric range of motion: timet(ms), velocityv(m/s), powerp(W), forcef(N), accelerationa(m/s²) and displacementd(m). Force and power use the bar’s mass only. reps.deltaobjectnullable- Difference between the curves compared.
Failures are described in error codes.
Get range of motion
Range of motion of every rep of an athlete on an exercise and how consistent it is. The Labs VBT range-of-motion page.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/rom?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/rom?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/rom?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2025-12-31T23:00:00.000Z",
"2026-03-31T21:59:59.999Z"
],
"exercise": {
"name": "Back squat",
"vlKey": "mv"
},
"settings": {
"romTol": 6
},
"isEmpty": false,
"rom": {
"band": {
"median": 0.58,
"lo": 0.545,
"hi": 0.615,
"tol": 6
},
"reps": [
{
"repId": "e19a4d83-5b60-4c27-a8f1-0d7c3e52b946",
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"load": 100,
"rom": 0.57,
"isInBand": true
}
],
"split": 90,
"light": {
"median": 0.59,
"n": 110
},
"heavy": {
"median": 0.57,
"n": 84
},
"isShortening": false,
"cv": 3.1,
"outside": 9,
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"median": 0.58,
"min": 0.54,
"max": 0.6,
"n": 20
}
]
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "romTol" }: tolerance around the median range of motion in %, 2–20 (default 6). JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
Response fields
dateRangedatetime[]- Start and end of the period read.
isEmptyboolean- The athlete has no data on the exercise in the period.
rom.bandobjectnullable- Median range of motion (m) and the band
romTol% around it. rom.reps[]object[]- Every rep with its range of motion and whether it is in the band.
rom.isShorteningboolean- The median range of motion of heavy reps (at or above the
splitload) is clearly shorter than that of light ones. rom.outsideinteger- Reps outside the band.
rom.sessions[]object[]- Per session: median, min and max range of motion and reps.
Failures are described in error codes.
Get VBT data points
Every rep of an athlete on an exercise in the period as a data point, optionally with teammates’ for comparison, and the raw values a page at a time. The Labs VBT data page.
Request
curl "https://api-next.vitruve.fit/v1/labs/vbt/data?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&metric=mv&page=0" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/vbt/data?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&metric=mv&page=0',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/vbt/data?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&timezone=Europe%2FMadrid&metric=mv&page=0",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2025-12-31T23:00:00.000Z",
"2026-03-31T21:59:59.999Z"
],
"exercise": {
"name": "Back squat",
"vlKey": "mv"
},
"isEmpty": false,
"data": {
"points": [
{
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"isMe": true,
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"repId": "e19a4d83-5b60-4c27-a8f1-0d7c3e52b946",
"date": "2026-03-10T08:00:00.000Z",
"isTest": false,
"load": 100,
"pct": 68,
"setIndex": 0,
"repIndex": 0,
"mv": 0.72,
"mpv": 0.79,
"pv": 1.21,
"rom": 0.57,
"mp": 702,
"pp": 1580,
"vl": 18.1
}
],
"table": {
"rows": [
{
"id": "86a1c4e7-3b05-4d9f-92e8-5f1d7c0a3b94",
"repId": "e19a4d83-5b60-4c27-a8f1-0d7c3e52b946",
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-10T08:00:00.000Z",
"metric": "mv",
"value": 0.72
}
],
"total": 412,
"page": 0,
"pageSize": 25
}
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. userIdsstring- Comma-separated ids of teammates whose reps join
points, 1–100. Defaults to none. One outside your organization answers404. metricall | load | mv | mpv | pv | rom | mp | ppdefaultall- Metric the raw value table lists.
pageintegerdefault0- Page of the raw value table, from 0, 25 rows a page. A page past the end returns the last one.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Every number is in stored SI units: loads in kg, velocities in m/s, range of motion in m, power in W, velocity loss and intensities in percent.
Response fields
dateRangedatetime[]- Start and end of the period read.
isEmptyboolean- The athlete has no data on the exercise in the period.
data.points[]object[]- Every rep: load, % of 1RM (
pct, the athlete’s own reps only), mean, mean propulsive and peak velocity, range of motion, mean and peak power, and the set’s velocity loss.isMeis false for teammates. data.table.rows[]object[]- Raw concentric values of the athlete, one per metric value (
id). data.table.totalinteger- Rows across every page.
Failures are described in error codes.
Jump
Get a jump insight
One athlete’s jumps on one jump exercise over a period, as the Labs jump page computes them: the change between two windows, development over time, how height is produced, training exposure, results by load and patterns worth reviewing. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/jump?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&targetHeight=0.45" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/jump?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&targetHeight=0.45',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/jump?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&targetHeight=0.45",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"granularity": "week",
"periods": {
"a": {
"role": "earlier",
"from": "2026-01-01T00:00:00.000Z",
"to": "2026-02-14T23:59:59.999Z"
},
"b": {
"role": "later",
"from": "2026-02-15T00:00:00.000Z",
"to": "2026-03-31T23:59:59.999Z"
}
},
"threshold": 3,
"conditions": [
{
"key": "algorithm:jump|load:0",
"sessions": 13,
"observations": 78,
"lastAt": "2026-03-28T09:41:00.000Z",
"attributes": {
"algorithm": "jump",
"load": 0
}
}
],
"condition": "algorithm:jump|load:0",
"annotations": [],
"profile": "countermovement",
"measures": {
"output": "d06b3f81-4e92-4a7c-8c15-b7e29a0d5f63",
"timing": "0f3c9a51-7b2d-4e68-a1c4-5d8e2b9f6a03",
"ratio": "4a8d2e61-c3f7-4b90-8e15-9b6a0d7c3f24",
"power": "8e1b5c73-2a9d-4f06-b7e3-c40d9a6e1b58"
},
"summary": {
"output": {
"basis": "median-of-session-means",
"change": {
"a": 0.412,
"b": 0.431,
"aSessions": 6,
"bSessions": 7,
"delta": 0.019,
"percent": 4.6,
"scale": "relative",
"direction": "improved"
}
},
"bestOutput": {
"basis": "median-of-session-bests",
"change": {
"a": 0.438,
"b": 0.452,
"aSessions": 6,
"bSessions": 7,
"delta": 0.014,
"percent": 3.2,
"scale": "relative",
"direction": "improved"
}
},
"timing": {
"basis": "median-of-session-means",
"change": {
"a": 742,
"b": 731,
"aSessions": 6,
"bSessions": 7,
"delta": -11,
"percent": -1.5,
"scale": "relative",
"direction": "similar"
}
},
"totals": {
"a": {
"sessions": 6,
"attempts": 36,
"weeks": 6.4
},
"b": {
"sessions": 7,
"attempts": 42,
"weeks": 6.4
}
},
"targetHeightShare": {
"basis": "pooled-share",
"change": {
"a": 22.2,
"b": 38.1,
"aSessions": 6,
"bSessions": 7,
"delta": 15.9,
"percent": 71.6,
"scale": "points",
"direction": "improved"
}
},
"sequences": null
},
"development": {
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-28T09:30:00.000Z",
"sides": [
"b"
],
"attempts": 6,
"output": 0.436,
"best": 0.452,
"timing": 728,
"ratio": 0.6,
"power": 3920,
"relativePower": 51.6,
"cv": 2.8,
"load": 0,
"sequence": null
}
],
"buckets": [
{
"start": "2026-03-23T00:00:00.000Z",
"end": "2026-03-29T23:59:59.999Z",
"isPartial": false,
"sessions": 1,
"attempts": 6,
"output": {
"median": 0.436,
"min": 0.421,
"max": 0.452
},
"best": 0.452,
"timing": 728,
"ratio": 0.6,
"cv": 2.8
}
]
},
"strategy": {
"classification": "higher-output-similar-timing",
"points": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-28T09:30:00.000Z",
"sides": [
"b"
],
"timing": 728,
"height": 0.452
}
],
"a": {
"sessions": 6,
"attempts": 36,
"timing": {
"n": 36,
"mean": 744,
"median": 742,
"sd": 21,
"min": 702,
"max": 790,
"p25": 731,
"p75": 758,
"p90": 772
},
"height": {
"n": 36,
"mean": 0.413,
"median": 0.412,
"sd": 0.012,
"min": 0.388,
"max": 0.438,
"p25": 0.405,
"p75": 0.421,
"p90": 0.429
}
}
},
"exposure": {
"buckets": [
{
"start": "2026-03-23T00:00:00.000Z",
"end": "2026-03-29T23:59:59.999Z",
"isPartial": false,
"sessions": 1,
"attempts": 6,
"load": null,
"targets": {
"eligible": 0,
"within": 0
},
"targetHeight": {
"eligible": 6,
"within": 3
}
}
],
"sequences": []
},
"loadProfile": null,
"patterns": [
{
"kind": "output-timing-diverge",
"tone": "better",
"from": "2026-02-15T00:00:00.000Z",
"to": "2026-03-31T23:59:59.999Z",
"workoutIds": [
"f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35"
],
"observations": 42,
"review": "strategy-execution",
"panel": "strategy",
"values": {
"output": 4.6,
"timing": -1.5
}
}
]
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. comparisonstring- What the period is compared against:
{ "mode": "halves" }(default) splits it into its earlier and later half;{ "mode": "periods", "a": { "from", "to" }, "b": { "from", "to" } }names two subperiods;{ "mode": "reference", "reference": { "from", "to" } }holds the whole period against another one, which may lie outside it. JSON, URL-encoded. thresholdnumber- Smallest change that counts, 0.5–50: percent of the earlier value, or percentage points for a measure that is itself a percentage. Smaller changes read as
similar. conditionstring- The jump protocol and load band to read, as a
conditions[].keyof a previous response. Defaults to the most used one. targetHeightnumber- A target height in metres, up to 2. Each jump is checked against it (
summary.targetHeightShare).
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Heights in m, flight, contraction and contact times in ms, RSI in m/s, power in W (relative power in W/kg), loads in kg, CV and shares in percent. Rates are per calendar week.
Response fields
dateRangedatetime[]- Start and end of the period read.
granularitystringsessionfor a short period, elseweekormonth: how the development is bucketed.periodsobject- The two periods compared:
ais the one compared against,bthe one being read. Each hasrole,fromandto. conditions[]object[]- Every measurement context the athlete recorded, with
key,sessions,observations,lastAtand itsattributes. Pass akeyasconditionto read another one. conditionstringnullable- The context read.
annotations[]object[]- Program phase changes in the period (
date,workoutId,phaseName,programName). summaryobject- Period-to-period changes. Each has
a,b,aSessions,bSessions,delta,percent,scale(relativeorpoints) anddirection:improved,declined,similar, orinsufficientwhen a period holds too few sessions to compare. patterns[]object[]- Patterns worth reviewing, as data:
kind,tone(worse,watch,better,neutral), when they held, the supportingworkoutIdsand theirvalues. No sentence is included. profilestringcountermovement, read off the contraction before take-off, orreactive, read off ground contact.measuresobject- The metric each role (
output,timing,ratio,power) is read from. Resolve withGET /metrics/{id}. developmentobject- Per-session values (
sessions) and calendar buckets (buckets), oldest first. strategyobject- Each jump’s height against its timing, the two periods summarised (
a,b) and aclassificationof where the change came from. exposureobject- Sessions, jumps and loads per bucket, and the repeated-jump sequences.
loadProfileobject[]nullable- Height by load band in each period;
nullfor an unloaded condition. sessions[]object[]- Each session with its sets and jumps, newest first.
Failures are described in error codes.
Get jump development
One jump measure over time for one athlete and jump exercise, session by session, with every jump of every set. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/jump/development?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&settings=%7B%22measure%22%3A%22height%22%2C%22stat%22%3A%22best%22%7D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/jump/development?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&settings=%7B%22measure%22%3A%22height%22%2C%22stat%22%3A%22best%22%7D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/jump/development?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&settings=%7B%22measure%22%3A%22height%22%2C%22stat%22%3A%22best%22%7D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"isEmpty": false,
"settings": {
"measure": "height",
"load": null,
"stat": "best"
},
"exercise": {
"name": "Countermovement Jump"
},
"profile": "countermovement",
"loads": [
0,
20
],
"measures": [
"height",
"flightTime",
"contractionTime",
"peakPower"
],
"timeline": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-28T09:30:00.000Z",
"name": "Lower body power",
"n": 6,
"value": 0.452,
"best": 0.452,
"median": 0.436,
"min": 0.421,
"max": 0.452,
"timing": 728,
"ratio": 0.6
}
],
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-28T09:30:00.000Z",
"name": "Lower body power",
"sets": [
{
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"index": 1,
"load": 0,
"algorithm": "jump",
"attempts": [
{
"repetitionId": "e19a4d83-5b60-4c27-a8f1-0d7c3e52b946",
"index": 1,
"height": 0.452,
"flightTime": 607,
"contractionTime": 728,
"peakPower": 3920
}
]
}
]
}
]
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "measure", "load", "stat" }:measureis the jump reading to follow (defaultheight; alsoflightTime,contractionTime,contactTime,rsi,modifiedRsi,peakPower,relativePeakPower,avgPower,peakForce,relativePeakForce,forceAtPeakVelocity,positiveImpulse,netImpulse,timeToPeakVelocity,timeToPeakForce,timeToPeakPower);loada load band in kg (default: every load);statthe session value,best(default) ormedian. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Heights in m, times in ms, power in W and W/kg, force in N and N/kg, impulse in N·s, loads in kg.
Response fields
isEmptyboolean- No jump in the period.
settingsobject- The settings applied, with defaults filled in.
profilestringcountermovementorreactive.loadsnumber[]- Load bands recorded, in kg.
measuresstring[]- Measures with a reading in the period.
timeline[]object[]- One point per session, oldest first:
valueis the chosenstatofmeasure;timingandratiothe profile’s contraction or contact time and RSI. sessions[]object[]- Sessions newest first, with every set and jump and all its measures.
Failures are described in error codes.
Get reactive jump strength
How well one athlete keeps rebound quality through repeated contacts, from the sets that ran the repeated-contacts protocol. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/jump/reactive?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/jump/reactive?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/jump/reactive?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"isEmpty": false,
"settings": {
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250"
},
"exercise": {
"name": "10-5 Repeated Jump"
},
"profile": "reactive",
"isAvailable": true,
"sets": [
{
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-28T09:30:00.000Z",
"index": 1,
"contacts": 10,
"reactiveScore": 2.14,
"contactTime": 178,
"height": 0.381,
"retention": 94.2,
"cv": 3.1
}
],
"timeline": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-28T09:30:00.000Z",
"name": "Plyometrics",
"sets": 2,
"reactiveScore": 2.14,
"contactTime": 178,
"height": 0.381,
"retention": 94.2
}
],
"selected": {
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"contacts": [
{
"index": 1,
"height": 0.39,
"contactTime": 181,
"rsi": 2.15
},
{
"index": 2,
"height": 0.386,
"contactTime": 176,
"rsi": 2.19
}
]
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. serieIduuid- A set to break down contact by contact (
selected). Defaults to the latest one.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
isAvailableboolean- Whether the exercise has sets of the repeated-contacts protocol.
sets[]object[]- Each repeated-jump set:
reactiveScore(m/s), mediancontactTime(ms),height(m),retention(height of the last contacts as a percent of the first) andcv(percent). timeline[]object[]- One point per session, oldest first.
selectedobjectnullable- The chosen set, contact by contact.
Failures are described in error codes.
Get jump strategy
Whether one athlete’s jump gains come from height or from a faster movement: each jump’s height against its timing, the first and last third of their sessions compared. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/jump/strategy?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/jump/strategy?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/jump/strategy?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"isEmpty": false,
"settings": {
"load": null
},
"exercise": {
"name": "Countermovement Jump"
},
"profile": "countermovement",
"loads": [
0
],
"points": [
{
"repetitionId": "e19a4d83-5b60-4c27-a8f1-0d7c3e52b946",
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-28T09:30:00.000Z",
"height": 0.452,
"timing": 728,
"ratio": 0.6,
"phase": "late"
}
],
"early": {
"n": 24,
"height": {
"median": 0.408,
"p25": 0.399,
"p75": 0.416
},
"timing": {
"median": 748,
"p25": 735,
"p75": 761
}
},
"late": {
"n": 26,
"height": {
"median": 0.433,
"p25": 0.425,
"p75": 0.442
},
"timing": {
"median": 731,
"p25": 720,
"p75": 744
}
},
"classification": "higher-faster"
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "load" }: a load band in kg. Defaults to every load. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
points[]object[]- Every jump:
height(m),timing(contraction or contact time, ms),ratioand the third of the sessions it falls in (phase:early,middle,late). earlyobjectnullable- The first third of the sessions: jump count and the median and quartiles of height and timing.
lateobjectnullable- The last third, the same way.
classificationstringhigher-faster,higher-slower,lower-faster,lower-slower,same, orinsufficientwhen there are too few jumps to compare.
Failures are described in error codes.
Sprint
Get a sprint insight
One athlete’s runs on one sprint exercise over a period, as the Labs sprint page computes them: the change between two windows, development over time, split times per segment, repeatability and patterns worth reviewing. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/sprint?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&targetTime=4.3" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/sprint?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&targetTime=4.3',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/sprint?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31&targetTime=4.3",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"granularity": "week",
"periods": {
"a": {
"role": "earlier",
"from": "2026-01-01T00:00:00.000Z",
"to": "2026-02-14T23:59:59.999Z"
},
"b": {
"role": "later",
"from": "2026-02-15T00:00:00.000Z",
"to": "2026-03-31T23:59:59.999Z"
}
},
"threshold": 2,
"conditions": [
{
"key": "run-in:0|laps:10,10,10|trigger:1|load:0",
"sessions": 9,
"observations": 41,
"lastAt": "2026-03-27T17:12:00.000Z",
"attributes": {
"runIn": 0,
"distances": "10+10+10",
"totalDistance": 30,
"trigger": 1,
"laps": 3,
"load": 0
}
}
],
"condition": "run-in:0|laps:10,10,10|trigger:1|load:0",
"annotations": [],
"targetTime": 4.3,
"course": {
"key": "run-in:0|laps:10,10,10|trigger:1|load:0",
"runIn": 0,
"distances": [
10,
10,
10
],
"totalDistance": 30,
"trigger": 1,
"load": 0,
"isFlying": false,
"segments": [
{
"index": 0,
"distance": 10,
"from": 0,
"to": 10
},
{
"index": 1,
"distance": 10,
"from": 10,
"to": 20
},
{
"index": 2,
"distance": 10,
"from": 20,
"to": 30
}
]
},
"summary": {
"best": {
"a": 4.38,
"b": 4.29,
"aSessions": 6,
"bSessions": 7,
"delta": -0.09,
"percent": -2.1,
"scale": "relative",
"direction": "improved",
"basis": "median-session-best"
},
"meanTotal": {
"a": 4.46,
"b": 4.37,
"aSessions": 6,
"bSessions": 7,
"delta": -0.09,
"percent": -2,
"scale": "relative",
"direction": "improved",
"basis": "mean-session-mean"
},
"contribution": [
{
"segment": 0,
"from": 0,
"to": 10,
"a": 1.84,
"b": 1.79,
"delta": -0.05,
"change": {
"a": 1.84,
"b": 1.79,
"aSessions": 6,
"bSessions": 7,
"delta": -0.05,
"percent": -2.7,
"scale": "relative",
"direction": "improved"
}
}
],
"segmentBests": [
{
"segment": 0,
"a": 1.79,
"b": 1.75
}
],
"totals": {
"a": {
"sessions": 4,
"runs": 18,
"distance": 540
},
"b": {
"sessions": 5,
"runs": 23,
"distance": 690
}
},
"targetShare": {
"a": 11.1,
"b": 30.4,
"aSessions": 6,
"bSessions": 7,
"delta": 19.3,
"percent": 173.9,
"scale": "points",
"direction": "improved",
"basis": "median-session-target-share"
}
},
"development": {
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-27T17:00:00.000Z",
"sides": [
"b"
],
"best": 4.27,
"typical": 4.33,
"mean": 4.35,
"sd": 0.05,
"cv": 1.2,
"gap": 1.4,
"decrement": 1.9,
"segments": [
1.78,
1.3,
1.27
],
"speed": null,
"runs": 5,
"distance": 150,
"targetShare": 40
}
],
"buckets": []
},
"segmentTimeline": [],
"repeatability": {
"rows": [],
"sequences": [],
"decrement": {
"a": 2.4,
"b": 1.9,
"aSessions": 6,
"bSessions": 7,
"delta": -0.5,
"percent": -20.8,
"scale": "points",
"direction": "improved",
"basis": "median-session-decrement"
}
},
"patterns": []
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. comparisonstring- What the period is compared against:
{ "mode": "halves" }(default) splits it into its earlier and later half;{ "mode": "periods", "a": { "from", "to" }, "b": { "from", "to" } }names two subperiods;{ "mode": "reference", "reference": { "from", "to" } }holds the whole period against another one, which may lie outside it. JSON, URL-encoded. thresholdnumber- Smallest change that counts, 0.5–50: percent of the earlier value, or percentage points for a measure that is itself a percentage. Smaller changes read as
similar. conditionstring- The course to read, as a
conditions[].keyof a previous response. Defaults to the most run one. targetTimenumber- A target time in seconds. Each run is checked against it (
targetShare).
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Times in s, distances in m, speed in m/s, loads in kg; spread, gap, decrement and target share in percent.
Response fields
dateRangedatetime[]- Start and end of the period read.
granularitystringsessionfor a short period, elseweekormonth: how the development is bucketed.periodsobject- The two periods compared:
ais the one compared against,bthe one being read. Each hasrole,fromandto. conditions[]object[]- Every measurement context the athlete recorded, with
key,sessions,observations,lastAtand itsattributes. Pass akeyasconditionto read another one. conditionstringnullable- The context read.
annotations[]object[]- Program phase changes in the period (
date,workoutId,phaseName,programName). summaryobject- Period-to-period changes. Each has
a,b,aSessions,bSessions,delta,percent,scale(relativeorpoints) anddirection:improved,declined,similar, orinsufficientwhen a period holds too few sessions to compare. patterns[]object[]- Patterns worth reviewing, as data:
kind,tone(worse,watch,better,neutral), when they held, the supportingworkoutIdsand theirvalues. No sentence is included. courseobjectnullable- The course read: run-in, gate distances, total distance, load, whether it is flying, and each segment placed from where the athlete set off.
nullwhen the athlete has no run. developmentobject- Per-session values (
sessions: best, typical and mean run, spread, meansegments) and calendar buckets, oldest first. segmentTimeline[]object[]- Mean split per segment, by bucket or session.
repeatabilityobject- Spread and decrement across a session’s runs, by bucket and per session.
sessions[]object[]- Each session with its runs and laps, newest first.
Failures are described in error codes.
Compare sprint runs
Up to 6 of one athlete’s runs side by side, lap by lap, over the stretch of the course they share. Reads every sprint exercise unless settings.exerciseIds narrows it. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/sprint/compare?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&serieIds=68c2e5b1-0d47-4a93-9f6e-b13a7d84c250%2C7b2e9d41-c5a8-4f13-9e60-d84a1f3b2c97" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/sprint/compare?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&serieIds=68c2e5b1-0d47-4a93-9f6e-b13a7d84c250%2C7b2e9d41-c5a8-4f13-9e60-d84a1f3b2c97',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/sprint/compare?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&serieIds=68c2e5b1-0d47-4a93-9f6e-b13a7d84c250%2C7b2e9d41-c5a8-4f13-9e60-d84a1f3b2c97",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"isEmpty": false,
"settings": {
"entry": "any",
"load": null,
"exerciseIds": []
},
"selected": {
"from": 0,
"to": 30,
"key": "0-30",
"entry": "standing",
"load": 0
},
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-27T17:00:00.000Z",
"name": "Speed",
"runs": [
{
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"index": 1,
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"exerciseName": "30 m Sprint",
"from": 0,
"to": 30,
"time": 4.27,
"total": 4.27,
"load": 0,
"laps": 3,
"isBest": true
}
]
}
],
"runs": [
{
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"index": 1,
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-27T17:00:00.000Z",
"name": "Speed",
"exerciseName": "30 m Sprint",
"load": 0,
"entry": "standing",
"from": 0,
"to": 30,
"total": 4.27,
"laps": [
{
"index": 0,
"from": 0,
"to": 10,
"time": 1.78,
"accTime": 1.78,
"velocity": 5.62
},
{
"index": 1,
"from": 10,
"to": 20,
"time": 1.26,
"accTime": 3.04,
"velocity": 7.94
}
]
}
],
"common": {
"from": 0,
"to": 30
},
"splits": [
{
"key": "0-10",
"from": 0,
"to": 10,
"times": [
1.78,
1.81
]
}
]
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. serieIdsstring- Comma-separated set ids of the runs to compare, at most 6, from
sessions[].runs[].serieId. Without it only the candidates are listed. settingsstring{ "entry", "load", "exerciseIds" }:entryisany(default),standingorflying;loada sled or vest load in kg (defaultnull: any);exerciseIdsthe sprint exercises to read (default every one). JSON, URL-encoded.segmentstring- The stretch of the course to read:
{ "from", "to", "load"? }, positions in metres from where the athlete set off,loadin kg. Defaults to the most run one. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
selectedobjectnullable- The stretch read:
from,to,entryandload. sessions[]object[]- Candidate runs per session that timed the stretch, with their
timeover it and whether each was the session’s best. runs[]object[]- The runs asked for in
serieIds, lap by lap: lap and accumulated time (s) and velocity (m/s). commonobjectnullable- The stretch every compared run covered, in metres.
splits[]object[]- Each split of the common stretch, with one time per compared run in
runsorder (nullwhen a run has no split there).
Failures are described in error codes.
Get repeated-sprint ability
How much one athlete’s runs drop off within a session over a stretch of the course, session by session, with one session broken down run by run. Reads every sprint exercise unless settings.exerciseIds narrows it. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/sprint/repeatability?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&segment=%7B%22from%22%3A0%2C%22to%22%3A30%7D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/sprint/repeatability?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&segment=%7B%22from%22%3A0%2C%22to%22%3A30%7D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/sprint/repeatability?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&segment=%7B%22from%22%3A0%2C%22to%22%3A30%7D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"isEmpty": false,
"settings": {
"entry": "any",
"load": null,
"exerciseIds": []
},
"selected": {
"from": 0,
"to": 30,
"key": "0-30",
"entry": "standing",
"load": 0
},
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-27T17:00:00.000Z",
"name": "Speed",
"runs": 5,
"best": 4.27,
"median": 4.33,
"cv": 1.2,
"gap": 0.014,
"decrement": 0.019,
"restMedian": 180
}
],
"session": {
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"runs": [
{
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"index": 1,
"time": 4.27,
"rest": null,
"isBest": true
},
{
"serieId": "7b2e9d41-c5a8-4f13-9e60-d84a1f3b2c97",
"index": 2,
"time": 4.31,
"rest": 178,
"isBest": false
}
]
}
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "entry", "load", "exerciseIds" }:entryisany(default),standingorflying;loada sled or vest load in kg (defaultnull: any);exerciseIdsthe sprint exercises to read (default every one). JSON, URL-encoded.segmentstring- The stretch of the course to read:
{ "from", "to", "load"? }, positions in metres from where the athlete set off,loadin kg. Defaults to the most run one. JSON, URL-encoded. workoutIduuid- A session to break down run by run (
session). Defaults to the latest one.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
sessions[]object[]- Per session: runs, best and median time (s),
cv(percent),gap(typical run behind the best) anddecrement(average run behind the best, from three runs), both as fractions, and the median rest (s). sessionobjectnullable- One session run by run, with the rest before each.
Failures are described in error codes.
Get sprint split times
One athlete’s split times per stretch of the course: every stretch they ran with its best, median and last time, and one stretch followed session by session. Reads every sprint exercise unless settings.exerciseIds narrows it. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/sprint/segments?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&settings=%7B%22entry%22%3A%22standing%22%2C%22stat%22%3A%22best%22%7D" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/sprint/segments?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&settings=%7B%22entry%22%3A%22standing%22%2C%22stat%22%3A%22best%22%7D',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/sprint/segments?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&from=2026-01-01&to=2026-03-31&settings=%7B%22entry%22%3A%22standing%22%2C%22stat%22%3A%22best%22%7D",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"isEmpty": false,
"settings": {
"entry": "standing",
"load": null,
"exerciseIds": [],
"stat": "best"
},
"exercises": [
{
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"name": "30 m Sprint",
"runs": 41
}
],
"segments": [
{
"key": "0-10",
"from": 0,
"to": 10,
"entry": "standing",
"load": 0,
"runs": 41,
"sessions": 9,
"best": 1.75,
"median": 1.81,
"last": 1.78,
"lastDate": "2026-03-27T17:00:00.000Z",
"bestDate": "2026-03-20T17:00:00.000Z",
"bestWorkoutId": "93f6a0c2-4d1b-4e87-b5c9-1e7a3d60f8b4",
"exerciseIds": [
"1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7"
],
"loads": [
0
]
}
],
"selected": {
"from": 0,
"to": 10,
"key": "0-10",
"entry": "standing",
"load": 0
},
"timeline": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-27T17:00:00.000Z",
"name": "Speed",
"runs": 5,
"best": 1.78,
"median": 1.8,
"min": 1.78,
"max": 1.84,
"loads": [
0
],
"serieIds": [
"68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"7b2e9d41-c5a8-4f13-9e60-d84a1f3b2c97"
]
}
]
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "entry", "load", "exerciseIds" }:entryisany(default),standingorflying;loada sled or vest load in kg (defaultnull: any);exerciseIdsthe sprint exercises to read (default every one).statis the session value on the timeline:best(default) ormedian. JSON, URL-encoded.segmentstring- The stretch of the course to read:
{ "from", "to", "load"? }, positions in metres from where the athlete set off,loadin kg. Defaults to the most run one. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
exercises[]object[]- Sprint exercises with runs in the period.
segments[]object[]- Every stretch run: position (m), entry, load (kg), runs and sessions, best, median and last time (s), and when the best was set.
selectedobjectnullable- The stretch followed on
timeline. timeline[]object[]- The selected stretch per session, oldest first.
Failures are described in error codes.
Reaction
Get reaction development
One athlete’s response time, accuracy and hit rate over time on one reaction exercise, for one game configuration. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/reaction/development?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/reaction/development?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/reaction/development?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"isEmpty": false,
"settings": {
"configuration": "go-no-go|30"
},
"exercise": {
"name": "Go/No-Go"
},
"configurations": [
{
"key": "go-no-go|30",
"game": "go-no-go",
"duration": 30,
"isScored": true,
"sessions": 8,
"games": 24,
"lastAt": "2026-03-26T10:05:00.000Z"
}
],
"isScored": true,
"timeline": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-26T10:00:00.000Z",
"name": "Reaction",
"games": 3,
"hits": 52,
"errors": 4,
"time": 0.412,
"accuracy": 92.9,
"rate": 34.7,
"ranges": {
"time": {
"min": 0.398,
"max": 0.431
},
"accuracy": {
"min": 88.9,
"max": 96.3
},
"rate": {
"min": 32,
"max": 36
}
}
}
],
"sessions": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-26T10:00:00.000Z",
"name": "Reaction",
"games": [
{
"serieId": "68c2e5b1-0d47-4a93-9f6e-b13a7d84c250",
"duration": 30,
"events": 19,
"hits": 18,
"errors": 1,
"inhibitions": 3,
"time": 0.398,
"fastest": 0.331,
"accuracy": 96.3,
"rate": 36,
"index": 1
}
]
}
]
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "configuration" }: the game configuration to read, as aconfigurations[].keyof a previous response. Defaults to the most played one. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
- Times and durations in s, accuracy in percent, rate in hits per minute.
Response fields
configurations[]object[]- Every game configuration played (game and duration), with sessions, games and when last played. Pass a
keyinsettings.configuration. isScoredboolean- Whether the game scores its events (Go/No-Go, Choice), so it has an accuracy.
timeline[]object[]- One point per session, oldest first: every game pooled, with the range from its best to its worst game.
sessions[]object[]- Sessions newest first, game by game.
Failures are described in error codes.
Get reaction speed and accuracy
Whether one athlete gets faster at the cost of mistakes: one point per session, response time against accuracy, the first and last third of their sessions compared. Only games that score their events have an accuracy. Not paginated.
Request
curl "https://api-next.vitruve.fit/v1/labs/reaction/speed-accuracy?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch(
'https://api-next.vitruve.fit/v1/labs/reaction/speed-accuracy?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31',
{ headers: { 'X-API-Key': process.env.VITRUVE_API_KEY } }
)
const body = await response.json()
if (!response.ok) throw new Error(`${response.status}: ${body.message}`)
console.log(body.data)import os
import requests
response = requests.get(
"https://api-next.vitruve.fit/v1/labs/reaction/speed-accuracy?userId=3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62&exerciseId=1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7&from=2026-01-01&to=2026-03-31",
headers={"X-API-Key": os.environ["VITRUVE_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Response 200
{
"ok": true,
"timestamp": 1738247125207,
"data": {
"userId": "3b9c1e24-6f7a-4d2b-8c15-a40e9d7f1b62",
"exerciseId": "1c7a5e93-f804-4b26-a9d1-3e6b0d82c4f7",
"dateRange": [
"2026-01-01T00:00:00.000Z",
"2026-03-31T23:59:59.999Z"
],
"isEmpty": false,
"settings": {
"configuration": "go-no-go|30"
},
"exercise": {
"name": "Go/No-Go"
},
"configurations": [
{
"key": "go-no-go|30",
"game": "go-no-go",
"duration": 30,
"isScored": true,
"sessions": 8,
"games": 24,
"lastAt": "2026-03-26T10:05:00.000Z"
}
],
"isScored": true,
"points": [
{
"workoutId": "f2c8e1a6-3d49-4b75-8e02-6a9d4c1b7f35",
"date": "2026-03-26T10:00:00.000Z",
"name": "Reaction",
"games": 3,
"time": 0.412,
"accuracy": 92.9,
"phase": "late"
}
],
"early": {
"sessions": 3,
"time": 0.447,
"accuracy": 89.5
},
"late": {
"sessions": 3,
"time": 0.415,
"accuracy": 92.1
},
"classification": "faster-more-accurate"
}
}Query parameters
userIduuidrequired- Athlete to analyse. An athlete outside your organization, or one a coach can’t see, answers
404. exerciseIduuidrequired- Exercise to analyse, from
GET /exercises. fromdaterequired- Inclusive lower bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date starts at 00:00 intimezone, or at the change on a day whose midnight a daylight-saving change skips. todaterequired- Inclusive upper bound:
YYYY-MM-DDor an ISO 8601 datetime. A bare date covers that whole day intimezone. timezonestringdefaultUTC- IANA time zone, such as
Europe/Madrid. A barefrom/todate covers that whole day in it, and a datetime without an offset is a wall-clock time in it. Datetimes withZor an offset are taken as given. It also sets where days, weeks and months start. settingsstring{ "configuration" }: the game configuration to read, as aconfigurations[].keyof a previous response. Defaults to the most played one. JSON, URL-encoded.
Notes
- Needs the Labs add-on: without it the endpoint answers
403, like a role that can’t read the analysis. - An option that is malformed or doesn’t apply answers
400, andmessagenames it. An athlete outside your organization, or one a coach can’t see, answers404. - Values are in each metric’s stored unit, never converted to display units.
Response fields
points[]object[]- One point per session: response time (s), accuracy (percent) and the third of the sessions it falls in (
early,middle,late). earlyobjectnullable- The first third of the sessions pooled.
lateobjectnullable- The last third of the sessions pooled.
classificationstringfaster-more-accurate,faster-less-accurate,slower-more-accurate,slower-less-accurate,same, orinsufficient.
Failures are described in error codes.
Trends, rankings and values
Metric trends and athlete rankings (Labs), and raw metric values, from the engine behind Vitruve Labs.
Catalogs
Exercises, muscles, metrics, prescription types and units: the reference data that ids in other resources point to. Your organization's own exercises can also be created, updated and deleted.