Sign in
latestOpenAPI 3.0.42026-08-2211752834.3 KB

fa74265a328d

ChurnScore

Get entity from ChurnScore by key

get/ChurnScore({Id})

Path parameters

Idnumber nullable required

Id of the ChurnScore

Query parameters

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved entity

Idnumber

Internal identifier for ChurnZero.

ChurnScoreType'Standard' | 'Composite' | 'Family'

The type of Churn Score: Standard (built from raw signal factors), Composite (built from other ChurnScores used as weighted factors), or Family.

GradingBottomnumber

The lower cut point of the red/yellow/green grading scale: calculated scores at or below this value grade green (healthy / low churn risk).

GradingTopnumber

The upper cut point of the red/yellow/green grading scale: scores above GradingBottom and at or below this value grade yellow; scores above this value grade red (high churn risk).

Namestring

The name of the Churn Score, as configured by the admin.