Create a new key momentt

Create a new key moment with the given parameters

application/json

Request Body required

audienceTracking boolean
Indicates if the key moment is used for audience
conditionsData object
Conditions by which visitors will be segmented
firstLevel object[]
First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)
Array [
conditions object[]
Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.
Array [
oneOf
ACTIVE_SESSION
AD_BLOCKER
APPLICATION_VERSION
BROWSER
BROWSER_LANGUAGE
CONVERSIONS
COOKIE
CUSTOM_DATUM
DAY_NIGHT
DAY_OF_WEEK
DEVICE_TYPE
DOM_ELEMENT
EVENT
EXCLUSIVE_EXPERIMENT
EXCLUSIVE_FEATURE_FLAG
EXPLICIT_TRIGGER
FIRST_VISIT
FORECAST_SKY_STATUS
FORECAST_TEMPERATURE
GEOLOCATION
HEAT_SLICE
HOUR_MINUTE_RANGE
INTERNAL_SEARCH_KEYWORDS
JS_CODE
KEY_MOMENT
KEY_PAGES
LANDING_PAGE
LAST_VISIT
MOUSE_OUT
NEW_VISITORS
NUMBER_OF_VISITED_PAGES
OPERATING_SYSTEM
ORIGIN
ORIGIN_TYPE
PAGE_TITLE
PAGE_URL
PAGE_VIEWS
PREVIOUS_PAGE
PRICE_OF_DISPLAYED_PAGE
REFERRERS
SAME_DAY_VISITS
SCREEN_DIMENSION
SDK_TYPE
SEGMENT
SKY_STATUS
TABS_ON_SITE
TARGET_EXPERIMENT
TARGET_FEATURE_FLAG
TARGET_PERSONALIZATION
TEALIUM_AUDIENCE
TEALIUM_BADGE
TEMPERATURE
TIME_RANGE
TIME_SINCE_PAGE_LOAD
VISITED_PAGES
VISITOR_CODE
VISITOR_IP
VISITS
VISITS_BY_PAGE
YSANCE_ATTRIBUT
YSANCE_SEGMENT
weight int32 required
More important conditions have greater values. Default value: 1
count int32
Count of time elapsed since session became active according to the 'unitOfTime' field
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
matchType string
Possible values: [EQUAL, LOWER, GREATER]
How to match the specified amount of time
unitOfTime string
Possible values: [SECOND, MINUTE, HOUR, DAY]
What unit of measurements will be used to define if sessions are active for the required duration
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
referrerIndex string
Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
referrerName string
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
matchType string
Possible values: [EQUAL, LOWER, GREATER]
How to match the specified amount of time. Default value: 'EQUAL'
visitCount int32
Number of visits for today
weight int32 required
More important conditions have greater values. Default value: 1
height int32
Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound int32
Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType string
Possible values: [INCLUDE, EQUAL, LOWER, GREATER]
How to match the specified height
heightUpperBound int32
Should be specified if 'heightMatchType' is 'INCLUDE'
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
width int32
Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound int32
Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType string
Possible values: [INCLUDE, EQUAL, LOWER, GREATER]
How to match the specified width
widthUpperBound int32
Should be specified if 'widthMatchType' is 'INCLUDE'
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
sdkType string
Possible values: [ANDROID, IOS, JAVA, DOTNET, NODEJS, PHP, RUBY, GO, FLUTTER, REACT, PYTHON, JAVASCRIPT]
The type of SDK through which the visitor has been triggered
version string
SDK language version
versionMatchType string
Possible values: [EQUAL, LOWER, GREATER]
How to match the specified version of the sdk language. Default value: 'EQUAL'
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
linkedSegmentId int64
Id of linked segment
linkedSegmentName string
Name of linked segment
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
skyStatus string
Possible values: [CLEAR_SKY, MIST, FEW_CLOUDS, SCATTERED_CLOUDS, OVERCAST_CLOUDS, DRIZZLE, RAIN, EXTREME_RAIN, THUNDERSTORM, VIOLENT_THUNDERSTORM, SNOW, HEAVY_SNOW, HAIL, BREEZE, HIGH_WIND, GALE, SAND_DUST, VOLCANIC, TORNADO, TROPICAL_STORM, HURRICANE]
Specific status of the sky. Can be null if 'skyStatusGroup' is filled
skyStatusGroup string
Possible values: [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
matchType string
Possible values: [EQUAL, LOWER, GREATER]
How to match the specified amount of tabs
tabCount int32
Number of tabs opened
weight int32 required
More important conditions have greater values. Default value: 1
experiment int64
Id of experiment
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
variation int64
Id of variation which was retrieved by specified experiment
variationMatchType string
Possible values: [ANY, EXACT]
How to match the specified variation. Default value: 'ANY'
weight int32 required
More important conditions have greater values. Default value: 1
featureFlagId int64
Id of the targeted feature flag
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
ruleId int64
Id of the rule of the targeted feature flag
variationKey string
Key of the variation of the targeted feature flag
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
personalization int64
Id of personalization
weight int32 required
More important conditions have greater values. Default value: 1
audiences object[]
List of tealium audiences
Array [
id string required
Audience unique identifier
name string required
Audience name
]
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
weight int32 required
More important conditions have greater values. Default value: 1
badges object[]
List of tealium badges
Array [
id int64 required
Badge unique identifier
name string required
Badge name
]
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
lowerBoundValue int32
Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
measurement string
Possible values: [CELSIUS, FAHRENHEIT]
Default value: 'CELSIUS'
temperatureMatchType string
Possible values: [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
How to match the specified value of temperature
upperBoundValue int32
Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
value int32
Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
since date-time
Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to date-time
To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
weight int32 required
More important conditions have greater values. Default value: 1
count int32
Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType string
Possible values: [EQUAL, LOWER, GREATER]
How to match the specified amount of time
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
unitOfTime string
Possible values: [SECOND, MINUTE, HOUR, DAY]
What unit of measurements will be used to define time since a page load
url string
URL template
urlMatchType string
Possible values: [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
Accordance between requested URL and URL template. Default value: EXACT
weight int32 required
More important conditions have greater values. Default value: 1
countOfPages int32
Amount of visited pages
countOfPagesMatchType string
Possible values: [GREATER, EXACT, LOWER, ALL]
How to match 'countOfPages'?
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
productEans string[]
Pages of which products should be visited?
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
matchType string
Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]
How to match the specified visitor code. Default value: EXACT
visitorCode string
Visitor code
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
ipLowerBound string
Lower bound of ip addresses range. If visitor ip match or is more than the bound it will be included in or excluded from the segment.If the field is filled then 'ipUpperBound' has to be filled too
ipRanges array[]
Visitor ip address ranges
ipUpperBound string
Upper bound of ip addresses range. If visitor ip match or is less than the bound it will included in or excluded from the segment.If the field is filled then 'ipLowerBound' has to be filled too
ips string[]
Exact visitor ip address
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
matchType string
Possible values: [EQUAL, LOWER, GREATER]
How to match the specified amount of visits
visitCount int32
Total amount of visits
weight int32 required
More important conditions have greater values. Default value: 1
count int32
Amount of visits
countMatchType string
Possible values: [EQUAL, LOWER, GREATER]
How to match the specified amount of visits
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
period string
Possible values: [VISIT, VISITOR, HOUR, DAY, MONTH]
Per what period of time visits should be considered
url string
URL template
urlMatchType string
Possible values: [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
Accordance between requested URL and URL template. Default value: EXACT
weight int32 required
More important conditions have greater values. Default value: 1
attribute string
Ysance attribute
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
value string
Attribute value
valueMatchType string
Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]
How to match the specified attribute value. Default value: 'EXACT'
weight int32 required
More important conditions have greater values. Default value: 1
include boolean
Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
segments string[]
Ysance segments
]

orOperators boolean[]

Array of booleans ("or"=true, "and"=false) for binding conditions of second level.

]

firstLevelOrOperators boolean[]

Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.

{ "audienceTracking": true, "audienceTrackingEditable": true, "conditionsData": { "firstLevel": [ { "conditions": [ { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "count": 0, "include": true, "matchType": "EQUAL", "unitOfTime": "SECOND" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "version": "string", "versionMatchType": "EQUAL" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "browser": "CHROME", "include": true, "version": "string", "versionMatchType": "EQUAL" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "language": "ru" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "allVisits": 0, "goalId": 0, "include": true }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "name": "string", "nameMatchType": "EXACT", "value": "string", "valueMatchType": "EXACT" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "customDataIndex": "string", "customDataName": "string", "include": true, "lowerBoundCustom": 1, "upperBoundCustom": 5, "value": "string", "valueCustom": "string", "valueMatchType": "TRUE" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "dayPeriod": "DAY", "include": true }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "day": "SUNDAY", "include": true }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "device": "DESKTOP", "include": true }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "elementType": "SINGLE", "elementValue": "string", "include": true }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "event": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "testMatchType": "ALL" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "experimentationType": "ALL" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "count": 0, "include": true, "matchType": "EQUAL", "unitOfTime": "MINUTE" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "daysRange": 0, "forecastDays": 0, "forecastMatchType": "EQUAL", "include": true, "skyStatus": "CLEAR_SKY", "skyStatusGroup": "CLEAR_SKY" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "daysRange": 0, "forecastDays": 0, "forecastMatchType": "EQUAL", "include": true, "lowerBoundValue": 0, "measurement": "CELSIUS", "temperatureMatchType": "EQUAL", "upperBoundValue": 0, "value": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "city": "string", "country": "string", "include": true, "region": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "goalId": 0, "include": true, "keyMomentId": 0, "lowerBound": 0, "upperBound": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "since": "string", "to": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "keyWordIndex": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "applied": "DOM_READY", "include": true, "jsCode": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "linkedKeyMomentId": 0, "linkedKeyMomentName": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "keyPageIndex": "string", "keyPageName": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EXACT", "url": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "count": 0, "include": true, "matchType": "EQUAL", "unitOfTime": "MINUTE" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "visitorsType": "NEW" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "categories": [ "string" ], "countOfPages": 0, "countOfPagesMatchType": "GREATER", "include": true, "priceMatchType": "ANY", "priceParams": { "areaOfPriceMatching": "ALL_CATALOGUE", "categories": [ "string" ], "priceCategory": "EXPENSIVE", "productEans": [ "string" ], "productWayOfCounting": "PERCENT", "value": 0 } }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "os": "WINDOWS" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EXACT", "url": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "trafficType": "SEO" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EXACT", "title": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EXACT", "url": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EQUAL", "pageCount": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EXACT", "url": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "priceMatchType": "ANY", "priceParams": { "areaOfPriceMatching": "ALL_CATALOGUE", "categories": [ "string" ], "priceCategory": "EXPENSIVE", "productEans": [ "string" ], "productWayOfCounting": "PERCENT", "value": 0 } }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "referrerIndex": "string", "referrerName": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EQUAL", "visitCount": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "height": 0, "heightLowerBound": 0, "heightMatchType": "INCLUDE", "heightUpperBound": 0, "include": true, "width": 0, "widthLowerBound": 0, "widthMatchType": "INCLUDE", "widthUpperBound": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "sdkType": "ANDROID", "version": "string", "versionMatchType": "EQUAL" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "linkedSegmentId": 0, "linkedSegmentName": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "skyStatus": "CLEAR_SKY", "skyStatusGroup": "CLEAR_SKY" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EQUAL", "tabCount": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "experiment": 0, "include": true, "variation": 0, "variationMatchType": "ANY" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "featureFlagId": 0, "include": true, "ruleId": 0, "variationKey": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "personalization": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "audiences": [ { "id": "string", "name": "string" } ], "include": true }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "badges": [ { "id": 0, "name": "string" } ], "include": true }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "lowerBoundValue": 0, "measurement": "CELSIUS", "temperatureMatchType": "EQUAL", "upperBoundValue": 0, "value": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "since": "2024-12-20T15:04:33.195Z", "to": "2024-12-20T15:04:33.195Z" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "count": 0, "countMatchType": "EQUAL", "include": true, "unitOfTime": "SECOND", "url": "string", "urlMatchType": "EXACT" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "countOfPages": 0, "countOfPagesMatchType": "GREATER", "include": true, "productEans": [ "string" ] }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EXACT", "visitorCode": "string" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "ipLowerBound": "string", "ipRanges": [ [ "string" ] ], "ipUpperBound": "string", "ips": [ "string" ] }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "matchType": "EQUAL", "visitCount": 0 }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "count": 0, "countMatchType": "EQUAL", "include": true, "period": "VISIT", "url": "string", "urlMatchType": "EXACT" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "attribute": "string", "include": true, "value": "string", "valueMatchType": "EXACT" }, { "htmlDescription": "string", "id": 0, "targetingType": "PAGE_URL", "weight": 1, "include": true, "segments": [ "string" ] } ], "orOperators": [ true ] } ], "firstLevelOrOperators": [ true ] }, "createdBy": 0, "dateCreated": "2024-12-20T15:04:33.197Z", "dateModified": "2024-12-20T15:04:33.197Z", "description": "The key moment is for new ab tests", "id": 0, "isFavorite": true, "name": "My Key Moment", "siteId": 8372 }

Create a new key momentt​

Create a new key momentt