Skip to content
Sesharo Docs

Get Summary Card

GET
/users/{user_id}/summary-card
curl --request GET \
  --url https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/summary-card

The user’s “Today so far” card config — chosen metrics (ordered) + available candidates, each with its personal normal range. Seeds the default six on first read. RLS-scoped.

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SummaryCardConfigRead

The card configuration: the ordered chosen metrics + the remaining candidates.

object
available
required
Available
Array<object>
SummaryMetricRead

One metric as the “Today so far” card needs it — everything but the live value, which the frontend already has from the /today fetch (read from value_field, or metrics[slug] when that’s null).

object
baseline_ready
required
Baseline Ready
boolean
high
required
Any of:
number
label
required
Label
string
learned_high
required
Any of:
number
learned_low
required
Any of:
number
low
required
Any of:
number
manual_high
required
Any of:
number
manual_low
required
Any of:
number
mode
required
Mode
string
position
required
Any of:
integer
promote
required
Promote
boolean
sample_days
required
Sample Days
integer
slug
required
Slug
string
source
required
Source
string
unit
required
Unit
string
value_field
required
Any of:
string
max_metrics
Max Metrics
integer
default: 6
metrics
required
Metrics
Array<object>
SummaryMetricRead

One metric as the “Today so far” card needs it — everything but the live value, which the frontend already has from the /today fetch (read from value_field, or metrics[slug] when that’s null).

object
baseline_ready
required
Baseline Ready
boolean
high
required
Any of:
number
label
required
Label
string
learned_high
required
Any of:
number
learned_low
required
Any of:
number
low
required
Any of:
number
manual_high
required
Any of:
number
manual_low
required
Any of:
number
mode
required
Mode
string
position
required
Any of:
integer
promote
required
Promote
boolean
sample_days
required
Sample Days
integer
slug
required
Slug
string
source
required
Source
string
unit
required
Unit
string
value_field
required
Any of:
string
Example
{
  "max_metrics": 6
}

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