Update condition

Update one condition in a segment

Path Parameters

• segmentId int64 required
• conditionId int64 required

application/json

Request Body required

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

  ---
• weight int32 required

  More important conditions have greater values. Default value: 1

• count int32

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

• include boolean

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

• matchType string

  Possible values: [EQUAL, LOWER, GREATER]

  How to match the specified amount of time

• unitOfTime string

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

  What unit of measurements will be used to define if sessions are active for the required duration

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

version string

Application version

versionMatchType string

Possible values: [EQUAL, LOWER, GREATER]

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

weight int32 required

More important conditions have greater values. Default value: 1

browser string

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

The type of browser visitors are using

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

Possible values: [EQUAL, LOWER, GREATER]

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

language string

Browser language code in ISO 639-1

weight int32 required

More important conditions have greater values. Default value: 1

goalId int64

Unique identifier of a goal. If the fields is not specified then visits during which an any goal was reached will be included or excluded

include boolean

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

name string

Cookie name

nameMatchType string

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

How to match the specified cookie name. Default value: 'EXACT'

value string

Cookie value

valueMatchType string

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

How to match the specified cookie value. Default value: 'EXACT'

weight int32 required

More important conditions have greater values. Default value: 1

customDataIndex string

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

include boolean

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

lowerBound int32

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

upperBound int32

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

value string

valueCustom string

Value which was retrieved by specified custom data

valueMatchType string

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

How to match the retrieved value? Depends on specified format of data retrieved by the custom data

weight int32 required

More important conditions have greater values. Default value: 1

dayPeriod string

Possible values: [DAY, NIGHT]

include boolean

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

weight int32 required

More important conditions have greater values. Default value: 1

day string

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

include boolean

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

weight int32 required

More important conditions have greater values. Default value: 1

device string

Possible values: [DESKTOP, TABLET, PHONE]

include boolean

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

weight int32 required

More important conditions have greater values. Default value: 1

elementType string

Possible values: [SINGLE, ANY_MODIFIED]

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

elementValue string

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

include boolean

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

weight int32 required

More important conditions have greater values. Default value: 1

event string

Custom event

weight int32 required

More important conditions have greater values. Default value: 1

testMatchType string

Possible values: [ALL, TEST, PERSO]

How to match the specified test,personalization or both at the same time. Default value: 'ALL'

weight int32 required

More important conditions have greater values. Default value: 1

experimentationType string

Possible values: [ALL, FEATURE_EXPERIMENT, WEB_EXPERIMENT]

How to match the specified feature experiment, web experiment or any types of experiments. Default value: 'ALL'

weight int32 required

More important conditions have greater values. Default value: 1

weight int32 required

More important conditions have greater values. Default value: 1

count int32

Count of time elapsed since the first visit according to the 'unitOfTime' field

include boolean

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

matchType string

Possible values: [EQUAL, LOWER, GREATER]

How to match the specified amount of time

unitOfTime string

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

Unit of measurements

weight int32 required

More important conditions have greater values. Default value: 1

daysRange int32

Possible values: <= 5

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

forecastDays int32

Possible values: <= 5

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

forecastMatchType string

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

How to match the specified amount of days

include boolean

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

skyStatus string

Possible values: [CLEAR_SKY, MIST, FEW_CLOUDS, SCATTERED_CLOUDS, OVERCAST_CLOUDS, DRIZZLE, RAIN, EXTREME_RAIN, THUNDERSTORM, VIOLENT_THUNDERSTORM, SNOW, HEAVY_SNOW, HAIL, BREEZE, HIGH_WIND, GALE, SAND_DUST, VOLCANIC, TORNADO, TROPICAL_STORM, HURRICANE]

Specific status of the sky. Can be null if 'skyStatusGroup' is filled

skyStatusGroup string

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

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

weight int32 required

More important conditions have greater values. Default value: 1

daysRange int32

Possible values: <= 5

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

forecastDays int32

Possible values: <= 5

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

forecastMatchType string

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

How to match the specified amount of days

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

Possible values: [CELSIUS, FAHRENHEIT]

Default value: 'CELSIUS'

temperatureMatchType string

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

How to match the specified value of temperature

upperBoundValue int32

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

value int32

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

