Skip to content

List customer health scores

GET/customer360/health-scores

Returns a paginated list of customer profiles with their computed health scores, identity counts, and timeline event counts. Use this to identify at-risk customers (band = 'at_risk' or 'churned') and prioritise customer success outreach.

Request

Query parameters

NameTypeRequiredDescription
pageintegerNo

Default: 1

Responses

200 Paginated profiles with health score data

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · CustomerHealthScoreV1No
data[].profile_idintegerNo

ID of the associated customer profile.

Example: 42

data[].scorenumberNo

Numeric health score from 0 (worst) to 100 (best).

Example: 82.0

data[].bandstringNo

Human-readable health band derived from the score. Typical bands: 'healthy' (70–100), 'at_risk' (40–69), 'churned' (0–39).

Example: "healthy"

data[].statusstringNo

Machine-readable health status.

One of: "healthy", "at_risk", "churned", "unknown" · Example: "healthy"

data[].factorsarray of objectNo

Scoring factor breakdown showing what drove the final score.

data[].factors[].factorstringNo

Name of the scoring dimension.

data[].factors[].weightnumberNo

Relative weight of this factor in the overall score.

data[].factors[].valuenumberNo

Computed sub-score for this factor.

data[].calculated_atstring (date-time), nullableNo

Timestamp of the most recent score calculation.

Example

{
  "data": [
    {
      "profile_id": 42,
      "score": 82.0,
      "band": "healthy",
      "status": "healthy",
      "factors": [
        {
          "factor": "recent_activity",
          "weight": 0.3,
          "value": 9.2
        },
        {
          "factor": "support_ticket_volume",
          "weight": 0.2,
          "value": 7.5
        }
      ],
      "calculated_at": "2026-04-07T09:00:00Z"
    }
  ]
}

401 Unauthenticated

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/customer360/health-scores" \
  -H "Accept: application/json"
Loading