Experience definitions
The following table includes the attributes that are available in the experience definitions entity.
| Attribute | Description | Type | Example |
|---|---|---|---|
meta_client_key | The unique client reference. | string | "mhbWwbHYfhpheu86hp60oR76S4jQMmZr" |
meta_ref | The unique identifier of the experience. | string | "9d94ee11-7043-4b71-980c-a777d00a7b46" |
core_name | The name of the experience. A free text value defined by your organization. | string | "Offer On Exit Intent" |
core_revision | The current revision of the experience. | integer | 45 |
core_archived | Indicates whether the experience has been archived. | Boolean | false |
core_friendly_id | The unique identifier of the experience as defined by your organization. This is derived from the core_name, by removing special characters, converting upper case letters to lower case, and replacing spaces with an underscore. | string | "offer_on_exit_intent" |
type | The experience type: web, triggered, or interactive. | string | The following values describe the experience type:"INTERACTIVE_WEB_FLOW" - web"TRIGGERED_V3" - triggered"INTERACTIVE_API_FLOW" - interactive |
meta_subtype | Identifies whether this is an experience or an experiment. | string | "EXPERIENCE" |
core_status | The current status of the experience. | string | "DRAFT", "PRODUCTION", "PAUSED", "COMPLETE" |
core_channels | The channels on which this experience is deployed. | string | "WEB" |
core_traffic | The traffic distribution defined for this experience. | struct | {type=simpleTraffic, splits=[{ref=9d94ee11-7043-4b71-980c-a777d00a7b46, low_split=null, high_split=null, split=50}, {ref=9d94ee11-7043-4b71-980c-a777d00a7b46, low_split=null, high_split=null, split=50}]} |
core_goals | The primary and secondary goals which are assigned to the experience. | struct | {primary={type=conversionsGoal, friendly_id=null, ref=6p94ee11-7043-4b71-980c-a777d00a7b46, name=ConversionsGoal}, secondary=[{type=customGoal, friendly_id=null, ref=9d94ee11-7043-4b71-980c-a777d00a7b12, name=Interaction}]} |
core_variants | The variants for this experience, including a definition of control and test variants. | array | {ref=5g94ee11-7043-4b71-980c-a777d00a7b46, name=Offer on Exit Intent, is_control=false}, {ref=2d94ee11-7043-4b71-980c-a777d00a7b12, name=Original, is_control=true} |
core_schedule | If the experience has been assigned a schedule, this attribute includes the schedule definition. | struct | {type=simpleSchedule, start_date=2022-01-15T15:20.924Z, end_date=null} |
If you have suggestions for improving this article, let us know!