A funnel goal that is achieved when a lead's points balance in a named rewards bucket reaches a configured threshold. It matches against reward-granted events, comparing either the lead's cumulative lifetime points earned in the bucket or their currently available balance, depending on how the goal is configured. It is one of the node types a marketing funnel can use to branch on a lead's rewards activity.

Group: Journeys

Extends: Goal

Implements: Serializable


Properties

PropertyReturnsDescription
descriptionStringHuman-readable summary of this goal for display in the funnel editor, naming the target points amount and bucket.
nextNodeIdStringId of the journey node to transition to once this goal's points threshold is reached.
onCumulativebooleanWhether the threshold is matched against the lead's cumulative lifetime points earned in the bucket, rather than their currently available balance.
pointsAmountdoublePoints threshold that must be reached in the reward bucket for this goal to match.
rewardNameStringName of the rewards/points bucket this goal watches for a balance threshold. Never null once the goal is configured.

Methods

getDescription()

Returns: String

Human-readable summary of this goal for display in the funnel editor, naming the target points amount and bucket.

getRewardName()

Returns: String

Name of the rewards/points bucket this goal watches for a balance threshold. Never null once the goal is configured.

getPointsAmount()

Returns: double

Points threshold that must be reached in the reward bucket for this goal to match.

isOnCumulative()

Returns: boolean

Whether the threshold is matched against the lead's cumulative lifetime points earned in the bucket, rather than their currently available balance.

getNextNodeId()

Returns: String

Id of the journey node to transition to once this goal's points threshold is reached.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.