A funnel goal that is attained when a points reward is credited to, or debited from, a profile. Matches on RewardGrantedFunnelEvent for a credit, or RewardDebitedFunnelEvent for a debit, depending on the debit flag, filtering by the configured reward name and, if set, the points tag name or debit reason code. As a ManualInitiationNode, journeys can also be started directly from findStartProfiles, which looks up every profile that already has a matching points credit or debit for the configured reward.
Group: Journeys
Extends: Goal
Implements: Serializable, ManualInitiationNode
Properties
| Property | Returns | Description |
|---|---|---|
| debit | boolean | Whether this goal matches a points debit rather than a points credit. |
| description | String | A short label describing this goal's configured points reward and transaction direction. |
| nextNodeId | String | The id of the journey node to move to when this goal is attained. |
| reasonCode | String | The debit reason code this goal restricts matching to. Only applies when debit is true. |
| rewardName | String | The name of the points reward this goal matches transactions against. |
| tagName | String | The name of the points tag this goal restricts matching to. |
Methods
getDescription()
Returns: String
A short label describing this goal's configured points reward and transaction direction.
getRewardName()
Returns: String
The name of the points reward this goal matches transactions against.
isDebit()
Returns: boolean
Whether this goal matches a points debit rather than a points credit.
getTagName()
Returns: String
The name of the points tag this goal restricts matching to.
getReasonCode()
Returns: String
The debit reason code this goal restricts matching to. Only applies when debit is true.
getNextNodeId()
Returns: String
The id of the journey node to move to when this goal is attained.