ChurnScoreFactor

Get entity from ChurnScoreFactor by key

get/ChurnScoreFactor({Id})

Request

  • Base URL: https://marketingpony.us1app.churnzero.net/public/v1
  • URL: https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactor({Id})
  • Auth: HTTP basic

Path parameters

Idnumber nullable required

Id of the ChurnScoreFactor

Query parameters

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved entity

Idnumber

Internal identifier for ChurnZero.

ChurnScoreFactorType'EventCount' | 'SegmentBonus' | 'ActiveContacts' | 'LicenseUtilization' | 'Tenure' | 'RenewalAmount' | 'TimeInApp' | 'ActiveDays' | 'AccountAttribute' | 'TaskLoggedActivities' | 'TaskMostRecentActivity' | 'CustomTable' | 'NumberOfContactMessagesSent' | 'MostRecentMessageSent' | 'JourneyProgress' | 'NumberOfContactMessagesReceived' | 'MostRecentMessageReceived' | 'NumberOfContactMessagesSentOrReceived' | 'MostRecentMessageSentOrReceived' | 'SurveyScore' | 'SuccessInsights' | 'NumberOfNotes' | 'MostRecentNoteDaysFromToday' | 'ChurnScore' | 'FamilyPrimaryChurnScores' | 'NumberOfMeetings' | 'NextUpcomingMeeting' | 'MostRecentPastMeeting' | 'PercentOfSuccessPlanGoalsAchieved' | 'NumberOfSuccessPlanGoals' | 'NumberOfSuccessPlans' | 'PercentOfSuccessPlansClosed' | 'MostRecentSignalDaysFromToday' | 'NumberOfSignals'

The kind of signal this factor measures, as a string (e.g. EventCount, ActiveContacts, LicenseUtilization, Tenure, SurveyScore, JourneyProgress, ChurnScore — the last being a composite factor built from another ChurnScore).

ChurnScoreIdnumber

The Id of the ChurnScore this factor belongs to; see the ChurnScore entity.

Namestring

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

Changes

No recorded changes to this operation across all 9 revisions of this API.