Domains / Customer Management/ API Endpoint

Customer Health API

REST API exposing customer health scores, risk indicators, and engagement metrics per tenant.

API Endpoint Application active

Customer Health API provides real-time access to computed health scores and risk signals for each tenant. It powers dashboards, alerts, and automated workflows that respond to changes in customer health.

Endpoints

  • GET /api/v1/health/scores — List health scores for all tenants
  • GET /api/v1/health/scores/{tenant-id} — Get health score for a specific tenant
  • GET /api/v1/health/risks — List tenants at risk of churn
  • POST /api/v1/health/recalculate — Trigger health score recalculation

Relationships

◇ Composes outgoing 1
Target Element Element Type
Customer Health Service Software Subsystem
◇ Part of incoming 1
Source Element Element Type
Customer Health Service Software Subsystem
→ Served by incoming 10
Source Element Element Type
Health Score Changed Domain Event
Notification Bounced Domain Event
Onboarding Completed Domain Event
Onboarding Started Domain Event
Tenant Created Domain Event
Tenant Deactivated Domain Event
Tenant Reactivated Domain Event
Tenant Suspended Domain Event
User Deactivated Domain Event
Webhook Failed Domain Event

Architecture Context

Diagrams

Properties

Type API Endpoint
Layer Application
Domain Customer Management
Status active
Owner Platform Team

Additional Metadata

Protocol REST/JSON
Archimate Type application-interface

Meta Model

Business
Organization
Application current
Technology

Actions