Newer Version Available

This content describes an older version of this product. View Latest

AbnExperimentCohort

Represents the specified audience that's participating in an A/B/n experiment. This object is available in API version 63.0 and later.

Supported Calls

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

Fields

Field Details
AbnExperimentId
Type
reference
Properties
Filter, Group, Sort
Description
Unique identifier that refers to a related experiment.
This field is a relationship field.
Relationship Name
AbnExperiment
Relationship Type
Parent-detail
Refers To
AbnExperiment (the parent object)
AllocationWeight
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Percentage of an audience to experience the selected part of the experiment.
CurrencyIsoCode
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Three letter ISO currency codes for supported currencies. Optional.
Possible values are:
  • USD—U.S. Dollar
DataSpaceId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Unique identifier that refers to the data space where an experiment cohort's resources originate. Required.
This field is a relationship field.
Relationship Name
DataSpace
Refers To
DataSpace
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Text description of the experiment.
DeveloperName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
System or user-generated API name for the experiment. Required.
IsControl
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Whether the cohort is used as the control group that performance is checked against.
The default value is false.
IsFallThrough
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this cohort captures users who don't meet the criteria for other cohorts in the experiment. When true, this cohort serves as the fallback option. When false, users must explicitly qualify for this cohort. The default value is false.
Name
Type
string
Properties
Filter, Group, idLookup, Sort
Description
Text label that identifies the experiment cohort. Required.
PersonalizerId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Unique identifier that refers to the personalizer that’s related to the experiment cohort.
This field is a relationship field.
Relationship Name
Personalizer
Refers To
PersonalizationRecommender

Usage

Use this object to describe experiment cohorts or to change allocation weights.

Associated Objects

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 and later.

AbnExperimentCohortChangeEvent
Change events are available for the object.
AbnExperimentCohortFeed
Feed tracking is available for the object.
AbnExperimentCohortHistory
History is available for tracked fields of the object.
AbnExperimentCohortOwnerSharingRule
Sharing rules are available for the object.
AbnExperimentCohortShare
Sharing is available for the object.