Skip to content

Get a single customer-health by id

GET
/customer-healths/{id}
id
required
string

DocumentId

OK

object
data
object
organisation
One of:

DocumentId reference to api::organisation.organisation

string
health_score
number
usage_score
number
growth_score
number
feature_score
number
support_score
number
churn_risk
string
Allowed values: low medium high critical
churn_signals

Arbitrary JSON value (object, array, string, number, boolean, or null)

last_login_at
string format: date-time
days_since_login
integer
active_instances
integer
open_tickets
integer
nps_score
integer
last_evaluated_at
string format: date-time
csm_notes
string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found