Skip to content

Rest API

Get AI maturity

GET
/api/v1/insights/ai-maturity

The account’s AI maturity assessment: an overall score, a per-stage and per-level summary, the full stage-by-level matrix with the individual features behind each cell, and the certificates earned.

Notes

  • Every feature carries implemented, measurable, measurement and skipped, so an agent can tell a genuine gap from something that cannot be measured
  • deeplink on a feature points at the dashboard page where it is configured
  • A cell’s blockingPrerequisite explains a score of zero that is caused by a missing deployment rather than missing work
  • Read-only. Skipping a maturity task and granting a certificate are dashboard-only
x-api-key
required
string

Your API key from account settings.

x-user-email
required
string

The email address of your user.

x-account-id
required
string

The ID of your account. You can find this in the account settings.

x-website-id
required
string

The ID of the workspace you want to use.

The maturity assessment.

The account’s AI maturity assessment.

object
status
string
lastUpdate
number
totalScore
number
nullable
measurableLevelsCount
number
measurableFeaturesCount
number
totalFeaturesCount
number
levelDistribution
Array<object>
object
levelId
string
levelLabel
string
percentage
number
score
number
nullable
stages

One summary per lifecycle stage.

Array<object>
object
id
string
Allowed values: acquisition retention sales-expansion customer-support
label
string
score
number
nullable
maturityLevelId
string
nullable
maturityLevelLabel
string
nullable
description
string
levels

One summary per maturity level.

Array<object>
object
id
string
Allowed values: experimental assisted automated agentic ai-first
label
string
score
number
nullable
achievedStagesCount
number
totalStages
number
description
string
matrix

One cell per stage and level combination.

Array<object>
object
levelId
string
levelLabel
string
stageId
string
stageLabel
string
score
number
nullable
completedFeatures
number
totalFeatures
number
measurableFeatures
number
certificateAchieved
boolean
features
Array<object>

One maturity feature evaluated for a stage and level.

object
key

Stable identifier for the feature.

string
label
string
description
string
implemented
boolean
measurable
boolean
measurement

How reliably the feature can be measured.

string
Allowed values: direct approximate not-supported
deeplink

Dashboard page where the feature is configured.

string
skipped
boolean
perStage

Whether skipping or completing the feature counts per stage rather than globally.

boolean
autoDerived

System-derived gating task, excluded from the inbox and not skippable.

boolean
blockingPrerequisite

Set when the cell score is zeroed by a missing prerequisite deployment.

object
label
string
deeplink
string
certificates
Array<object>
object
id

Stable identifier for the certificate.

string
levelId
string
levelLabel
string
stageId
string
stageLabel
string
achieved
boolean
eligible
boolean
granted
boolean
grantedAt
string
nullable
score
number
nullable
completedFeatures
number
totalFeatures
number
measurableFeatures
number
features
Array<object>

One maturity feature evaluated for a stage and level.

object
key

Stable identifier for the feature.

string
label
string
description
string
implemented
boolean
measurable
boolean
measurement

How reliably the feature can be measured.

string
Allowed values: direct approximate not-supported
deeplink

Dashboard page where the feature is configured.

string
skipped
boolean
perStage

Whether skipping or completing the feature counts per stage rather than globally.

boolean
autoDerived

System-derived gating task, excluded from the inbox and not skippable.

boolean

Unauthorized - invalid API key.