Skip to content

Get Volatility Insights

GET
/users/{user_id}/insights/volatility
curl --request GET \
--url 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/insights/volatility?window_days=90'

Volatility / regime-shift insights (Track D): a metric whose recent dispersion departed from its personal baseline — e.g. “your sleep has become ~2.9× more erratic than usual.” Catches the blind spot where the mean barely moves but the day-to-day swings explode. Deterministic, query-time, robust (MAD) spread vs personal history; no LLM.

user_id
required
User Id
string format: uuid
window_days
Window Days
integer
default: 90 >= 14 <= 365

Successful Response

Media typeapplication/json
VolatilityResponse
object
volatility
required
Volatility
Array<object>
VolatilityCard

A volatility / regime-shift insight — a metric whose recent dispersion departed from its personal baseline dispersion (Track D). See services/volatility.py.

object
baseline_days
required
Baseline Days
integer
baseline_high
required
Baseline High
number
baseline_low
required
Baseline Low
number
baseline_spread
required
Baseline Spread
number
direction
required
Direction
string
headline
required
Headline
string
id
required
Id
string
key
required
Key
string
kind
required
Kind
string
label
required
Label
string
ratio
required
Ratio
number
recent_days
required
Recent Days
integer
recent_high
required
Recent High
number
recent_low
required
Recent Low
number
recent_spread
required
Recent Spread
number
unit
required
Unit
string
valence
required
Valence
string
window_days
required
Window Days
integer
Examplegenerated
{
"volatility": [
{
"baseline_days": 1,
"baseline_high": 1,
"baseline_low": 1,
"baseline_spread": 1,
"direction": "example",
"headline": "example",
"id": "example",
"key": "example",
"kind": "example",
"label": "example",
"ratio": 1,
"recent_days": 1,
"recent_high": 1,
"recent_low": 1,
"recent_spread": 1,
"unit": "example",
"valence": "example"
}
],
"window_days": 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"
}
]
}