Documentation

Keely for developers

Explain

How Keely computes each number, in words and as a formula, to show beside the number itself.

Updated

On this page
  1. GET /v1/explain
  2. GET /v1/explain/{topic}

GET /v1/explain

Scope
none

The topics Keely explains: recovery, hrv, resting_hr, baselines, sleep, load, zones, balance, stress and workouts.

GET /v1/explain/{topic}

Scope
none
Path
topic, one of the list’s
Errors
404 not_found for an unknown topic

How Keely computes a number, in words and as a formula, with the page that explains it. Show these where you show the numbers, so every number stays explainable.

Response
{
  "topic": "load",
  "title": "Load",
  "summary": "Training effort, counted every minute by heart-rate zone and summed since local midnight. …",
  "formula": "HRR = (HR − resting HR) ÷ (max HR − resting HR);  points per minute = clamp(10 × (HRR − 0.45), 0, 5.5);  target = chronic × (0.2 + 0.014 × Recovery) ± 15 %",
  "page": "https://meetkeely.com/load",
  "methodology": "https://meetkeely.com/methodology"
}