weight int32 required

More important conditions have greater values. Default value: 1

city string

Visitor's city

country string

Visitor's country

include boolean

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

region string

Visitor's region

weight int32 required

More important conditions have greater values. Default value: 1

goalId int64

Unique identifier of a goal

include boolean

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

keyMomentId int64

Unique identifier of a key moment

lowerBound int32

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

upperBound int32

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

since string

Since time. Time format: hh:MM

to string

To time. Time format: hh:MM

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

keyWordIndex string

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

weight int32 required

More important conditions have greater values. Default value: 1

applied string

Possible values: [DOM_READY, IMMEDIATE, ASYNC]

Run js code after DOM ready or immediate? Default value: DOM_READY

include boolean

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

jsCode string

Custom JavaScript condition

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

keyPageIndex string

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

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

How to match the specified url. Default value: 'EXACT'

url string

Landing URL template

weight int32 required

More important conditions have greater values. Default value: 1

count int32

Count of time elapsed since the last visit according to the 'unitOfTime' field

include boolean

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

matchType string

Possible values: [EQUAL, LOWER, GREATER]

How to match the specified amount of time

unitOfTime string

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

Unit of measurements

weight int32 required

More important conditions have greater values. Default value: 1

weight int32 required

More important conditions have greater values. Default value: 1

visitorsType string

Possible values: [NEW, RETURNING]

weight int32 required

More important conditions have greater values. Default value: 1

categories string[]

Product categories

countOfPages int32

Amount of visited pages

countOfPagesMatchType string

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

How to match 'countOfPages'?

include boolean

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

priceMatchType string

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

How match by price? According to this field it's necessary to add some additional pricing parameters

priceParams object

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

oneOf

• BelongingPriceParams
• BetweenPriceParams
• ExactPriceParams
• PriceChangeParams

---

areaOfPriceMatching string required

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

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

priceCategory string required

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

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

productWayOfCounting string required

Possible values: [PERCENT, COUNTS]

How to count 'value'?

value int32 required

To which fraction of products the product belongs

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

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

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

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

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

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

changeDuration string required

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

Time range when the price of the product changed

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'

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

os string

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

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

How to match the specified url. Default value: 'EXACT'

url string

Referring website URL template

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

trafficType string

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

Traffic type

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

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

How to match the specified title. Default value: 'EXACT'

title string

Title template

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

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

Accordance between requested URL and URL template. Default value: EXACT

url string

URL template

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

Possible values: [EQUAL, LOWER, GREATER]

How to match the specified amount of pages

pageCount int32

Number of page views

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

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

How to match the specified url. Default value: 'EXACT'

url string

Previous page URL template

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

priceMatchType string

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

How match by price? According to this field it's necessary to add some additional pricing parameters

priceParams object

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

oneOf

• BelongingPriceParams
• BetweenPriceParams
• ExactPriceParams
• PriceChangeParams

---

areaOfPriceMatching string required

Possible values: [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]

categories string[]

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

priceCategory string required

Possible values: [EXPENSIVE, CHEAP]

productEans string[]

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

productWayOfCounting string required

Possible values: [PERCENT, COUNTS]

How to count 'value'?

value int32 required

To which fraction of products the product belongs

firstPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

firstValue string

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

secondPriceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

secondValue string

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

priceCalculationType string

Possible values: [FIXED_PRICE, CUSTOM_DATA_VALUE]

value string

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

changeDuration string required

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

Time range when the price of the product changed

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'

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

referrerIndex string

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

Possible values: [EQUAL, LOWER, GREATER]

How to match the specified amount of time. Default value: 'EQUAL'

visitCount int32

Number of visits for today

weight int32 required

More important conditions have greater values. Default value: 1

height int32

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

heightLowerBound int32

Should be specified if 'heightMatchType' is 'INCLUDE'

heightMatchType string

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

How to match the specified height

heightUpperBound int32

Should be specified if 'heightMatchType' is 'INCLUDE'

include boolean

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

width int32

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

widthLowerBound int32

Should be specified if 'widthMatchType' is 'INCLUDE'

widthMatchType string

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

How to match the specified width

widthUpperBound int32

Should be specified if 'widthMatchType' is 'INCLUDE'

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

