Market pillar · v0.16.0
customer-health CustomerHealth
Customer-health snapshot.
$id · https://corpospec.com/schemas/v0.16.0/customer-health.schema.json
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| band | HealthBand | yes | Health band (traffic-light). |
| captured_at | IsoDate | yes | ISO 8601 date (YYYY-MM-DD). |
| components | HealthComponent[] | yes | |
| composite_score | number | yes | Composite score 0–100. |
| csm_owner | PathRef | yes | PathRef to the customer-success owner. |
| customer | PathRef | yes | PathRef to the customer. |
| days_to_renewal | integer | yes | Days to renewal at capture. |
| id | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| pii_class | PiiClass | yes | Personal-data classification on every record carrying personal data, per BDR 0070 / BDR 0069 / BDR 0078. Used by `corpospec-report` to gate rendering and by the privacy pillar's RoPA records to determine safeguards. |
| renewal_date | IsoDate | yes | Renewal date. |
| renewal_likelihood | RenewalLikelihood | yes | Renewal-likelihood category. |
| signals | HealthSignal[] | yes | Active risk signals. |
| recommended_action | string? | — | Recommended action (free-form). |
| trend_snapshots | PathRef[] | — | PathRefs to historical snapshots feeding the trend. |
Definitions
Shared types referenced within this schema.
HealthBand
Health band (traffic-light).
enum: "red", "yellow", "green"
HealthComponent
Health component (one weighted dimension).
type: object
HealthSignal
One open risk or signal.
type: object
IsoDate
ISO 8601 date (YYYY-MM-DD).
type: string
PathRef
Path-based cross-reference relative to .corpospec/ root.
Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$
PiiClass
Personal-data classification on every record carrying personal data, per
BDR 0070 / BDR 0069 / BDR 0078. Used by `corpospec-report` to gate
rendering and by the privacy pillar's RoPA records to determine
safeguards.
RenewalLikelihood
Renewal-likelihood category.
Reference in your YAML
# yaml-language-server: $schema=https://corpospec.com/schemas/v0.16.0/customer-health.schema.json