AttribModel

Represents an attribution model used with Personalization, Attribution, and Campaign Influence, including model weights and touch type. This object is available in API version 62.0 and later.

Supported Calls

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

Fields

Field Details
AttribModelStatus
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

  • Active
  • Draft
  • Inactive
AttributionModelType
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
  • First touch
  • LastTouch
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.
DataSpaceId
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
Refers To
DataSpace
Description
Type
String
Properties
Filter, Group, Nillable, Sort
Description
Text description of the attribution model. Optional.
DeveloperName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Auto-generated or user-generated API name for the attribution model. This is a required field.
Error Code
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the issue that’s causing an error. The default value is None, and accepted values are
  • ConfigurationMissingError indicates that a required configuration setting is missing.
  • DpcJobError indicates a problem during processing.
  • InternalError indicates an internal error during processing.
  • ModelValidationError indicates that the model is invalid.
  • None
GlobalAttributionWindowDays
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Defines a timeframe for tracking attribution-related engagement. This is a required field.
IdentityResolutionMode
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
  • Individual
  • Unified
IsZeroDayLoadRequired
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.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Timestamp that indicates the last time the model was referenced by another resource.
LastRefresh
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp that indicates the last time engagement data was refreshed and evaluated by the model.
LastSuccessfulRefresh
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp that indicates the last time the model was successfully refreshed.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Timestamp that indicates the last time a user viewed the model.
LatestRefreshedStatus
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Picklist value that indicates the status of last refresh process. The default value is None, and accepted values are
  • Canceled
  • Complete
  • Failure
  • None
  • Processing
ModelContext
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
  • Attribution: indicates the use with Attribution in Salesforce Personalization.
  • CampaignInfluence: indicates the use with Campaign Influence in Unified Marketing Analytics.
  • Personalization: indicates the use with Personalization in Salesforce Personalization.
ModelRevision
Type
int
Properties
Filter, Group, Nillable, Sort
Description
A version number that indicates the latest save of the model.
Name
Type
string
Properties
Filter, Group, idLookup, Sort
Description
Text label that identifies the attribution model. This is a required field.
Partner
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Indicates who's using the model. This field is required if the value of ModelContext is Attribution.
ProfileDataGraphId
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
Refers To
DataGraph
ScheduledFrequencyMins
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The scheduled frequency (in minutes) at which the attribution model is processed.
SyncStatus
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:
  • Active
  • CreateError
  • DeleteError
  • Deleting
  • EditError
  • Processing
Tags
Type
string
Properties
Filter, Nillable, Sort
Description
User-generated strings that can be used to organize attribution models.

Usage

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.

Associated Objects

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

AttribModelChangeEvent
Change events are available for the object.
AttribModelFeed
Feed tracking is available for the object.
AttribModelHistory
History is available for tracked fields of the object.
AttribModelOwnerSharingRule
Sharing rules are available for the object.
AttribModelShare
Sharing is available for the object.