Skip to main content
GET
/
metrics
Get all metrics
curl --request GET \
  --url https://backend.claros.health/metrics/
{
  "metrics": [
    {
      "id": 123,
      "name": "<string>",
      "calculation_formula": [
        "<string>"
      ],
      "patient_values_count": 123,
      "description": "<string>",
      "unit": "<string>",
      "filter_variable_id": 123,
      "low_quality_threshold": 123,
      "high_quality_threshold": 123,
      "is_ascending": true
    }
  ]
}
This endpoint requires authentication. Include your API key in the request headers as X-API-Key.
This endpoint retrieves a list of all metrics in the system.

​
Response Fields

​
metrics
array
required
Array of metric objects
​
metrics[].id
integer
required
Unique identifier of the metric
​
metrics[].name
string
required
Name of the metric
​
metrics[].description
string
Description of what the metric measures
​
metrics[].unit
string
Unit of measurement for the metric
​
metrics[].patient_values_count
integer
required
Number of patients with values for this metric

​
Example Response

{
  "metrics": [
    {
      "id": 1,
      "name": "BMI",
      "description": "Body Mass Index",
      "unit": "kg/m²",
      "patient_values_count": 150
    },
    {
      "id": 2,
      "name": "Blood Pressure",
      "description": "Systolic and Diastolic Blood Pressure",
      "unit": "mmHg",
      "patient_values_count": 200
    }
  ]
}

​
Error Responses

​
401
object
Authentication failed. Invalid or missing API key.

Response

Successful response

​
metrics
object[]