Skip to content

Read one complexity tier

GET
/complexity-tiers
curl --request GET \
--url 'https://example.com/api/v1/complexity-tiers?section_key=example&strict=false'

Returns the preferred complexity tier and progression counters for a section key.

Missing persisted values are returned as default beginner unless strict is enabled.

section_key
required

Canonical progressive disclosure section key

string
<= 96 characters /^[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+$/

Canonical section key for progressive complexity state

strict
boolean

When true, missing rows return 404 instead of default response

Complexity tier record

Media typeapplication/json
object
section_key
required

Canonical progressive disclosure section key

string
<= 96 characters /^[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+$/
tier
required

Progressive complexity tier for the section

string
Allowed values: beginner intermediate advanced
interaction_count
required
integer
advanced_toggle_count
required
integer
last_suggested_tier
required
Any of:

Progressive complexity tier for the section

string
Allowed values: beginner intermediate advanced
suggestion_dismissed_at
required
string format: date-time
nullable
updated_at
required
string format: date-time
nullable
persisted
required
boolean
Example
{
"tier": "beginner",
"last_suggested_tier": "beginner"
}

Invalid query parameter

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}

Authentication required

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}

Complexity tier not found for strict read

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}

Failed to read complexity tier

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}