Documentation

Keely for developers

Series

One metric over a range, one point per date, up to a year at a time.

Updated

On this page
  1. GET /v1/series/{metric}

GET /v1/series/{metric}

Scope
nights or days, by metric
Path
metric, one of the table’s
Query
from, to (YYYY-MM-DD), at most 366 days; the last 30 by default

One metric over a range, one point per date, null for dates without data, with stats over the dates that have one. The scope depends on the metric:

MetricUnitScope
recovery%nights
hrvmsnights
resting_hrbpmnights
breathing_ratebreaths/minnights
skin_temp_deviation°C from normalnights
asleepminutesnights
sleep_needminutesnights
sleep_performance% of neednights
consistencySleep Regularity Indexnights
deep_sleepminutesnights
rem_sleepminutesnights
loadLoaddays
balance7-day ÷ 28-day Loaddays
stepsstepsdays
stress_dayscore 0–100days
stress_nightscore 0–100days
Response
{
  "metric": "hrv",
  "unit": "ms",
  "from": "2026-09-25",
  "to": "2026-09-27",
  "points": [
    { "date": "2026-09-25", "value": null },
    { "date": "2026-09-26", "value": 58.4 },
    { "date": "2026-09-27", "value": 70.2 }
  ],
  "stats": { "days_with_data": 2, "mean": 64.3, "min": 58.4, "max": 70.2 },
  "as_of": "2026-09-27T15:20:00Z",
  "methodology": "https://meetkeely.com/methodology"
}