sdkType string

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

The type of SDK through which the visitor has been triggered

version string

SDK language version

versionMatchType string

Possible values: [EQUAL, LOWER, GREATER]

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

linkedSegmentId int64

Id of linked segment

linkedSegmentName string

Name of linked segment

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

skyStatus string

Possible values: [CLEAR_SKY, MIST, FEW_CLOUDS, SCATTERED_CLOUDS, OVERCAST_CLOUDS, DRIZZLE, RAIN, EXTREME_RAIN, THUNDERSTORM, VIOLENT_THUNDERSTORM, SNOW, HEAVY_SNOW, HAIL, BREEZE, HIGH_WIND, GALE, SAND_DUST, VOLCANIC, TORNADO, TROPICAL_STORM, HURRICANE]

Specific status of the sky. Can be null if 'skyStatusGroup' is filled

skyStatusGroup string

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

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

Possible values: [EQUAL, LOWER, GREATER]

How to match the specified amount of tabs

tabCount int32

Number of tabs opened

weight int32 required

More important conditions have greater values. Default value: 1

experiment int64

Id of experiment

include boolean

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

variation int64

Id of variation which was retrieved by specified experiment

variationMatchType string

Possible values: [ANY, EXACT]

How to match the specified variation. Default value: 'ANY'

weight int32 required

More important conditions have greater values. Default value: 1

featureFlagId int64

Id of the targeted feature flag

include boolean

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

ruleId int64

Id of the rule of the targeted feature flag

variationKey string

Key of the variation of the targeted feature flag

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

personalization int64

Id of personalization

weight int32 required

More important conditions have greater values. Default value: 1

audiences object[]

List of tealium audiences

Array [

id string required

Audience unique identifier

name string required

Audience name

]

include boolean

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

weight int32 required

More important conditions have greater values. Default value: 1

badges object[]

List of tealium badges

Array [

id int64 required

Badge unique identifier

name string required

Badge name

]

include boolean

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

lowerBoundValue int32

Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'

measurement string

Possible values: [CELSIUS, FAHRENHEIT]

Default value: 'CELSIUS'

temperatureMatchType string

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

How to match the specified value of temperature

upperBoundValue int32

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

value int32

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

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

since date-time

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

to date-time

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

weight int32 required

More important conditions have greater values. Default value: 1

count int32

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

countMatchType string

Possible values: [EQUAL, LOWER, GREATER]

How to match the specified amount of time

include boolean

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

unitOfTime string

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

What unit of measurements will be used to define time since a page load

url string

URL template

urlMatchType string

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

Accordance between requested URL and URL template. Default value: EXACT

weight int32 required

More important conditions have greater values. Default value: 1

countOfPages int32

Amount of visited pages

countOfPagesMatchType string

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

How to match 'countOfPages'?

include boolean

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

productEans string[]

Pages of which products should be visited?

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

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

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

visitorCode string

Visitor code

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

ipLowerBound string

Lower bound of ip addresses range. If visitor ip match or is more than the bound it will be included in or excluded from the segment.If the field is filled then 'ipUpperBound' has to be filled too

ipRanges array[]

Visitor ip address ranges

ipUpperBound string

Upper bound of ip addresses range. If visitor ip match or is less than the bound it will included in or excluded from the segment.If the field is filled then 'ipLowerBound' has to be filled too

ips string[]

Exact visitor ip address

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

matchType string

Possible values: [EQUAL, LOWER, GREATER]

How to match the specified amount of visits

visitCount int32

Total amount of visits

weight int32 required

More important conditions have greater values. Default value: 1

count int32

Amount of visits

countMatchType string

Possible values: [EQUAL, LOWER, GREATER]

How to match the specified amount of visits

include boolean

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

period string

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

Per what period of time visits should be considered

url string

URL template

urlMatchType string

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

Accordance between requested URL and URL template. Default value: EXACT

weight int32 required

More important conditions have greater values. Default value: 1

attribute string

Ysance attribute

include boolean

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

value string

Attribute value

valueMatchType string

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

How to match the specified attribute value. Default value: 'EXACT'

weight int32 required

More important conditions have greater values. Default value: 1

include boolean

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

segments string[]

Ysance segments