---
title: "Get a health metric series."
method: GET
path: "/v1/health/metric"
---

# Get a health metric series.

`GET /v1/health/metric`

## Request

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

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.

## Query parameters

- `key` string, required
- `from` string, date
- `to` string, date

## Response `200`

Successful response.

- object
  - `key` string, required
  - `unit` string, nullable, required
  - `points` object[], required
    - `date` string, required
    - `value` number, required
    - `nodeId` string, required
    - `source` 'measurement' | 'exam', required

## Other responses

- `default`: Request failed.

---

[API](https://skmtc.dev/cortexplus/apis/cortexplus-rest-api.md) · [All operations](https://skmtc.dev/cortexplus/apis/cortexplus-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cortexplus/apis/cortexplus-rest-api/revisions/2d04f1593663?raw)