AttribModel

Represents an attribution model used with Personalization, Attribution, and Campaign Influence, including model weights and touch type.

Introduced in API version 62.0.

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

  • Type: reference

  • Properties: Filter, Group, Sort

  • Relationship name: AttribModelDef

  • Relationship type: relationship

  • Refers to: AttribModelDef

  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Indicates a model’s current status. The default value is Draft, and accepted values are
  • Possible values:
    • Active — Active
    • Draft — Draft
    • Inactive — Inactive
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 64.0
  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Relationship name: AttribRecordOutputObject

  • Relationship type: polymorphic

  • Refers to: MktDataModelObject, MktDataLakeObject

  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Indicates the type of attribution model, which determines which touchpoints to evaluate. The default value is LastTouch, and accepted values are
  • Possible values:
    • First touch — First touch
    • LastTouch — LastTouch
  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Relationship name: ContentObject

  • Relationship type: relationship

  • Refers to: MktDataModelObject

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Relationship name: DailyContentOutputObject

  • Relationship type: relationship

  • Refers to: MktDataModelObject

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Relationship name: DailyOutputObject

  • Relationship type: relationship

  • Refers to: MktDataModelObject

  • Type: reference
  • Properties: Filter, Group, Sort
  • Description: Unique identifier that refers to the data space where a model’s resources originate. This is a required field.
  • Relationship name: DataSpace
  • Relationship type: relationship
  • Refers to: DataSpace
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Text description of the attribution model. Optional.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Auto-generated or user-generated API name for the attribution model. This is a required field.
  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 63.0
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: Defines a timeframe for tracking attribution-related engagement. This is a required field.
  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
  • Description: Defines which identity resolution method to use when tracking engagement activities. Default value is Individual, and acceptable values are
  • Possible values:
    • Individual — Individual
    • Unified — Unified
  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 65.0

  • Default value: false

  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Description: Defines whether to sync data before the attribution window begins. The default value is false.
  • Default value: false
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Description: The timestamp that indicates the last time engagement data was refreshed and evaluated by the model.
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Description: The timestamp that indicates the last time the model was successfully refreshed.
  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 63.0
  • Description: Picklist value that indicates the status of last refresh process. The default value is None, and accepted values are
  • Possible values:
    • Canceled — Canceled
    • Complete — Complete
    • Failure — Failure
    • None — None
    • Processing — Processing
  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Indicates the app or feature in which the attribution model is used. The default value is Personalization, and accepted values are
  • Possible values:
    • Attribution — Attribution
    • CampaignInfluence — CampaignInfluence
    • Personalization — Personalization
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: A version number that indicates the latest save of the model.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Type: string
  • Properties: Filter, Group, idLookup, Sort
  • Description: Text label that identifies the attribution model. This is a required field.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 64.0
  • Description: Indicates who’s using the model. This field is required if the value of ModelContext is Attribution.
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: Unique identifier that refers to the profile data graph that’s used with the model.
  • Relationship name: ProfileDataGraph
  • Relationship type: relationship
  • Refers to: DataGraph
  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Relationship name: ProfileLinkObject

  • Relationship type: relationship

  • Refers to: MktDataModelObject

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: The scheduled frequency (in minutes) at which the attribution model is processed.
  • Type: picklist
  • Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
  • Description: Indicates the current status of the attribution model while an action is being performed. The default value is Processing, and acceptable values are:
  • Possible values:
    • Active — Active
    • CreateError — CreateError
    • DeleteError — DeleteError
    • Deleting — Deleting
    • EditError — EditError
    • Processing — Processing
  • Type: string
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 64.0
  • Description: User-generated strings that can be used to organize attribution models.
  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Relationship name: UnifiedProfileObject

  • Relationship type: relationship

  • Refers to: MktDataModelObject

Use this object to get information about attribution models that are in use with personalization and influence features. For example, you can:

  • Retrieve status and error details.
  • Identify model settings such as type (first-touch, last-touch).
  • Find out when the model was last used, refreshed, or synced.

This object has the following 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.