Read one complexity tier

GET

/complexity-tiers

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

• API v1

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

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

Parameters

Query Parameters

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

Responses

200

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:

string

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

400

Invalid query parameter

Media typeapplication/json

object

error

required

string

code

Optional machine-readable error code, for example sync_in_progress or preview_stale

string

Example^generated

{
  "error": "example",
  "code": "example"
}

401

Authentication required

Media typeapplication/json

object

error

required

string

code

Optional machine-readable error code, for example sync_in_progress or preview_stale

string

Example^generated

{
  "error": "example",
  "code": "example"
}

404

Complexity tier not found for strict read

Media typeapplication/json

object

error

required

string

code

Optional machine-readable error code, for example sync_in_progress or preview_stale

string

Example^generated

{
  "error": "example",
  "code": "example"
}

500

Failed to read complexity tier

Media typeapplication/json

object

error

required

string

code

Optional machine-readable error code, for example sync_in_progress or preview_stale

string

Example^generated

{
  "error": "example",
  "code": "example"
}