Skip to content

List Metrics

GET
/users/{user_id}/health/metrics
curl --request GET \
--url 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/health/metrics?limit=100&offset=0'
user_id
required
User Id
string format: uuid
metric_type
Any of:
string

Filter by metric type slug

source
Any of:
string
recorded_after
Any of:
string format: date-time
recorded_before
Any of:
string format: date-time
limit
Limit
integer
default: 100 >= 1 <= 1000
offset
Offset
integer
0

Successful Response

Media typeapplication/json
Response List Metrics Users User Id Health Metrics Get
Array<object>
HealthMetricRead
object
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
metadata
required
Metadata
object
key
additional properties
any
metric_type_id
required
Metric Type Id
integer
metric_type_slug
required
Metric Type Slug
string
reading_group_id
required
Any of:
string format: uuid
recorded_at
required
Recorded At
string format: date-time
source
required
Source
string
source_id
required
Any of:
string
unit
required
Unit
string
updated_at
required
Updated At
string format: date-time
user_id
required
User Id
string format: uuid
value
required
Value
number
Examplegenerated
[
{
"created_at": "2026-04-15T12:00:00Z",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"metadata": {},
"metric_type_id": 1,
"metric_type_slug": "example",
"reading_group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"recorded_at": "2026-04-15T12:00:00Z",
"source": "example",
"source_id": "example",
"unit": "example",
"updated_at": "2026-04-15T12:00:00Z",
"user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"value": 1
}
]

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}