Get account health

GET

/api/accounts/{accountId}/quality

• Production

Retrieve the rolling quality health summary for an account. Account health is computed from the recent conversations associated with all contacts in the account.

Authorizations

• bearerAuth

Parameters

Path Parameters

accountId

required

string format: uuid

The unique identifier of the account.

Responses

200

The account health summary.

Rolling quality health summary for an account, computed from recent conversations.

object

accountId

required

The account this health summary belongs to.

string format: uuid

Example

acc_12345678-abcd-ef01-2345-678901234567

rollingComposite

required

Rolling average composite score across recent conversations.

number

Example

3.85

rollingOutcome

required

Rolling average outcome dimension score.

number

Example

3.92

rollingProcess

required

Rolling average process dimension score.

number

Example

3.78

rollingEnvironment

required

Rolling average environment dimension score.

number

Example

3.85

resolutionRate

required

Fraction of conversations that reached a resolution.

number

Example

0.88

conversationCount

required

Total conversations included in the rolling window.

integer

Example

42

churnRisk

required

Computed risk level based on quality trends.

string

Allowed values: low medium high critical

Example

medium

consecutiveLow

required

Number of consecutive conversations scoring below the low-composite threshold.

integer

Example

2

trend

required

Direction of recent scores.

string

Allowed values: improving stable declining

Example

declining

404

No account exists with the given ID or no health data is available.

Standard error response returned by all endpoints on failure.

object

error

required

A human-readable error message describing what went wrong.

string

Example

Conversation not found