.do
ApiSupport

HealthScore

Customer health score tracking with metrics, trends, and risk indicators.

HealthScore

Customer health score tracking with metrics, trends, and risk indicators.

Properties

  • id (string): Unique identifier for the health score.
  • customer ([[Customer]]): Customer being scored.
  • score (number): Overall health score (0-100).
  • grade (string): Health grade (A, B, C, D, F or green, yellow, red).
  • status (string): Health status (healthy, at-risk, critical, churned).
  • trend (string): Score trend (improving, stable, declining).
  • metrics (object): Individual metric scores and weights.
  • engagementScore (number): Product engagement score (0-100).
  • adoptionScore (number): Feature adoption score (0-100).
  • satisfactionScore (number): Customer satisfaction score (0-100).
  • supportScore (number): Support interaction score (0-100).
  • usageScore (number): Product usage score (0-100).
  • valueScore (number): Realized value score (0-100).
  • churnRisk (number): Probability of churn as percentage (0-100).
  • expansionOpportunity (number): Probability of expansion as percentage (0-100).
  • lastActive (number): Timestamp of last customer activity (Unix timestamp).
  • daysSinceActive (number): Days since last activity.
  • alerts ([[HealthAlert]][]): Active health alerts or warnings.
  • calculated (number): Timestamp when score was calculated (Unix timestamp).
  • previousScore (number): Previous health score for comparison.
  • metadata (object): Set of key-value pairs for storing additional information.

Actions

calculate

Calculate health score for a customer.

Input: [[Customer]]
Output: [[HealthScore]]

update

Update health score manually.

Input: [[HealthScore]]
Output: [[HealthScore]]

recalculate

Recalculate health score with latest data.

Input: [[Customer]]
Output: [[HealthScore]]

setThresholds

Configure health score thresholds.

Input: [[HealthThresholds]]
Output: [[HealthScore]]

setWeights

Set weights for individual metrics.

Input: [[MetricWeights]]
Output: [[HealthScore]]

createAlert

Create a health alert for at-risk customer.

Input: [[HealthAlert]]
Output: [[HealthScore]]

resolveAlert

Resolve a health alert.

Input: [[HealthAlert]]
Output: [[HealthScore]]

analyze

Analyze factors affecting health score.

Input: [[Customer]]
Output: [[HealthAnalysis]]

predict

Predict future health score and churn risk.

Input: [[Customer]]
Output: [[HealthPrediction]]

compareSegment

Compare health scores across customer segment.

Input: [[Segment]]
Output: [[HealthComparison]]

generateReport

Generate health score report for period.

Input: [[DateRange]]
Output: [[HealthReport]]

exportScores

Export health scores for analysis.

Input: [[DateRange]]
Output: [[HealthExport]]

Events

  • calculated: Triggered when health score is calculated.
  • updated: Triggered when health score is modified.
  • Alert.created: Triggered when a health alert is created.
  • Alert.resolved: Triggered when a health alert is resolved.
  • Grade.changed: Triggered when health grade changes.
  • Risk.increased: Triggered when churn risk increases significantly.
  • Score.declined: Triggered when health score decreases.
  • Score.improved: Triggered when health score increases.
  • Status.changed: Triggered when health status changes.
  • Threshold.breached: Triggered when score breaches threshold.