Skip to main content
Instrument Health

Authorizations

Authorization
string
header
required

Named syn_ API key or migration-only legacy key.

Path Parameters

organization_id
string<uuid>
required
app_id
string<uuid>
required
environment_id
string<uuid>
required

Query Parameters

starts_at
string<date-time>
required
ends_at
string<date-time>
required

Response

Successful Response

completion_rate
number
required
Required range: 0 <= x <= 1
ends_at
string<date-time>
required
environment_id
string<uuid>
required
privacy_floor_applied
boolean
required
sessions_abandoned
integer
required
Required range: x >= 0
sessions_active
integer
required
Required range: x >= 0
sessions_completed
integer
required
Required range: x >= 0
sessions_started
integer
required
Required range: x >= 0
starts_at
string<date-time>
required
status
enum<string>
required
Available options:
healthy,
attention_required,
insufficient_data
median_active_ms
number | null
Required range: x >= 0
median_questions
number | null
Required range: x >= 0
question_health
QuestionHealth · object[]
reasons
string[]