One step of a lead moving from one journey node to the next, written every time a node is attained. Replaying a lead's transitions in date order reconstructs the path it took through the journey, which is what the funnel analytics are built from. For speed the related records are held as plain id columns rather than as associations, so use the id getters and load the lead, funnel or profile yourself if you need the full record.

Group: Database Entities

Implements: Serializable, Relational


Properties

PropertyReturnsDescription
adminDomainIdlongThe id of the organisation that owns the lead, stored as a plain number rather than an association so that the analytics queries stay fast.
attainedNodeIdStringThe id of the journey node the lead has just reached, as it appears in the journey definition.
createDateDateWhen the transition happened. This is the field to order by when replaying a lead's journey.
didTimeoutBooleanTrue when the lead moved on because the node timed out rather than because it genuinely met the node's condition. Treat these transitions as unattained when reporting on completion.
forkIdLongThe id of the fork within the lead that made this transition, for journeys that run several branches at once. Null when the transition was made by the lead's main flow.
funnelIdlongThe id of the journey, held as a plain number rather than an association. Load the FunnelRepository by this id if you need the journey definition.
idlongThe database identifier of this transition record.
lastAttainedNodeIdStringThe id of the journey node the lead was at before this transition. Null for the first transition of a journey, and it is the field the funnel drop off counts group on.
leadIdlongThe id of the lead that moved, held as a plain number rather than an association. Load the Lead by this id if you need the lead itself.
profileIdLongThe id of the profile the lead belongs to. Null when the transition happened while the lead was still anonymous.
sourceStringWhere the lead originally came from, copied off the lead when the transition was recorded, for example facebook or googleAd. Null if the lead has no source.
stageStringThe stage the lead was in when the transition occurred, copied off the lead at the time.
trackingIdStringThe lead's tracking id, copied off the lead when the transition was recorded. It ties the transition back to the visitor's browser activity.

Methods

getId() · getSource() · setSource(String source) · getAdminDomainId() · setAdminDomainId(long adminDomainId) · getTrackingId() · setTrackingId(String trackingId) · getProfileId() · setProfileId(Long profileId) · getCreateDate() · setCreateDate(Date createDate) · getAttainedNodeId() · setAttainedNodeId(String attainedNodeId) · getLastAttainedNodeId() · setLastAttainedNodeId(String lastAttainedNodeId) · getFunnelId() · setFunnelId(long funnelId) · getLeadId() · setLeadId(long leadId) · getForkId() · setForkId(Long forkId) · getStage() · setStage(String stage) · getDidTimeout() · setDidTimeout(Boolean didTimeout)

getId()

Returns: long

The database identifier of this transition record.

getSource()

Returns: String

Where the lead originally came from, copied off the lead when the transition was recorded, for example facebook or googleAd. Null if the lead has no source.

setSource(String source)

Returns: void

Sets where the lead originally came from.

ParameterDescription
sourcethe lead's source

getAdminDomainId()

Returns: long

The id of the organisation that owns the lead, stored as a plain number rather than an association so that the analytics queries stay fast.

setAdminDomainId(long adminDomainId)

Returns: void

Sets the id of the organisation that owns the lead.

ParameterDescription
adminDomainIdthe id of the owning organisation

getTrackingId()

Returns: String

The lead's tracking id, copied off the lead when the transition was recorded. It ties the transition back to the visitor's browser activity.

setTrackingId(String trackingId)

Returns: void

Sets the lead's tracking id.

ParameterDescription
trackingIdthe lead's tracking id

getProfileId()

Returns: Long

The id of the profile the lead belongs to. Null when the transition happened while the lead was still anonymous.

setProfileId(Long profileId)

Returns: void

Sets the id of the profile the lead belongs to.

ParameterDescription
profileIdthe id of the lead's profile, or null if anonymous

getCreateDate()

Returns: Date

When the transition happened. This is the field to order by when replaying a lead's journey.

setCreateDate(Date createDate)

Returns: void

Sets when the transition happened.

ParameterDescription
createDatethe date and time of the transition

getAttainedNodeId()

Returns: String

The id of the journey node the lead has just reached, as it appears in the journey definition.

setAttainedNodeId(String attainedNodeId)

Returns: void

Sets the id of the journey node the lead has just reached.

ParameterDescription
attainedNodeIdthe id of the node just attained

getLastAttainedNodeId()

Returns: String

The id of the journey node the lead was at before this transition. Null for the first transition of a journey, and it is the field the funnel drop off counts group on.

setLastAttainedNodeId(String lastAttainedNodeId)

Returns: void

Sets the id of the journey node the lead was at before this transition.

ParameterDescription
lastAttainedNodeIdthe id of the previous node

getFunnelId()

Returns: long

The id of the journey, held as a plain number rather than an association. Load the FunnelRepository by this id if you need the journey definition.

setFunnelId(long funnelId)

Returns: void

Sets the id of the journey this transition belongs to.

ParameterDescription
funnelIdthe id of the journey

getLeadId()

Returns: long

The id of the lead that moved, held as a plain number rather than an association. Load the Lead by this id if you need the lead itself.

setLeadId(long leadId)

Returns: void

Sets the id of the lead that moved.

ParameterDescription
leadIdthe id of the lead

getForkId()

Returns: Long

The id of the fork within the lead that made this transition, for journeys that run several branches at once. Null when the transition was made by the lead's main flow.

setForkId(Long forkId)

Returns: void

Sets the id of the fork within the lead that made this transition.

ParameterDescription
forkIdthe id of the lead fork, or null for the main flow

getStage()

Returns: String

The stage the lead was in when the transition occurred, copied off the lead at the time.

setStage(String stage)

Returns: void

Sets the stage the lead was in when the transition occurred.

ParameterDescription
stagethe lead's stage name at the time of the transition

getDidTimeout()

Returns: Boolean

True when the lead moved on because the node timed out rather than because it genuinely met the node's condition. Treat these transitions as unattained when reporting on completion.

setDidTimeout(Boolean didTimeout)

Returns: void

Sets whether the transition was caused by the node timing out.

ParameterDescription
didTimeouttrue if the transition was caused by a timeout
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.