Measurements

Any of the athlete's measurement series, over a range

Several series in one request, each in its own shape: daily values (resting HR, HRV, sleep, energy, weight and the fitness markers), step counts, and blood pressure readings by sitting. Up to 732 days, inclusive. Each requested series is an array (empty when there's nothing in range); every other series is null.

get/measurements

Request

  • Base URL: https://bodylab.lol/api/v1
  • URL: https://bodylab.lol/api/v1/measurements
  • Auth: HTTP bearer

Query parameters

typesstring required

Comma-separated series to return, e.g. "bloodPressure,weightKg". Known: restingHrBpm, hrvMs, sleepScore, sleepMinutes, energyScore, steps, weightKg, vo2maxMlKgMin, vo2maxCyclingMlKgMin, ftpW, lthrBpm, lthrCyclingBpm, thresholdSpeedMs, bloodPressure, feelScore. A name this server doesn't know comes back in unknownTypes instead of failing the request; repeats are ignored.

fromstring date

First day, inclusive. Defaults to 89 days before to.

tostring date

Last day, inclusive. Defaults to today; a later day is treated as today.

Headers

X-Client-Platformstring

The native client's platform, e.g. ios. Server-side and non-native callers omit it.

X-Client-Versionstring

The native client's own semver version. With X-Client-Platform, a version below that platform's minimum is refused with CLIENT_UPGRADE_REQUIRED (426).

Response

OK

todaystring date required

Today on the athlete's calendar, in their time zone.

fromstring date required

The first day covered, as resolved.

tostring date required

The last day covered, as resolved (a to after today comes back as today).

unknownTypesstring[] required

Requested names this server doesn't know, so a client can tell a typo from an empty series.

Changes

No recorded changes to this operation across all 1 revision of this API.