AttribModelStage

Represents a funnel stage that’s used in a predefined or custom attribution configuration. Available in API version 62.0 and later.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Field Details
AttribModelId
Type
reference
Properties
Filter, Group, Sort
Description
Unique identifier that refers to the attribution configuration that uses this stage. This is a required field.
Relationship Name
AttribModel
Relationship Type
Master-detail
Refers To
AttribModel (the master object)
CurrencyIsoCode
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field.
EngagementSignalEnum
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Picklist value that indicates the engagement signal that’s selected for an attribution stage. This value represents a step in a customer journey.

The accepted values are the engagement signals that are configured in the selected data space.

IsContentMatchRequired
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

Indicates whether to link item attribution from one funnel stage to the next. The default value is false, meaning not required. If you set this value to true, only engagement with the same item from the previous stage is linkable.

Name
Type
string
Properties
Filter, Group, idLookup, Sort
Description
Text label that identifies the attribution model stage. This is a required field.
Sequence
Type
int
Properties
Filter, Group, Sort
Description

Indicates the position of a stage in its journey sequence, reflecting funnel engagement from start to finish. The funnel requires a minimum of two stages, with a maximum of four stages. Accepted values are 1, 2, 3, or 4.

StageUnionGroupName
Type
string
Properties
Filter, Group, Nillable, Sort
Description

Name of a certain group of stages. It can be used to reference individual, consecutive stages as a combined group with a common name.

Usage

Use this object to create attribution funnel stages. The funnel mirrors key touchpoints of an individual’s personalization journey, which you define by selecting an engagement signal and any relevant metrics. The order that you create stages in describes funnel engagement from start to finish.

For example, view a product, click the product, add it to cart, and submit the order. The funnel requires a minimum of two stages, with a maximum of four stages in a journey.

Associated Objects

This object has the these associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

AttribModelStageChangeEvent
Change events are available for the object.
AttribModelStageFeed
Feed tracking is available for the object.
AttribModelStageHistory
History is available for tracked fields of the object.
AttribModelStageOwnerSharingRule
Sharing rules are available for the object.
AttribModelStageShare
Sharing is available for the object.