Get a health metric series.

Health data is only returned to API keys/agents when the user enabled settings.healthAgentAccess; otherwise the response is { "error": "health data is not shared with agents" }. Get a body metric or lab result series.

get/v1/health/metric

Request

  • Base URL: https://api.cortexplus.io
  • URL: https://api.cortexplus.io/v1/health/metric
  • Auth: HTTP bearer

Query parameters

keystring required

Body metric key (weightKg, heightCm, bmi, bodyFatPct, muscleMassKg, visceralFat, bodyWaterPct, boneMassKg, basalMetabolismKcal, metabolicAge) or lab:<resultKey>, e.g. lab:glicose.

fromstring date

First date in the metric series.

tostring date

Last date in the metric series.

Response

Successful response.

keystring required
unitstring nullable required

Changes

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