Get a segment

GET 
/segments/:segmentId

Get a segment with given the associated Id

Request

Path Parameters

segmentId int64required

Query Parameters

optionalFields string[]

Responses

200

OK

*/*

Schema

Schema

audienceTracking boolean

Indicates if segment is tracking audeince

audienceTrackingEditable boolean

This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking cannot be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.

conditionsData

object

required

Conditions by which visitors will be segmented

firstLevel

object[]

First level conditions. Every level can have several conditions. E.g. If we set 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. The expression will be, (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

Determines whether to include or exclude visitors based on session duration.

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

count int32

Count of time elapsed since session became active according to the 'unitOfTime'

include boolean

Indicates if visitors who matched this condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the specified amount of time should match

Possible values: [EQUAL, LOWER, GREATER]

unitOfTime string

Units of measurements that will be used to determine if sessions are active for the required duration

Possible values: [SECOND, MINUTE, HOUR, DAY]

AD_BLOCKER

This condition includes or excludes visitors using an ad blocker

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

APPLICATION_VERSION

This condition includes or excludes visitors according to the application version

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

version string

Application version

versionMatchType string

How to match the specified version. Default value: 'EQUAL'

Possible values: [EQUAL, LOWER, GREATER]

BROWSER

Includes or excludes visitors according to their browser and their version

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

browser string

The type of browser visitors are using

Possible values: [CHROME, FIREFOX, SAFARI, IE, OPERA]

include boolean

Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

version string

Browser version

versionMatchType string

How to match the specified version of the browser. Default value: 'EQUAL'

Possible values: [EQUAL, LOWER, GREATER]

BROWSER_LANGUAGE

Includes or excludes visitors according to their languages

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

language string

Browser language code in ISO 639-1

Example: ru

CONVERSIONS

Includes or excludes visits during which a specific goal was reached

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

allVisits int64

Match all previous visits or current visit only. Default value: 'false'

goalId int64

Unique Id of the goal. If the field is not specified, then visits during which a goal was reached will be included or excluded

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

COOKIE

Includes or excludes visitors according to the presence of a cookie in their browser, and its value

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

name string

Cookie name

nameMatchType string

String that has to match the specified cookie name. Default value: 'EXACT'

Possible values: [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]

value string

Cookie value

valueMatchType string

String that has to match the specified cookie value. Default value: 'EXACT'

Possible values: [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]

CUSTOM_DATUM

Includes or excludes visitors according to the value of a custom data

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

customDataIndex string

Value can be the index of a specific custom data. Or 'ANY' to segment visitors by presence of any custom data

customDataName string

Custom data name

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

lowerBoundCustom double

Represents the lower bound when using the "RANGE" match type

Example: 1

upperBoundCustom double

Represents the higher bound when using the "RANGE" match type

Example: 5

value string

valueCustom string

The value retrieved by the specified custom data

valueMatchType string

Type of value which was retrieved by the custom data

Possible values: [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED, AMONG_VALUES, RANGE]

DAY_NIGHT

Includes or excludes visits during day or night

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

dayPeriod string

Possible values: [DAY, NIGHT]

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Includes or excludes visitors accessing the website on a specific day of the week

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

day string

Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

DEVICE_TYPE

Includes or excludes visitors according to their devices (smartphone, tablet, etc.)

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

device string

Possible values: [DESKTOP, TABLET, PHONE]

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Includes or excludes visits according to the presence of an element on the page

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

elementType string

Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified

Possible values: [SINGLE, ANY_MODIFIED]

elementValue string

Element on the page (id, class, ...) if 'elementType' is SINGLE.

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

EVENT

The test launches when specific events are triggered. To trigger an event, use the Kameleoon.API.Events.trigger(eventName) method

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

event string

Custom event

EXCLUSIVE_EXPERIMENT

Include visitors not participating in any tests, personalization or both at the same time.

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

testMatchType string

Indicates how the specified test, personalization or both the specified test and personalization should match. Default value: 'ALL'

Possible values: [ALL, TEST, PERSO]

EXCLUSIVE_FEATURE_FLAG

Exclude visitors already taking part in experimentation

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

experimentationType string

Indicates how the specified feature experiment, web experiment or any types of experiments should match. Default value: 'ALL'

Possible values: [ALL, FEATURE_EXPERIMENT, WEB_EXPERIMENT]

EXPLICIT_TRIGGER

This condition always returns undefined, which implies the segment will only be triggered via the use of our Activation API.

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

FIRST_VISIT

Includes or excludes visitors according to the time elapsed since their first visit

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

count int32

Amount of time elapsed since the first visit as indicated by 'unitOfTime'

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the specified amount of time should match

Possible values: [EQUAL, LOWER, GREATER]

unitOfTime string

Unit of measurements

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH]

FORECAST_SKY_STATUS

Includes or excludes visitors who will be exposed to the following sky conditions

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

daysRange int32

Range of days during which the forecast is expected. This value can't be less than 'forecastDays'

Possible values: <= 5

forecastDays int32

Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'

Possible values: <= 5

forecastMatchType string

Indicates how the specified amount of days should match

Possible values: [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]

include boolean

Indicates if visitors who meet this condition should be included to or excluded from the segment. Default value: 'true'

skyStatus string

Status of the sky. Can be null if 'skyStatusGroup' is not empty

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]

skyStatusGroup string

Group of sky condition statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is not empty

Possible values: [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]

FORECAST_TEMPERATURE

Includes or excludes visitors who will be exposed to the following temperatures

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

daysRange int32

Range of days during which the forecast is expected. This value can't be less than 'forecastDays'

Possible values: <= 5

forecastDays int32

Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'

Possible values: <= 5

forecastMatchType string

How to match the specified amount of days

Possible values: [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]

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 'INCLUDE'

measurement string

Default value: 'CELSIUS'

Possible values: [CELSIUS, FAHRENHEIT]

temperatureMatchType string

How to match the specified value of temperature

Possible values: [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]

upperBoundValue int32

Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'

value int32

Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'

GEOLOCATION

Includes or excludes visitors according to their country, region or town

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

city string

Visitor's city

country string

Visitor's country

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

region string

Visitor's region

HEAT_SLICE

Includes or excludes visitors according to their probability of converting the chosen goal if a key moment will be met

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

goalId int64

Unique Id of a goal

include boolean

Indicates if visitors who meet this condition should be included to or excluded from the segment. Default value: 'true'

keyMomentId int64

Unique Id of a key moment

lowerBound int32

Lower bound of the probability in percentage. Max value: 100

upperBound int32

Upper bound of the probability in percentage. Max value: 100

HOUR_MINUTE_RANGE

Includes or excludes visitors accessing the website during a specific time slot

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

since string

Time since. Time format: hh:MM

to string

Time to. Time format: hh:MM

INTERNAL_SEARCH_KEYWORDS

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included to or excluded from the segment. Default value: 'true'

keyWordIndex string

Value can be the index of a specific key word. Or, it can be 'ANY' to target visitors in the presence of any key word

JS_CODE

Write a custom JavaScript function returning true or false. If the result is true, the visitor will be included in the experiment. This function will execute each time the page is loaded

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

applied string

Enables the JavaScript code to execute after the DOM is ready or immediately. Default value: DOM_READY

Possible values: [DOM_READY, IMMEDIATE, ASYNC]

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

jsCode string

Custom JavaScript condition

KEY_MOMENT

Includes or excludes visitors according to the keymoment

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

linkedKeyMomentId int64

Id of linked keymoment

linkedKeyMomentName string

Name of linked keymoment

KEY_PAGES

Includes or excludes visitors that have visited a specific key page

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

keyPageIndex string

Value can be the index of a specific key page. Or it can be 'ANY' to target visitors in the presence of any key page

keyPageName string

LANDING_PAGE

Includes or excludes visitors according the URL of the landing page of the visit

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the specified url should match. Default value: 'EXACT'

Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]

url string

Landing URL template

LAST_VISIT

Includes or excludes visitors according to the time elapsed since their last visit

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

count int32

Amount of time elapsed since the last visit as indicated by 'unitOfTime'

include boolean

Indicates if visitors who meet this condition should be included to or excluded from the segment. Default value: 'true'

matchType string

Indicates how the specified amount of time should match

Possible values: [EQUAL, LOWER, GREATER]

unitOfTime string

Unit of measurements

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH]

MOUSE_OUT

The test launches when the mouse leaves the browser window

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

NEW_VISITORS

Includes or exclude new visitors or returning visitors to your website.

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

visitorsType string

Possible values: [NEW, RETURNING]

NUMBER_OF_VISITED_PAGES

Includes or excludes visitors using number of visited product pages

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

categories string[]

Product categories

countOfPages int32

Number of visited pages

countOfPagesMatchType string

Indicates how the 'countOfPages' should match

Possible values: [GREATER, EXACT, LOWER, ALL]

include boolean

Indicates if visitors who match this condition should be included in or excluded from the segment. Default value: 'true'

priceMatchType string

This field specifies how the price should be matched. It is recommended to include additional pricing parameters.

Possible values: [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]

priceParams

object

oneOf

BelongingPriceParams

Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.

areaOfPriceMatching stringrequired

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

priceCategory stringrequired

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'

productWayOfCounting stringrequired

Indicates the method to count 'value'

Possible values: [PERCENT, COUNTS]

value int32required

Indicates which fraction the product belongs

oneOf

BetweenPriceParams

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

ExactPriceParams

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

PriceChangeParams

changeDuration stringrequired

Time range when the price of the product changed

Possible values: [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES]

firstDate date-time

Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

secondDate date-time

Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

BetweenPriceParams

Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

oneOf

BelongingPriceParams

areaOfPriceMatching stringrequired

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

priceCategory stringrequired

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'

productWayOfCounting stringrequired

Indicates the method to count 'value'

Possible values: [PERCENT, COUNTS]

value int32required

Indicates which fraction the product belongs

ExactPriceParams

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

PriceChangeParams

changeDuration stringrequired

Time range when the price of the product changed

Possible values: [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES]

firstDate date-time

Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

secondDate date-time

Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

ExactPriceParams

Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

oneOf

BelongingPriceParams

areaOfPriceMatching stringrequired

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

priceCategory stringrequired

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'

productWayOfCounting stringrequired

Indicates the method to count 'value'

Possible values: [PERCENT, COUNTS]

value int32required

Indicates which fraction the product belongs

BetweenPriceParams

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

PriceChangeParams

changeDuration stringrequired

Time range when the price of the product changed

Possible values: [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES]

firstDate date-time

Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

secondDate date-time

Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

PriceChangeParams

Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.

changeDuration stringrequired

Time range when the price of the product changed

Possible values: [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES]

firstDate date-time

Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

secondDate date-time

Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

oneOf

BelongingPriceParams

areaOfPriceMatching stringrequired

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

priceCategory stringrequired

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'

productWayOfCounting stringrequired

Indicates the method to count 'value'

Possible values: [PERCENT, COUNTS]

value int32required

Indicates which fraction the product belongs

BetweenPriceParams

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

ExactPriceParams

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

OPERATING_SYSTEM

Includes or excludes visitors based on their operating system (Windows, Mac, OS, …)

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included to or excluded from the segment. Default value: 'true'

os string

Possible values: [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]

ORIGIN

Includes or excludes visitors based on the URL of the referrer website they are coming from

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who match thus condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the the specified url should match. Default value: 'EXACT'

Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]

url string

Referring website URL template

ORIGIN_TYPE

Includes or excludes visitors based on their origin

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included to or excluded from the segment. Default value: 'true'

trafficType string

Traffic type

Possible values: [SEO, SEM, AFFILIATION, EMAIL, DIRECT]

PAGE_TITLE

Includes or excludes visitors based on the displayed page title

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet the condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the specified title should match. Default value: 'EXACT'

Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]

title string

Title template

PAGE_URL

Includes or excludes visitors based on the page URL displayed

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the requested URL should match with the URL template. Default value: EXACT

Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]

url string

URL template

PAGE_VIEWS

Includes or excludes visitors that have seen a specific amount of pages

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who match this condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the the specified amount of pages should match

Possible values: [EQUAL, LOWER, GREATER]

pageCount int32

Number of page views

PREVIOUS_PAGE

Includes or excludes visitors based on the URL of the previous page

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who match this condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the specified url should match. Default value: 'EXACT'

Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]

url string

Previous page URL template

PRICE_OF_DISPLAYED_PAGE

Includes or excludes visitors using price of displayed page

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who match this condition should be included in or excluded from the segment. Default value: 'true'

priceMatchType string

This field specifies how the price should be matched. It is recommended to include additional pricing parameters.

Possible values: [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]

priceParams

object

oneOf

BelongingPriceParams

Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.

areaOfPriceMatching stringrequired

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

priceCategory stringrequired

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'

productWayOfCounting stringrequired

Indicates the method to count 'value'

Possible values: [PERCENT, COUNTS]

value int32required

Indicates which fraction the product belongs

oneOf

BetweenPriceParams

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

ExactPriceParams

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

PriceChangeParams

changeDuration stringrequired

Time range when the price of the product changed

Possible values: [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES]

firstDate date-time

Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

secondDate date-time

Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

BetweenPriceParams

Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

oneOf

BelongingPriceParams

areaOfPriceMatching stringrequired

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

priceCategory stringrequired

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'

productWayOfCounting stringrequired

Indicates the method to count 'value'

Possible values: [PERCENT, COUNTS]

value int32required

Indicates which fraction the product belongs

ExactPriceParams

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

PriceChangeParams

changeDuration stringrequired

Time range when the price of the product changed

Possible values: [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES]

firstDate date-time

Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

secondDate date-time

Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

ExactPriceParams

Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

oneOf

BelongingPriceParams

areaOfPriceMatching stringrequired

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

priceCategory stringrequired

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'

productWayOfCounting stringrequired

Indicates the method to count 'value'

Possible values: [PERCENT, COUNTS]

value int32required

Indicates which fraction the product belongs

BetweenPriceParams

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

PriceChangeParams

changeDuration stringrequired

Time range when the price of the product changed

Possible values: [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES]

firstDate date-time

Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

secondDate date-time

Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

PriceChangeParams

Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.

changeDuration stringrequired

Time range when the price of the product changed

Possible values: [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES]

firstDate date-time

Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

secondDate date-time

Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

oneOf

BelongingPriceParams

areaOfPriceMatching stringrequired

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

priceCategory stringrequired

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'

productWayOfCounting stringrequired

Indicates the method to count 'value'

Possible values: [PERCENT, COUNTS]

value int32required

Indicates which fraction the product belongs

BetweenPriceParams

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

ExactPriceParams

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

Depending on the 'priceCalculationType', this has to be the exact price value|product id|category id|custom data id

Example: 12.5

REFERRERS

Includes or excludes visitors based on the channel's origin

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet the condition should be included or excluded from the segment. Default value: 'true'

referrerIndex string

Value can be the index of a specific referrer. Or it can be 'ANY' to target visitors in the presence of any referrer

referrerName string

SAME_DAY_VISITS

Includes or excludes visitors based on the number of visits on the same day

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the specified amount of time should match. Default value: 'EQUAL'

Possible values: [EQUAL, LOWER, GREATER]

visitCount int32

Number of visits for today

SCREEN_DIMENSION

This is the resolution of the screen, which is its width x the height in pixels. Ex: 1260x800 px

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

height int32

Should be specified if 'heightMatchType' is not 'INCLUDE'

heightLowerBound int32

Should be specified if 'heightMatchType' is 'INCLUDE'

heightMatchType string

Indicates how the specified height should match

Possible values: [INCLUDE, EQUAL, LOWER, GREATER]

heightUpperBound int32

Should be specified if 'heightMatchType' is 'INCLUDE'

include boolean

Indicates if visitors who meet the condition should be included 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

Indicates how the specified width should match

Possible values: [INCLUDE, EQUAL, LOWER, GREATER]

widthUpperBound int32

Should be specified if 'widthMatchType' is 'INCLUDE'

SDK_TYPE

Includes or excludes visitors based on their sdk type and version

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

sdkType string

The type of SDK through which the visitor has been triggered

Possible values: [ANDROID, IOS, JAVA, DOTNET, NODEJS, PHP, RUBY, GO, FLUTTER, REACT, PYTHON, JAVASCRIPT]

version string

SDK language version

versionMatchType string

How the version of the SDK should match. Default value: 'EQUAL'

Possible values: [EQUAL, LOWER, GREATER]

SEGMENT

Includes or excludes visitors based on the segment

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

linkedSegmentId int64

Id of linked segment

linkedSegmentName string

Name of linked segment

SKY_STATUS

Includes or excludes visitors based on the weather of their location

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet the condition should be included or excluded from the segment. Default value: 'true'

skyStatus string

Status of the sky. Can be null if 'skyStatusGroup' is not empty

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]

skyStatusGroup string

Group of sky statuses. Each group can include multiple sky statuses. Can be null if 'skyStatus' is not empty

Possible values: [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]

TABS_ON_SITE

Includes or excludes visitors based on the number of tabs open on the website

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

matchType string

Indicates how the given number of tabs should match

Possible values: [EQUAL, LOWER, GREATER]

tabCount int32

Number of tabs opened

TARGET_EXPERIMENT

Includes visitors not participating in any tests

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

experiment int64

Id of experiment

include boolean

Indicates if visitors who match this condition should be included or excluded from the segment. Default value: 'true'

variation int64

Id of the variation being used in this experiment

variationMatchType string

Indicates how the specified variation should match. Default value: 'ANY'

Possible values: [ANY, EXACT]

TARGET_FEATURE_FLAG

Include visitors not participating in any tests

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

featureFlagId int64

Id of the targeted feature flag

include boolean

Indicates if visitors who meet this condition should be included 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

TARGET_PERSONALIZATION

Include visitors not participating in any personalization

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included or excluded from the segment. Default value: 'true'

personalization int64

Id of personalization

TEALIUM_AUDIENCE

All the audiences selected are linked by an OR in this condition. To link Tealium audiences by an AND, create a new Tealium condition, then link it to the previous one using an AND

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

audiences

object[]

List of tealium audiences

Array [

id stringrequired

Audience unique identifier

name stringrequired

Audience name

]

include boolean

Indicates if visitors who match this condition should be included in or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

All the badges selected are linked by an OR in this condition. To link Tealium badges by an AND, create a new Tealium condition and link it to the previous by an AND

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

badges

object[]

List of tealium badges

Array [

id int64required

Badge unique identifier

name stringrequired

Badge name

]

include boolean

Indicates if visitors who match this condition should be included in or excluded from the segment. Default value: 'true'

TEMPERATURE

Includes or excludes visitors exposed to average temperatures

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 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

Default value: 'CELSIUS'

Possible values: [CELSIUS, FAHRENHEIT]

temperatureMatchType string

Indicates how the specified value of temperature should match

Possible values: [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]

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'

TIME_RANGE

Includes or excludes visitors accessing the website during a specific period

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who match this condition should be included or excluded from the segment. Default value: 'true'

since date-time

Date since. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss

to date-time

Date to. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss

TIME_SINCE_PAGE_LOAD

Includes or excludes visitors according to the time elapsed since the page loaded

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

count int32

Amount of time elapsed since session became active as indicated by 'unitOfTime'

countMatchType string

Indicates how the specified amount of time should match

Possible values: [EQUAL, LOWER, GREATER]

include boolean

Indicates if visitors who match this condition should be included or excluded from the segment. Default value: 'true'

unitOfTime string

Unit of measurements that will be used to define time since a page load

Possible values: [SECOND, MINUTE, HOUR, DAY]

url string

URL template

urlMatchType string

Indicates how the requested URL and the URL template matches. Default value: EXACT

Possible values: [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

VISITED_PAGES

Includes or excludes visitors by visited product pages

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

countOfPages int32

Amount of visited pages

countOfPagesMatchType string

Indicates how the 'countOfPages' should match

Possible values: [GREATER, EXACT, LOWER, ALL]

include boolean

Indicates if visitors who match this condition should be included in or excluded from the segment. Default value: 'true'

productEans string[]

Indicates which products pages should be visited

VISITOR_CODE

Includes or excludes visitors according to the visitor code

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who match this condition should be included or excluded from the segment. Default value: 'true'

matchType string

How to match the specified visitor code. Default value: EXACT

Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]

visitorCode string

Visitor code

VISITOR_IP

Includes or excludes visitors according to their IP address

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included in or excluded from the segment. Default value: 'true'

ipLowerBound string

Lower bound of the Ip address range. If the visitor's Ip matches or is greater than the lower bound, it will be included in or excluded from the segment.If the field is filled then 'ipUpperBound' has to be filled as well

ipRanges array[]

Visitor Ip address ranges

ipUpperBound string

Upper bound of the Ip address range. If the visitor Ip matches or is less than the upper bound, it will be included in or excluded from the segment.If the field is filled then 'ipLowerBound' has to be filled as well

ips string[]

Exact visitor Ip address

VISITS

Includes or excludes visitors according to the total amount of their visits

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

include boolean

Indicates if visitors who meet this condition should be included in or excluded from the segment. Default value: 'true'

matchType string

Indicates how the number of visits should match

Possible values: [EQUAL, LOWER, GREATER]

visitCount int32

Total number of visits

VISITS_BY_PAGE

Includes or excludes visitors according to the total number of visits on the specific page

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

count int32

Amount of visits

countMatchType string

Indicates how the specified amount of visits should match

Possible values: [EQUAL, LOWER, GREATER]

include boolean

Indicates if visitors who match this condition should be included or excluded from the segment. Default value: 'true'

period string

Indicates what time period should be considered for the visits

Possible values: [VISIT, VISITOR, HOUR, DAY, MONTH]

url string

URL template

urlMatchType string

Indicates how the requested URL and the URL template matches. Default value: EXACT

Possible values: [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

YSANCE_ATTRIBUT

Includes or excludes visitors according to a ysance attribute

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 1

attribute string

Ysance attribute

include boolean

Indicates if visitors who match this condition should be included in or excluded from the segment. Default value: 'true'

value string

Attribute value

valueMatchType string

Indicates how the attribute value should match. Default value: 'EXACT'

Possible values: [EXACT, CONTAINS, NOT_CONTAIN, NOT_EXACT, START_WITH, NOT_START_WITH, END_WITH, NOT_END_WITH, REGULAR_EXPRESSION]

YSANCE_SEGMENT

Includes or excludes visitors according to ysance segments

htmlDescription string

Html readable description of the targeting condition

id int64

Unique Id

targetingType stringrequired

Targeting condition type. According to this field it's necessary to add some additional fields

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

weight int32required

Conditions of higher importance will have greater values. Default value: 1

Example: 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.

createdBy int64

Account Id of the creator of the segment

dateCreated date-time
dateModified date-time
description string
Description of the segment
Example: The segment is for new ab tests
experimentAmount int64

Number of experiments using this segment. This is an optional field that must be specified in request params.

experiments int64[]

List of experiment ids using this segment. This is an optional field that must be specified in request params.

featureFlagAmount int64

Number of feature flags being used in this goal. This is an optional field that must be specified in request params.

hasSegmentCondition boolean

Indicates whether the segment has the condition SEGMENT

id int64

Unique Id of the segment

isFavorite boolean

Indicates whether the segment has been marked as a favorite.

name stringrequired
Name of the segment
Example: My segment
personalizationAmount int64

Number of personalizations using this segment. This is an optional field that must be specified in request params.

personalizations int64[]

List of personalization ids using this segment. This is an optional field that must be specified in request params.

segmentType stringrequired

Segment type refers to the classification of segments based on their usage.

Possible values: [STANDARD, KEY_MOMENT, FEATURE_FLAG, ALL]

siteId int64required
Unique Id of the site where the segment is going to be or was created
Example: 8372
tags string[]
usedBySegmentCondition boolean

Indicates whether the segment used by condition SEGMENT is present in other segments

Example (from schema)

{
  "audienceTracking": true,
  "audienceTrackingEditable": true,
  "conditionsData": {
    "firstLevel": [
      {
        "conditions": [
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {}
        ],
        "orOperators": [
          true
        ]
      }
    ],
    "firstLevelOrOperators": [
      true
    ]
  },
  "createdBy": 0,
  "dateCreated": "2024-07-29T15:51:28.071Z",
  "dateModified": "2024-07-29T15:51:28.071Z",
  "description": "The segment is for new ab tests",
  "experimentAmount": 0,
  "experiments": [
    0
  ],
  "featureFlagAmount": 0,
  "hasSegmentCondition": true,
  "id": 0,
  "isFavorite": true,
  "name": "My segment",
  "personalizationAmount": 0,
  "personalizations": [
    0
  ],
  "segmentType": "STANDARD",
  "siteId": 8372,
  "tags": [
    "string"
  ],
  "usedBySegmentCondition": true
}

400

Bad Request

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

401

Unauthorized

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

403

Forbidden

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

404

Not Found

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

423

Locked

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

500

Internal Server Error

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

Loading...