Skip to content
Sesharo Docs

Metrics Series

GET
/users/{user_id}/health/metrics/series
curl --request GET \
  --url 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/health/metrics/series?metrics=example&buckets=240'

Multi-metric, server-side-bucketed series for the metrics viewer.

Each requested metric is aggregated into buckets fixed-width time buckets over [start, end), returning avg/min/max/count per bucket — keeps payloads small and the chart honest over long ranges. Buckets are aligned to start. Empty buckets are omitted.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
user_id
required
User Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
metrics
required
Metrics

Comma-separated metric type slugs

string

Comma-separated metric type slugs

start
Any of:
string format: date-time
end
Any of:
string format: date-time
buckets
Buckets
integer
default: 240 >= 1 <= 1000

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MetricSeriesResponse

Multi-metric, server-side-bucketed series for the metrics viewer.

object
bucket_seconds
required
Bucket Seconds
number
end
required
End
string format: date-time
series
required
Series
Array<object>
MetricSeries
object
category
required
Category
string
display_name
required
Display Name
string
metric_type_slug
required
Metric Type Slug
string
points
required
Points
Array<object>
MetricSeriesPoint

One time bucket of a metric series.

object
avg
required
Avg
number
count
required
Count
integer
max
required
Max
number
min
required
Min
number
t
required
T
string format: date-time
unit
required
Unit
string
start
required
Start
string format: date-time
Examplegenerated
{
  "bucket_seconds": 1,
  "end": "2026-04-15T12:00:00Z",
  "series": [
    {
      "category": "example",
      "display_name": "example",
      "metric_type_slug": "example",
      "points": [
        {
          "avg": 1,
          "count": 1,
          "max": 1,
          "min": 1,
          "t": "2026-04-15T12:00:00Z"
        }
      ],
      "unit": "example"
    }
  ],
  "start": "2026-04-15T12:00:00Z"
}

422

Section titled “422”

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"
    }
  ]
}