Automation API Reference

Introduction

The Automation API is a REST API that allows almost every action that is possible via our standard (web-based) user interfaces to be also triggered and performed programmatically. This means that you can write your own software / code interacting with our platform, harnessing all of its features and capabilities. As an example, some of our customers took advantage of this API to implement bridges between Kameleoon and their own Git repositories, so that Kameleoon variations code can be managed directly on their usual version control system. You could also design your own dashboard and fill it with experiment results directly obtained from Kameleoon. Building custom systems operating or interfacing with Kameleoon is easy thanks to this API.

This is the reference documentation for version 0.9-beta of the Automation API. Code samples are on the right section. This API is a REST compliant API, so you can call it with any REST capable framework in any language (Java, C#, NodeJS, Python, etc). We conform to REST conventions and any developer familiar with those should feel at ease here.

Authentication

The Automation API uses the OAuth 2.0 framework to manage authorization. It's an industry-standard protocol nowadays for web applications, so a lot of developers should already be familiar with it. The most important thing to understand with OAuth 2.0 is that this framework supports several flows (or use cases).

With respect to Kameleoon, there are two flows that are relevant for the Automation API:

If you're a Kameleoon customer who intends to use the Automation API for your own purposes, you will need to use the Client credentials flow. This will allow you to control your Kameleoon account and associated web properties programmatically. For instance, you could build a bridge between your CMS (Content Management Software) and Kameleoon, automatically creating and running AB experiments based on the contents of your CMS platform.
If you're a technological partner of Kameleoon, and you intend to build an integration between your own application and Kameleoon, you will need to use the Authorization code flow. This will allow you to distribute software for users of both platforms / services (Kameleoon and your own). For instance, you would use this to access AB experiments results from Kameleoon and present them in your own application.

Client Credentials Flow

The Client Credentials Flow is the simplest flow. For this flow, you only need to obtain an access token by providing a client_id and a client_secret to an authorization end-point. You will then be able to access the Automation API by using this token as a Bearer Token present in a Authorization HTTP request header.

Obtaining an access_token


curl \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET' \
"https://api.kameleoon.com/oauth/token"

You send a POST request to the https://api.kameleoon.com/oauth/token endpoint. Your client_id and client_secret should be sent as parameters in the body.

{
    "access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJLQU1FTEVPT05fQkFDS19PRkZJQ0UiLCJzdWIiOiJtaWNrYWVsLmdAYWxsb3BuZXVzLmNvbSIsImF1ZCI6IkJBQ0tfT0ZGSUNFIiwidHlwIjoiQUNDRVNTX1RPS0VOIiwiZXhwIjoxNTc3MzY1Nzc3fQ.Ulfz_dw1zGbyRJZMZwpn5STzWCVnrbXbL2UYQ6VhFb1sN81cVHJuljl3RsIMbTLz8NwyCUfMTQLZkLBz2ChnDA"
}

The authorization server then replies with a JSON object, containing an access_token.

Using the access_token to access the API


curl \
-H "Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJLQU1FTEVPT05fQkFDS19PRkZJQ0UiLCJzdWIiOiJtaWNrYWVsLmdAYWxsb3BuZXVzLmNvbSIsImF1ZCI6IkJBQ0tfT0ZGSUNFIiwidHlwIjoiQUNDRVNTX1RPS0VOIiwiZXhwIjoxNTc3MzY1Nzc3fQ.Ulfz_dw1zGbyRJZMZwpn5STzWCVnrbXbL2UYQ6VhFb1sN81cVHJuljl3RsIMbTLz8NwyCUfMTQLZkLBz2ChnDA" \
-H "Content-Type: application/json" \
"https://api.kameleoon.com/experiments"

Using the access_token, you can make standard REST web API calls. It should be supplied in the Authorization request header to prove your identity.

The general Automation API endpoint is https://api.kameleoon.com.

Authorization Code Flow

The Authorization Code Flow is a flow adapted to partners or third party developers that need to integrate their applications with data from the Kameleoon platform. For this flow, you need to obtain permission from one of your users to access its Kameleoon account. The process will provide you with an authorization code that you need to exchange for an access token. You will then be able to access the Automation API by using this token as a Bearer Token present in a Authorization HTTP request header.

You should first ask your contact at Kameleoon to create an OAuth application in our system for you. You will need to specify a redirect URL (on your own web application). Once the application is created, you will need to know its name, which is used as the client_id value in the flow below. You will also be provided with a client_secret.

Obtaining authorization from the user

https://api.kameleoon.com/oauth/authorize?client_id=my-application-name&response_type=code&redirect_uri=https://application.company.com/ HTTP/1.1

In your web application, you need to redirect your user to the following URL. He will be asked to login to the Kameleoon platform (if he's not already logged), and will be presented with an interface asking him to grant access to his Kameleoon data / resources.

https://application.company.com/?code=AUTHORIZATION_CODE

Once your user has been authenticated and has granted permission to access their Kameleoon account, they will be redirected to your application URL with an authorization code as a query parameter.

Obtaining an access_token


curl --location --request POST 'https://api.kameleoon.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic dGVzdC1iby1hdXRob3JpemF0aW9uLWNvZGU6VzlSU3VVRmh0U01pSVNKb2VMNl9SOFhneFVKcWNWZFVuNENmdG44a0Z5WQ==' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'code=MagXU69dAxOb8Ry7UgXVTUdHSfdICaqXB-Ts86ay1L0' \
--data-urlencode 'redirect_uri=https://application.company.com/'

You can then exchange the authorization code for an access token and a refresh token. On the POST request, the value in the Authorization: Basic corresponds to the Base64 encoded value of the string client_id:client_secret (for instance my-application-name:x8er46f2gtZ). The code parameter contains the authorization code obtained in the previous step. Finally you need to provide your redirect_uri as well.

{
    "access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJLQU1FTEVPT05fQkFDS19PRkZJQ0UiLCJzdWIiOiJtaWNrYWVsLmdAYWxsb3BuZXVzLmNvbSIsImF1ZCI6IkJBQ0tfT0ZGSUNFIiwidHlwIjoiQUNDRVNTX1RPS0VOIiwiZXhwIjoxNTc3MzY1Nzc3fQ.Ulfz_dw1zGbyRJZMZwpn5STzWCVnrbXbL2UYQ6VhFb1sN81cVHJuljl3RsIMbTLz8NwyCUfMTQLZkLBz2ChnDA",
    "refresh_token": "eyJraWQiOiJrYW1lbGVvb24tZ3Jhdml0ZWUtQU0ta2V5IiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiIzMzA2MTM2MC1mMjZiLTQ2MTctODYxMy02MGYyNmIxNjE3M2QiLCJhdWQiOiJ0ZXN0LWJvLWF1dGhvcml6YXRpb24tY29kZSIsImRvbWFpbiI6ImthbWVsZW9vbiIsImlzcyI6Imh0dHA6XC9cL2FwaS5rYW1lbGVvb24uY29tXC9hbVwva2FtZWxlb29uXC9vaWRjIiwiZXhwIjoxNjIxNTMzNzE5LCJpYXQiOjE2MjE1MTkzMTksImp0aSI6IlFwWERPVmhtNDFHX1RsWDUwVUYySUZkQ1hqaDhZVnBlaW5RcjdyeEdHUUEifQ.81nlwYpaoU_Y0T-WaCcPS9kgh3nTpIVFeydhzGtJfVU"
}

The authorization server then replies with a JSON object, containing access_token and refresh_token keys.

Using the access_token to access the API


curl \
-H "Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJLQU1FTEVPT05fQkFDS19PRkZJQ0UiLCJzdWIiOiJtaWNrYWVsLmdAYWxsb3BuZXVzLmNvbSIsImF1ZCI6IkJBQ0tfT0ZGSUNFIiwidHlwIjoiQUNDRVNTX1RPS0VOIiwiZXhwIjoxNTc3MzY1Nzc3fQ.Ulfz_dw1zGbyRJZMZwpn5STzWCVnrbXbL2UYQ6VhFb1sN81cVHJuljl3RsIMbTLz8NwyCUfMTQLZkLBz2ChnDA" \
-H "Content-Type: application/json" \
"https://api.kameleoon.com/experiments"

Using the access_token, you can make standard REST web API calls. It should be supplied in the Authorization request header to prove your identity.

The general Automation API endpoint is https://api.kameleoon.com.

Obtaining a refresh_token


curl --location --request POST 'https://api.kameleoon.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic dGVzdC1iby1hdXRob3JpemF0aW9uLWNvZGU6VzlSU3VVRmh0U01pSVNKb2VMNl9SOFhneFVKcWNWZFVuNENmdG44a0Z5WQ==' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'refresh_token=eyJraWQiOiJrYW1lbGVvb24tZ3Jhdml0ZWUtQU0ta2V5IiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiIzMzA2MTM2MC1mMjZiLTQ2MTctODYxMy02MGYyNmIxNjE3M2QiLCJhdWQiOiJ0ZXN0LWJvLWF1dGhvcml6YXRpb24tY29kZSIsImRvbWFpbiI6ImthbWVsZW9vbiIsImlzcyI6Imh0dHA6XC9cL2FwaS5rYW1lbGVvb24uY29tXC9hbVwva2FtZWxlb29uXC9vaWRjIiwiZXhwIjoxNjIxNTMzNzE5LCJpYXQiOjE2MjE1MTkzMTksImp0aSI6IlFwWERPVmhtNDFHX1RsWDUwVUYySUZkQ1hqaDhZVnBlaW5RcjdyeEdHUUEifQ.81nlwYpaoU_Y0T-WaCcPS9kgh3nTpIVFeydhzGtJfVU'

Obtaining a refresh_token is done in the same way as obtaining an access_token. Follow the example on the right.

Rate Limiting

Rate limiting of the automation API is primarily on a per-user basis - or more accurately described, per user access token.

5 Minute Windows

Rate limits are divided into 5 minute intervals. All endpoints require authentication, so there is no concept of unauthenticated calls and rate limits.

Use the HTTP header in order to understand where the application is at for a given rate limit. Note that the HTTP headers are contextual. When using user-based auth, they indicate the rate limit for that user-application context.

X-Rate-Limit-Remaining: the rate limit remaining: the number of requests left for the 5 minute window

When an application exceeds the rate limit for a given standard API endpoint, the API will return a HTTP 429 “Too Many Requests” response code.

GET and POST Request Limits

Interval	HTTP Method	Number of requests
5 minute	GET	1000
1 day	GET	100000
1 day	POST	100000

Tips to avoid being Rate Limited

The tips below are there to help you code defensively and reduce the possibility of being rate limited. Some application features that you may want to provide are simply impossible in light of rate limiting, especially around the freshness of results. If real-time information is an aim of your application, look into the Data API.

Caching

Store API responses in your application or on your site if you expect a lot of use. For example, don’t try to call the Automation API on every page load of your website landing page. Instead, call the API infrequently and load the response into a local cache. When users hit your website load the cached version of the results.

HTTP status codes

Code	Status	Description
200	OK	Your request was correctly formatted and the resource you requested is returned
201	Created	Returned when a POST request was successful
400	BadRequest	Can happen if your request did not have a valid JSON body. It might help to specify a Content-Type: application/json header in your request. If you sent valid JSON, the error may also reference specific fields that were invalid
401	Unauthorized	Your API token was missing or not in the correct format
403	Forbidden	You provided an API token but it was invalid or revoked or you don't have read/write access to the entity you're trying to view/edit
5xx	Server Error	Something went wrong! Kameleoon engineers have been informed, but please don't hesitate to contact us.

API usage

Accounts

This is an object representing a Kameleoon account. You can retrieve it to see properties on the account like its current e-mail address or locale. With proper authorization your application can read and update an account and profile settings.

List of accounts

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/accounts"

GET /accounts

Get list of accounts

[ {
  "id" : "123456789",
  "username" : "string",
  "firstName" : "string",
  "lastName" : "string",
  "email" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "preferredLocale" : "en",
  "imageURL" : "string",
  "isPasswordExpired" : "false",
  "isSuperAdmin" : "false"
} ]

Response body

Account

Name	Type	Description
id	long	The unique identifier of the given account
username	string	The user name of the given account
firstName	string	The first name of the user of the given account
lastName	string	The last name of the user of the given account
email	string	The email of the given account
dateCreated	datetime	Date when the account was created
preferredLocale	enum	The used locale of the given account. Can be [en, fr, de]
imageURL	string	The image URL of the user
isPasswordExpired	boolean	Password regeneration required
isSuperAdmin	boolean

Get one account

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/accounts/{accountId}"

GET /accounts/{accountId}

Get one account with given id

Request arguments

Name	Place	Type	Description
accountId	path	long	The ID of the account object

{
  "id" : "123456789",
  "username" : "string",
  "firstName" : "string",
  "lastName" : "string",
  "email" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "preferredLocale" : "en",
  "imageURL" : "string",
  "isPasswordExpired" : "false",
  "isSuperAdmin" : "false"
}

Response body

Account

Name	Type	Description
id	long	The unique identifier of the given account
username	string	The user name of the given account
firstName	string	The first name of the user of the given account
lastName	string	The last name of the user of the given account
email	string	The email of the given account
dateCreated	datetime	Date when the account was created
preferredLocale	enum	The used locale of the given account. Can be [en, fr, de]
imageURL	string	The image URL of the user
isPasswordExpired	boolean	Password regeneration required
isSuperAdmin	boolean

Get personal account data

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/accounts/me"

GET /accounts/me

Get personal account data

{
  "id" : "123456789",
  "username" : "string",
  "firstName" : "string",
  "lastName" : "string",
  "email" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "preferredLocale" : "en",
  "imageURL" : "string",
  "isPasswordExpired" : "false",
  "isSuperAdmin" : "false"
}

Response body

Account

Name	Type	Description
id	long	The unique identifier of the given account
username	string	The user name of the given account
firstName	string	The first name of the user of the given account
lastName	string	The last name of the user of the given account
email	string	The email of the given account
dateCreated	datetime	Date when the account was created
preferredLocale	enum	The used locale of the given account. Can be [en, fr, de]
imageURL	string	The image URL of the user
isPasswordExpired	boolean	Password regeneration required
isSuperAdmin	boolean

Audiences

Audience is statistical info about how many visits, conversions and other statistics a segment has. Getting insight about audience of your site is crucial for adjusting efficient segments

Get global audience

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/audiences/global"

GET /audiences/global

Get global statistics for all tracked segments

Request arguments

Name	Place	Type	Description
siteId	query	long	Audience are calculated for segments configured in audience config for a site
startDate	query	date	Audience will be calculated since the date YYYY-MM-DD
endDate	query	date	Audience will be calculated till the date YYYY-MM-DD
isFavorite	query	boolean	Set true if you wish to get audience only for favorite segments. False by default

{
  "globalStats" : {
    "visits" : "123456789",
    "conversions" : "123456789",
    "convertedVisits" : "123456789",
    "conversionRate" : "132.987",
    "revenue" : "132.987",
    "averageRevenuePerVisit" : "132.987",
    "averageRevenuePerConversion" : "132.987",
    "averageConversionPerVisit" : "132.987",
    "startDate" : "2021-04-07",
    "endDate" : "2021-04-07",
    "visitsGapTotal" : "132.987",
    "revenueGapTotal" : "132.987",
    "averageRevenuePerConversionGapTotal" : "132.987",
    "conversionRateEvolution" : "132.987",
    "visitsEvolution" : "132.987",
    "revenueEvolution" : "132.987",
    "averageRevenuePerVisitEvolution" : "132.987",
    "averageRevenuePerConversionEvolution" : "132.987"
  },
  "segmentStats" : [ {
    "segmentInfo" : {
      "id" : "123456789",
      "name" : "string",
      "isFavorite" : "false",
      "type" : "CREATED_BY_USER",
      "dateCreated" : "2021-04-07T10:13:22.814277",
      "accountUserFirstName" : "string",
      "accountUserLastName" : "string",
      "accountUsername" : "string"
    },
    "visits" : "123456789",
    "conversions" : "123456789",
    "convertedVisits" : "123456789",
    "conversionRate" : "132.987",
    "revenue" : "132.987",
    "averageRevenuePerVisit" : "132.987",
    "averageRevenuePerConversion" : "132.987",
    "averageConversionPerVisit" : "132.987",
    "startDate" : "2021-04-07",
    "endDate" : "2021-04-07",
    "conversionRateEvolution" : "132.987",
    "visitsEvolution" : "132.987",
    "revenueEvolution" : "132.987",
    "averageRevenuePerVisitEvolution" : "132.987",
    "averageRevenuePerConversionEvolution" : "132.987",
    "visitsGapTotal" : "132.987",
    "revenueGapTotal" : "132.987",
    "averageRevenuePerConversionGapTotal" : "132.987"
  } ]
}

Response body

GlobalAudience

Name	Type	Description
globalStats	GlobalStats	Summed up calculations for all tracked segments
segmentStats	array[SegmentStats]	Calculations per every segment

GlobalStats

Name	Type	Description
visits	long	Amount of tracked visits
conversions	long	Amount of tracked conversions
convertedVisits	long	Amount of tracked converted visits
conversionRate	double	How often visits are being converted. It's being calculated as `convertedVisits`/`visits`
revenue	double	Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = `conversions` * the default revenue
averageRevenuePerVisit	double	`revenue`/`visits`
averageRevenuePerConversion	double	`revenue`/`conversions`
averageConversionPerVisit	double	`conversions`/`visits`
startDate	date	The start of the period for which statistics are calculated. YYYY-MM-DD
endDate	date	The end of the period for which statistics are calculated. YYYY-MM-DD
visitsGapTotal	double	Percentage of the current number of visits to the total one
revenueGapTotal	double	Percentage of the current revenue to the total one
averageRevenuePerConversionGapTotal	double	Percentage of the current average revenue per conversion to the total one
conversionRateEvolution	double	How much conversion rate for current period changed according to previous period in percents
visitsEvolution	double	How much amount of visits for current period changed according to previous period in percents
revenueEvolution	double	How much amount of revenue for current period changed according to previous period in percents
averageRevenuePerVisitEvolution	double	How much revenue per visit for current period changed according to previous period in percents
averageRevenuePerConversionEvolution	double	How much revenue per conversion for current period changed according to previous period in percents

TargetingSegmentInfo

Name	Type	Description
id	long	Identifier of the segment for which the stats was tracked
name	string	Name of the segment for which the stats was tracked
isFavorite	boolean	True if the segment is marked as favorite
type	enum	. Can be [CREATED_BY_USER, PREDEFINED_SEGMENT]
dateCreated	datetime	When the segment was created
accountUserFirstName	string	First name of the user who created the segment
accountUserLastName	string	Last name of the user who created the segment
accountUsername	string	Username of the user who created the segment

SegmentStats

Name	Type	Description
segmentInfo	TargetingSegmentInfo	Information about segment origin
visits	long	Amount of tracked visits
conversions	long	Amount of tracked conversions
convertedVisits	long	Amount of tracked converted visits
conversionRate	double	How often visits are being converted. It's being calculated as `convertedVisits`/`visits`
revenue	double	Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = `conversions` * the default revenue
averageRevenuePerVisit	double	`revenue`/`visits`
averageRevenuePerConversion	double	`revenue`/`conversions`
averageConversionPerVisit	double	`conversions`/`visits`
startDate	date	The start of the period for which statistics are calculated. YYYY-MM-DD
endDate	date	The end of the period for which statistics are calculated. YYYY-MM-DD
conversionRateEvolution	double	How much conversion rate for current period changed according to previous period in percents
visitsEvolution	double	How much amount of visits for current period changed according to previous period in percents
revenueEvolution	double	How much amount of revenue for current period changed according to previous period in percents
averageRevenuePerVisitEvolution	double	How much revenue per visit for current period changed according to previous period in percents
averageRevenuePerConversionEvolution	double	How much revenue per conversion for current period changed according to previous period in percents
visitsGapTotal	double	Percentage of the current number of visits to the total one
revenueGapTotal	double	Percentage of the current revenue to the total one
averageRevenuePerConversionGapTotal	double	Percentage of the current average revenue per conversion to the total one

Get detailed audience

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/audiences/detailed"

GET /audiences/detailed

Get detailed statistics for one segment

Request arguments

Name	Place	Type	Description
siteId	query	long	Site on which audience is configured
segmentId	query	long	Segment for which you wish to get statistics
startDate	query	date	Audience will be calculated since the date YYYY-MM-DD
endDate	query	date	Audience will be calculated till the date YYYY-MM-DD

{
  "globalStats" : {
    "visits" : "123456789",
    "conversions" : "123456789",
    "convertedVisits" : "123456789",
    "conversionRate" : "132.987",
    "revenue" : "132.987",
    "averageRevenuePerVisit" : "132.987",
    "averageRevenuePerConversion" : "132.987",
    "averageConversionPerVisit" : "132.987",
    "startDate" : "2021-04-07",
    "endDate" : "2021-04-07",
    "visitsGapTotal" : "132.987",
    "revenueGapTotal" : "132.987",
    "averageRevenuePerConversionGapTotal" : "132.987",
    "conversionRateEvolution" : "132.987",
    "visitsEvolution" : "132.987",
    "revenueEvolution" : "132.987",
    "averageRevenuePerVisitEvolution" : "132.987",
    "averageRevenuePerConversionEvolution" : "132.987"
  },
  "segmentStats" : {
    "segmentInfo" : {
      "id" : "123456789",
      "name" : "string",
      "isFavorite" : "false",
      "type" : "CREATED_BY_USER",
      "dateCreated" : "2021-04-07T10:13:22.814277",
      "accountUserFirstName" : "string",
      "accountUserLastName" : "string",
      "accountUsername" : "string"
    },
    "visits" : "123456789",
    "conversions" : "123456789",
    "convertedVisits" : "123456789",
    "conversionRate" : "132.987",
    "revenue" : "132.987",
    "averageRevenuePerVisit" : "132.987",
    "averageRevenuePerConversion" : "132.987",
    "averageConversionPerVisit" : "132.987",
    "startDate" : "2021-04-07",
    "endDate" : "2021-04-07",
    "conversionRateEvolution" : "132.987",
    "visitsEvolution" : "132.987",
    "revenueEvolution" : "132.987",
    "averageRevenuePerVisitEvolution" : "132.987",
    "averageRevenuePerConversionEvolution" : "132.987",
    "visitsGapTotal" : "132.987",
    "revenueGapTotal" : "132.987",
    "averageRevenuePerConversionGapTotal" : "132.987"
  },
  "periodStats" : [ {
    "visits" : "123456789",
    "conversions" : "123456789",
    "convertedVisits" : "123456789",
    "conversionRate" : "132.987",
    "revenue" : "132.987",
    "averageRevenuePerVisit" : "132.987",
    "averageRevenuePerConversion" : "132.987",
    "averageConversionPerVisit" : "132.987",
    "startDate" : "2021-04-07",
    "endDate" : "2021-04-07"
  } ],
  "breakdownStats" : ""
}

Response body

DetailedAudience

Name	Type	Description
globalStats	GlobalStats	Summed up calculations for all tracked segments
segmentStats	SegmentStats	Calculations for the requested segment summed up by the whole picked period
periodStats	array[PeriodStats]	Calculations separated by day interval
breakdownStats	map	Calculations separated by breakdowns

GlobalStats

Name	Type	Description
visits	long	Amount of tracked visits
conversions	long	Amount of tracked conversions
convertedVisits	long	Amount of tracked converted visits
conversionRate	double	How often visits are being converted. It's being calculated as `convertedVisits`/`visits`
revenue	double	Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = `conversions` * the default revenue
averageRevenuePerVisit	double	`revenue`/`visits`
averageRevenuePerConversion	double	`revenue`/`conversions`
averageConversionPerVisit	double	`conversions`/`visits`
startDate	date	The start of the period for which statistics are calculated. YYYY-MM-DD
endDate	date	The end of the period for which statistics are calculated. YYYY-MM-DD
visitsGapTotal	double	Percentage of the current number of visits to the total one
revenueGapTotal	double	Percentage of the current revenue to the total one
averageRevenuePerConversionGapTotal	double	Percentage of the current average revenue per conversion to the total one
conversionRateEvolution	double	How much conversion rate for current period changed according to previous period in percents
visitsEvolution	double	How much amount of visits for current period changed according to previous period in percents
revenueEvolution	double	How much amount of revenue for current period changed according to previous period in percents
averageRevenuePerVisitEvolution	double	How much revenue per visit for current period changed according to previous period in percents
averageRevenuePerConversionEvolution	double	How much revenue per conversion for current period changed according to previous period in percents

TargetingSegmentInfo

Name	Type	Description
id	long	Identifier of the segment for which the stats was tracked
name	string	Name of the segment for which the stats was tracked
isFavorite	boolean	True if the segment is marked as favorite
type	enum	. Can be [CREATED_BY_USER, PREDEFINED_SEGMENT]
dateCreated	datetime	When the segment was created
accountUserFirstName	string	First name of the user who created the segment
accountUserLastName	string	Last name of the user who created the segment
accountUsername	string	Username of the user who created the segment

PeriodStats

Name	Type	Description
visits	long	Amount of tracked visits
conversions	long	Amount of tracked conversions
convertedVisits	long	Amount of tracked converted visits
conversionRate	double	How often visits are being converted. It's being calculated as `convertedVisits`/`visits`
revenue	double	Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = `conversions` * the default revenue
averageRevenuePerVisit	double	`revenue`/`visits`
averageRevenuePerConversion	double	`revenue`/`conversions`
averageConversionPerVisit	double	`conversions`/`visits`
startDate	date	The start of the period for which statistics are calculated. YYYY-MM-DD
endDate	date	The end of the period for which statistics are calculated. YYYY-MM-DD

SegmentStats

Name	Type	Description
segmentInfo	TargetingSegmentInfo	Information about segment origin
visits	long	Amount of tracked visits
conversions	long	Amount of tracked conversions
convertedVisits	long	Amount of tracked converted visits
conversionRate	double	How often visits are being converted. It's being calculated as `convertedVisits`/`visits`
revenue	double	Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = `conversions` * the default revenue
averageRevenuePerVisit	double	`revenue`/`visits`
averageRevenuePerConversion	double	`revenue`/`conversions`
averageConversionPerVisit	double	`conversions`/`visits`
startDate	date	The start of the period for which statistics are calculated. YYYY-MM-DD
endDate	date	The end of the period for which statistics are calculated. YYYY-MM-DD
conversionRateEvolution	double	How much conversion rate for current period changed according to previous period in percents
visitsEvolution	double	How much amount of visits for current period changed according to previous period in percents
revenueEvolution	double	How much amount of revenue for current period changed according to previous period in percents
averageRevenuePerVisitEvolution	double	How much revenue per visit for current period changed according to previous period in percents
averageRevenuePerConversionEvolution	double	How much revenue per conversion for current period changed according to previous period in percents
visitsGapTotal	double	Percentage of the current number of visits to the total one
revenueGapTotal	double	Percentage of the current revenue to the total one
averageRevenuePerConversionGapTotal	double	Percentage of the current average revenue per conversion to the total one

Custom datas

Custom data is an advanced tool that lets you target your customers in a unique way according to data already available, such as user account information.

Partial update custom data

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/custom-datas/{customDataId}"
{
  "name" : "string",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string"
}

PATCH /custom-datas/{customDataId}

Update several fields of custom data

Request arguments

Name	Place	Type	Description
customDataId	path	long	The ID of the custom data object

Request body

CustomDataUpdate

Name	Type	Description
name	string	The name for the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record

{
  "id" : "123456789",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "name" : "string",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

CustomData

Name	Type	Description
id	long	The unique identifier of the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
name	string	The name for the given custom data
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record
creationDate	datetime	Date and time a record is created
modificationDate	datetime	Date and time a record is modified
siteId	long	Unique site identifier assigned with the record

Remove custom data

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/custom-datas/{customDataId}"

DELETE /custom-datas/{customDataId}

Remove custom data with given id

Request arguments

Name	Place	Type	Description
customDataId	path	long	The ID of the custom data object

Get one custom data

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/custom-datas/{customDataId}"

GET /custom-datas/{customDataId}

Get one custom data with the given id

Request arguments

Name	Place	Type	Description
customDataId	path	long	The ID of the custom data object

{
  "id" : "123456789",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "name" : "string",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

CustomData

Name	Type	Description
id	long	The unique identifier of the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
name	string	The name for the given custom data
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record
creationDate	datetime	Date and time a record is created
modificationDate	datetime	Date and time a record is modified
siteId	long	Unique site identifier assigned with the record

Update custom data

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/custom-datas/{customDataId}"
{
  "id" : "123456789",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "name" : "string",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

PUT /custom-datas/{customDataId}

Update custom data with given id

Request arguments

Name	Place	Type	Description
customDataId	path	long	The ID of the custom data object

Request body

CustomData

Name	Type	Description
id `*read only`	long	The unique identifier of the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
name	string	The name for the given custom data
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record
creationDate `*read only`	datetime	Date and time a record is created
modificationDate `*read only`	datetime	Date and time a record is modified
siteId	long	Unique site identifier assigned with the record

{
  "id" : "123456789",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "name" : "string",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

CustomData

Name	Type	Description
id	long	The unique identifier of the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
name	string	The name for the given custom data
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record
creationDate	datetime	Date and time a record is created
modificationDate	datetime	Date and time a record is modified
siteId	long	Unique site identifier assigned with the record

Create a new custom data

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/custom-datas"
{
  "id" : "123456789",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "name" : "string",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

POST /custom-datas

Create new custom data with given parameters

Request body

CustomData

Name	Type	Description
id `*read only`	long	The unique identifier of the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
name	string	The name for the given custom data
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record
creationDate `*read only`	datetime	Date and time a record is created
modificationDate `*read only`	datetime	Date and time a record is modified
siteId	long	Unique site identifier assigned with the record

{
  "id" : "123456789",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "name" : "string",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

CustomData

Name	Type	Description
id	long	The unique identifier of the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
name	string	The name for the given custom data
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record
creationDate	datetime	Date and time a record is created
modificationDate	datetime	Date and time a record is modified
siteId	long	Unique site identifier assigned with the record

List custom data

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/custom-datas"

GET /custom-datas

Get the list of all custom data

[ {
  "id" : "123456789",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "name" : "string",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
} ]

Response body

CustomData

Name	Type	Description
id	long	The unique identifier of the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
name	string	The name for the given custom data
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record
creationDate	datetime	Date and time a record is created
modificationDate	datetime	Date and time a record is modified
siteId	long	Unique site identifier assigned with the record

Customers

When you first sign up with Kameleoon, you have just one account and customer, your main account. But you can also create more accounts. Customer object represents basic information that were used to set up your customer account.

Get one customer

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/customers/{customerId}"

GET /customers/{customerId}

Get one customer with given id

Request arguments

Name	Place	Type	Description
customerId	path	long	The unique identifier of the given customer

{
  "id" : "123456789",
  "name" : "string",
  "status" : "ACTIVE",
  "level" : "FREE",
  "country" : "FRANCE",
  "timeZone" : "string",
  "products" : [ "ABTESTING" ],
  "passwordExpirationPolicy" : "2021-04-07T10:13:22.814277",
  "dateCreated" : "2021-04-07T10:13:22.814277"
}

Response body

Customer

Name	Type	Description
id	long	The unique identifier of the given customer
name	string	The name of the given customer
status	enum	The current status of the given customer. Can be [ACTIVE, SUBSCRIBED_AUDIENCE_EXCEEDED, QUOTA_RESET, UNSUBSCRIBED_ENTREPRISE_PLAN]
level	enum	The plan of the given customer. Can be [FREE, PREMIUM, FREEMIUM, BRONZE, SILVER, GOLD, PLATINUM, ENTERPRISE, CUSTOM]
country	enum	The country of the given customer. Can be [FRANCE, RUSSIA, GERMANY, UNITED_KINGDOM, UNITED_STATES, OTHER]
timeZone	string	The default time zone of the given customer
products	array	The available modules of the given customer. Can be [ABTESTING, PERSONALIZATION, PREDICTIVE, AUDIENCE_DISCOVERY, INTERESTS, PRODUCT, WIDGET_TEMPLATE]
passwordExpirationPolicy	datetime	The number of days before password expires
dateCreated	datetime	Date when the customer was created

Get personal customer data

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/customers/me"

GET /customers/me

Get personal customer data

{
  "id" : "123456789",
  "name" : "string",
  "status" : "ACTIVE",
  "level" : "FREE",
  "country" : "FRANCE",
  "timeZone" : "string",
  "products" : [ "ABTESTING" ],
  "passwordExpirationPolicy" : "2021-04-07T10:13:22.814277",
  "dateCreated" : "2021-04-07T10:13:22.814277"
}

Response body

Customer

Name	Type	Description
id	long	The unique identifier of the given customer
name	string	The name of the given customer
status	enum	The current status of the given customer. Can be [ACTIVE, SUBSCRIBED_AUDIENCE_EXCEEDED, QUOTA_RESET, UNSUBSCRIBED_ENTREPRISE_PLAN]
level	enum	The plan of the given customer. Can be [FREE, PREMIUM, FREEMIUM, BRONZE, SILVER, GOLD, PLATINUM, ENTERPRISE, CUSTOM]
country	enum	The country of the given customer. Can be [FRANCE, RUSSIA, GERMANY, UNITED_KINGDOM, UNITED_STATES, OTHER]
timeZone	string	The default time zone of the given customer
products	array	The available modules of the given customer. Can be [ABTESTING, PERSONALIZATION, PREDICTIVE, AUDIENCE_DISCOVERY, INTERESTS, PRODUCT, WIDGET_TEMPLATE]
passwordExpirationPolicy	datetime	The number of days before password expires
dateCreated	datetime	Date when the customer was created

Experiments

Experiment is an A/B test which can be targeted to a specific audience or everyone. Kameleoon has several types of experiments: Classic, Multivariate test (MVT), Server-side and the one that suits the best can be used to achieve the best results.

Create a new experiment

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/experiments"
{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "baseURL" : "string",
  "type" : "CLASSIC",
  "description" : "string",
  "tags" : [ "[]" ],
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "goals" : [ "[]" ],
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "autoOptimized" : "false",
  "deviations" : "",
  "respoolTime" : "",
  "targetingConfiguration" : "SITE",
  "variationsId" : [ "[]" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "isArchived" : "false",
  "createdBy" : "123456789",
  "commonCssCode" : "string",
  "commonJavaScriptCode" : "string"
}

POST /experiments

Create a new experiment with the given parameters

Request body

Experiment

Name	Type	Description
id `*read only`	long	This field is generated by the system to uniquely identify an experiment
siteId `*required`	long	The website id that an experiment belongs to
name `*required`	string	The name of the experiment
baseURL	string
type	enum	. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
description	string
tags	array
trackingTools	array[TrackingTool]
status `*read only`	string	The status of the given experiment
dateCreated `*read only`	datetime
goals	array
targetingSegmentId	long
mainGoalId	long
autoOptimized	boolean
deviations	map	Traffic allocation per variation. Key can be 'origin'(for original page) or variation id. Value is percent of traffic which will be routed to the variation. Values has to be double numbers in range from 0(0%) to 1(100%).
respoolTime	map
targetingConfiguration	enum	. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
variationsId	array	List of associated variations id for this experiment
dateModified `*read only`	datetime
dateStarted `*read only`	datetime
dateStatusModified `*read only`	datetime
isArchived `*read only`	boolean
createdBy `*read only`	long	Account id to whom created this experiment
commonCssCode	string	CSS code specific to all variations
commonJavaScriptCode	string	JavaScript code specific to all variations

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "baseURL" : "string",
  "type" : "CLASSIC",
  "description" : "string",
  "tags" : [ "[]" ],
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "goals" : [ "[]" ],
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "autoOptimized" : "false",
  "deviations" : "",
  "respoolTime" : "",
  "targetingConfiguration" : "SITE",
  "variationsId" : [ "[]" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "isArchived" : "false",
  "createdBy" : "123456789",
  "commonCssCode" : "string",
  "commonJavaScriptCode" : "string"
}

Response body

Experiment

Name	Type	Description
id	long	This field is generated by the system to uniquely identify an experiment
siteId	long	The website id that an experiment belongs to
name	string	The name of the experiment
baseURL	string
type	enum	. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
description	string
tags	array
trackingTools	array[TrackingTool]
status	string	The status of the given experiment
dateCreated	datetime
goals	array
targetingSegmentId	long
mainGoalId	long
autoOptimized	boolean
deviations	map	Traffic allocation per variation. Key can be 'origin'(for original page) or variation id. Value is percent of traffic which will be routed to the variation. Values has to be double numbers in range from 0(0%) to 1(100%).
respoolTime	map
targetingConfiguration	enum	. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
variationsId	array	List of associated variations id for this experiment
dateModified	datetime
dateStarted	datetime
dateStatusModified	datetime
isArchived	boolean
createdBy	long	Account id to whom created this experiment
commonCssCode	string	CSS code specific to all variations
commonJavaScriptCode	string	JavaScript code specific to all variations

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

List experiments

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/experiments"

GET /experiments

Get the list of all experiments

Request arguments

Name	Place	Type	Description
optionalFields	query	array	optionalFields

[ {
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "baseURL" : "string",
  "type" : "CLASSIC",
  "description" : "string",
  "tags" : [ "[]" ],
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "goals" : [ "[]" ],
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "autoOptimized" : "false",
  "deviations" : "",
  "respoolTime" : "",
  "targetingConfiguration" : "SITE",
  "variationsId" : [ "[]" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "isArchived" : "false",
  "createdBy" : "123456789",
  "commonCssCode" : "string",
  "commonJavaScriptCode" : "string"
} ]

Response body

Experiment

Name	Type	Description
id	long	This field is generated by the system to uniquely identify an experiment
siteId	long	The website id that an experiment belongs to
name	string	The name of the experiment
baseURL	string
type	enum	. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
description	string
tags	array
trackingTools	array[TrackingTool]
status	string	The status of the given experiment
dateCreated	datetime
goals	array
targetingSegmentId	long
mainGoalId	long
autoOptimized	boolean
deviations	map	Traffic allocation per variation. Key can be 'origin'(for original page) or variation id. Value is percent of traffic which will be routed to the variation. Values has to be double numbers in range from 0(0%) to 1(100%).
respoolTime	map
targetingConfiguration	enum	. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
variationsId	array	List of associated variations id for this experiment
dateModified	datetime
dateStarted	datetime
dateStatusModified	datetime
isArchived	boolean
createdBy	long	Account id to whom created this experiment
commonCssCode	string	CSS code specific to all variations
commonJavaScriptCode	string	JavaScript code specific to all variations

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

Request experiment's results

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/experiments/{experimentId}/results"
{
  "interval" : "HOUR",
  "visitorData" : "false",
  "allVariationsData" : "false",
  "bayesian" : "false",
  "breakdown" : {
    "type" : "BROWSER"
  },
  "goalsIds" : [ "[]" ],
  "filters" : [ {
    "type" : "string"
  } ],
  "dateIntervals" : [ {
    "start" : "2021-04-07T10:13:22.814277",
    "end" : "2021-04-07T10:13:22.814277"
  } ],
  "callbackUrl" : "string",
  "stringForHash" : "string"
}

POST /experiments/{experimentId}/results

Send a request to generate the report for the results of the given experiment

Request arguments

Name	Place	Type	Description
experimentId	path	long	experimentId

Request body

DataRequestParams

Name	Type	Description
interval	enum	. Can be [HOUR, DAY, WEEK, MONTH, YEAR]
visitorData	boolean
allVariationsData	boolean
bayesian	boolean
breakdown	Breakdown
goalsIds	array
filters	array[Filter]
dateIntervals	array[DateInterval]
callbackUrl	string
stringForHash	string

Filter

Name	Type	Description
type `*required`	string

Breakdown

Name	Type	Description
type	enum	. Can be [BROWSER, CUSTOM_DATUM, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OS, PAGE_TITLE, NUMBER_PAGES, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, DAYS_OF_WEEK, VISIT_DURATION, WEATHER_CODE, DAY, TEMPERATURE, NUMBER_VISITS, FIRST_REFERRER_URL, MAX_NUMBER_TABS, KEY_PAGE, INTEREST, TARGETING_SEGMENT, TIME_SINCE_PREVIOUS_VISIT, KEYWORD, YSANCE_SEGMENT, YSANCE_ATTRIBUTE, COUNTRY, REGION, CITY, LANGUAGE, JAVA_ENABLED, LANDING_PAGE, TIME_ZONE_GROUP, SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_RESOLUTION, REFERRER, TIME_ZONE_ID, LOCALE_LANGUAGE_CODE, LOCALE_COUNTRY_CODE, LOCALE_LANGUAGE_TAG, PERSONALIZATION_UNEXPOSITION_CAUSE]

DateInterval

Name	Type	Description
start	datetime
end	datetime

DeviceTypeFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [DESKTOP, TABLET, PHONE]
include	boolean

TimeSpentFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

PageURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

AdBlockerFilter

Name	Type	Description
type	string
include	boolean

WeatherFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, ATMOSPHERIC_DISTURBANCES]
include	boolean

KeyPageFilter

Name	Type	Description
type	string
include	boolean
values	array

NumberTabsFilter

Name	Type	Description
type	string
include	boolean
value `*required`	integer

CustomDataFilter

Name	Type	Description
type	string
include	boolean
customDataId `*required`	long
value	string

TimeSlotFilter

Name	Type	Description
type	string
include	boolean
visitorCalendar	boolean
values	array

TargetingSegmentFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NewVisitorFilter

Name	Type	Description
type	string
visitorsType	enum	. Can be [NEW_VISITORS, RETURNING_VISITORS]

FilterContainer

Name	Type	Description
param	enum	. Can be [GREATER, LOWER, EQUAL, BETWEEN]
value	integer
unit	enum	. Can be [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

PageTitleFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

BrowserFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [CHROME, EXPLORER, FIREFOX, SAFARI, OPERA]
include	boolean

FirstReferrerFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NumberVisitsFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

LandingPageURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NumberPagesFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

TemperatureFilter

Name	Type	Description
type	string
include	boolean
param `*required`	enum	. Can be [GREATER, LOWER, EQUAL, BETWEEN]
from `*required`	integer
to	integer

BrowserLanguageFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [AB, AA, AF, AK, SQ, AM, AR, AN, HY, AS, AV, AE, AY, AZ, BM, BA, EU, BE, BN, BH, BI, BS, BR, BG, MY, CA, CH, CE, NY, ZH, CV, KW, CO, CR, HR, CS, DA, DV, NL, DZ, EN, EO, ET, EE, FO, FJ, FI, FR, FF, GL, KA, DE, EL, GN, GU, HT, HA, HE, HZ, HI, HO, HU, IA, ID, IE, GA, IG, IK, IO, IS, IT, IU, JA, JV, KL, KN, KR, KS, KK, KM, KI, RW, KY, KV, KG, KO, KU, KJ, LA, LB, LG, LI, LN, LO, LT, LU, LV, GV, MK, MG, MS, ML, MT, MI, MR, MH, MN, NA, NV, ND, NE, NG, NB, NN, NO, II, NR, OC, OJ, CU, OM, OR, OS, PA, PI, FA, PL, PS, PT, QU, RM, RN, RO, RU, SA, SC, SD, SE, SM, SG, SR, GD, SN, SI, SK, SL, SO, ST, ES, SU, SW, SS, SV, TA, TE, TG, TH, TI, BO, TK, TL, TN, TO, TR, TS, TT, TW, TY, UG, UK, UR, UZ, VE, VI, VO, WA, CY, WO, FY, XH, YI, YO, ZA, ZU]
include	boolean

DayFilter

Name	Type	Description
type	string
include	boolean

OperatingSystemFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [WINDOWS, MAC_OS, I_OS, LINUX, ANDROID, WINDOWS_PHONE]
include	boolean

ReferrerURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

SinceLastVisitFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

TrafficFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [SEO, DIRECT, SEM, EMAIL, AFFILIATION]
include	boolean

ConversionsFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

WeekdayFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
include	boolean
visitorCalendar	boolean

CustomDatumBreakdown

Name	Type	Description
type	enum	. Can be [BROWSER, CUSTOM_DATUM, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OS, PAGE_TITLE, NUMBER_PAGES, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, DAYS_OF_WEEK, VISIT_DURATION, WEATHER_CODE, DAY, TEMPERATURE, NUMBER_VISITS, FIRST_REFERRER_URL, MAX_NUMBER_TABS, KEY_PAGE, INTEREST, TARGETING_SEGMENT, TIME_SINCE_PREVIOUS_VISIT, KEYWORD, YSANCE_SEGMENT, YSANCE_ATTRIBUTE, COUNTRY, REGION, CITY, LANGUAGE, JAVA_ENABLED, LANDING_PAGE, TIME_ZONE_GROUP, SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_RESOLUTION, REFERRER, TIME_ZONE_ID, LOCALE_LANGUAGE_CODE, LOCALE_COUNTRY_CODE, LOCALE_LANGUAGE_TAG, PERSONALIZATION_UNEXPOSITION_CAUSE]
index `*required`	integer

{
  "dataCode" : "string"
}

Response body

DataCodeResponseIO

Name	Type	Description
dataCode	string

Duplicate an experiment

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/experiments/{experimentId}/clone"

POST /experiments/{experimentId}/clone

Duplicate an experiment

Request arguments

Name	Place	Type	Description
experimentId	path	long	experimentId

{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "baseURL" : "string",
  "type" : "CLASSIC",
  "description" : "string",
  "tags" : [ "[]" ],
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "goals" : [ "[]" ],
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "autoOptimized" : "false",
  "deviations" : "",
  "respoolTime" : "",
  "targetingConfiguration" : "SITE",
  "variationsId" : [ "[]" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "isArchived" : "false",
  "createdBy" : "123456789",
  "commonCssCode" : "string",
  "commonJavaScriptCode" : "string"
}

Response body

Experiment

Name	Type	Description
id	long	This field is generated by the system to uniquely identify an experiment
siteId	long	The website id that an experiment belongs to
name	string	The name of the experiment
baseURL	string
type	enum	. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
description	string
tags	array
trackingTools	array[TrackingTool]
status	string	The status of the given experiment
dateCreated	datetime
goals	array
targetingSegmentId	long
mainGoalId	long
autoOptimized	boolean
deviations	map	Traffic allocation per variation. Key can be 'origin'(for original page) or variation id. Value is percent of traffic which will be routed to the variation. Values has to be double numbers in range from 0(0%) to 1(100%).
respoolTime	map
targetingConfiguration	enum	. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
variationsId	array	List of associated variations id for this experiment
dateModified	datetime
dateStarted	datetime
dateStatusModified	datetime
isArchived	boolean
createdBy	long	Account id to whom created this experiment
commonCssCode	string	CSS code specific to all variations
commonJavaScriptCode	string	JavaScript code specific to all variations

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

Partial update an experiment

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/experiments/{experimentId}"
{
  "name" : "string",
  "baseURL" : "string",
  "description" : "string",
  "tags" : [ "[]" ],
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "mainGoalId" : "123456789",
  "goals" : [ "[]" ],
  "targetingSegmentId" : "123456789",
  "autoOptimized" : "false",
  "deviations" : "",
  "respoolTime" : "",
  "targetingConfiguration" : "SITE",
  "featureFlagSdkLanguageType" : "ANDROID",
  "identificationKey" : "string",
  "commonCssCode" : "string",
  "commonJavaScriptCode" : "string"
}

PATCH /experiments/{experimentId}

Update several fields of an experiment

Request arguments

Name	Place	Type	Description
experimentId	path	long	experimentId
action	query	string	Action to change the status of experiment

Request body

ExperimentUpdate

Name	Type	Description
name	string	The name of the experiment
baseURL	string
description	string
tags	array
trackingTools	array[TrackingTool]
mainGoalId	long	The main goal id of the experiment
goals	array
targetingSegmentId	long
autoOptimized	boolean
deviations	map	Traffic allocation per variation. Key can be 'origin'(for original page) or variation id. Value is percent of traffic which will be routed to the variation. Values has to be double numbers in range from 0(0%) to 1(100%).
respoolTime	map
targetingConfiguration	enum	. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
featureFlagSdkLanguageType	enum	. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
identificationKey	string
commonCssCode	string	CSS code specific to all variations
commonJavaScriptCode	string	JavaScript code specific to all variations

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "baseURL" : "string",
  "type" : "CLASSIC",
  "description" : "string",
  "tags" : [ "[]" ],
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "goals" : [ "[]" ],
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "autoOptimized" : "false",
  "deviations" : "",
  "respoolTime" : "",
  "targetingConfiguration" : "SITE",
  "variationsId" : [ "[]" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "isArchived" : "false",
  "createdBy" : "123456789",
  "commonCssCode" : "string",
  "commonJavaScriptCode" : "string"
}

Response body

Experiment

Name	Type	Description
id	long	This field is generated by the system to uniquely identify an experiment
siteId	long	The website id that an experiment belongs to
name	string	The name of the experiment
baseURL	string
type	enum	. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
description	string
tags	array
trackingTools	array[TrackingTool]
status	string	The status of the given experiment
dateCreated	datetime
goals	array
targetingSegmentId	long
mainGoalId	long
autoOptimized	boolean
deviations	map	Traffic allocation per variation. Key can be 'origin'(for original page) or variation id. Value is percent of traffic which will be routed to the variation. Values has to be double numbers in range from 0(0%) to 1(100%).
respoolTime	map
targetingConfiguration	enum	. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
variationsId	array	List of associated variations id for this experiment
dateModified	datetime
dateStarted	datetime
dateStatusModified	datetime
isArchived	boolean
createdBy	long	Account id to whom created this experiment
commonCssCode	string	CSS code specific to all variations
commonJavaScriptCode	string	JavaScript code specific to all variations

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

Remove an experiment

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/experiments/{experimentId}"

DELETE /experiments/{experimentId}

Remove experiment with given id

Request arguments

Name	Place	Type	Description
experimentId	path	long	experimentId

Get one experiment

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/experiments/{experimentId}"

GET /experiments/{experimentId}

Get one experiment with given id

Request arguments

Name	Place	Type	Description
experimentId	path	long	experimentId
optionalFields	query	array	optionalFields

{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "baseURL" : "string",
  "type" : "CLASSIC",
  "description" : "string",
  "tags" : [ "[]" ],
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "goals" : [ "[]" ],
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "autoOptimized" : "false",
  "deviations" : "",
  "respoolTime" : "",
  "targetingConfiguration" : "SITE",
  "variationsId" : [ "[]" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "isArchived" : "false",
  "createdBy" : "123456789",
  "commonCssCode" : "string",
  "commonJavaScriptCode" : "string"
}

Response body

Experiment

Name	Type	Description
id	long	This field is generated by the system to uniquely identify an experiment
siteId	long	The website id that an experiment belongs to
name	string	The name of the experiment
baseURL	string
type	enum	. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
description	string
tags	array
trackingTools	array[TrackingTool]
status	string	The status of the given experiment
dateCreated	datetime
goals	array
targetingSegmentId	long
mainGoalId	long
autoOptimized	boolean
deviations	map	Traffic allocation per variation. Key can be 'origin'(for original page) or variation id. Value is percent of traffic which will be routed to the variation. Values has to be double numbers in range from 0(0%) to 1(100%).
respoolTime	map
targetingConfiguration	enum	. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
variationsId	array	List of associated variations id for this experiment
dateModified	datetime
dateStarted	datetime
dateStatusModified	datetime
isArchived	boolean
createdBy	long	Account id to whom created this experiment
commonCssCode	string	CSS code specific to all variations
commonJavaScriptCode	string	JavaScript code specific to all variations

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

Feature flags

Feature flag is used to help our clients to implement new features, test and deploy them via our SDK. This service allows you to create and configure the feature flag which will be used in the source code of your feature.

Create new feature flag

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/feature-flags"
{
  "id" : "123456789",
  "name" : "string",
  "identificationKey" : "string",
  "description" : "string",
  "tags" : [ "[]" ],
  "siteId" : "123456789",
  "expositionRate" : "132.987",
  "targetingSegmentId" : "123456789",
  "goals" : [ "[]" ],
  "sdkLanguageType" : "ANDROID",
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277"
}

POST /feature-flags

Create new feature flag with given parameters

Request body

FeatureFlag

Name	Type	Description
id `*read only`	long	This field is generated by the system to uniquely identify a feature flag
name `*required`	string	The name of the feature flag
identificationKey `*required`	string
description	string
tags	array
siteId `*required`	long	The website id that a feature flag belongs to
expositionRate	double	Rate of the feature flag that will be exposed
targetingSegmentId	long
goals	array
sdkLanguageType	enum	. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
status `*read only`	string	The status of the given feature flag
dateCreated `*read only`	datetime
dateModified `*read only`	datetime

{
  "id" : "123456789",
  "name" : "string",
  "identificationKey" : "string",
  "description" : "string",
  "tags" : [ "[]" ],
  "siteId" : "123456789",
  "expositionRate" : "132.987",
  "targetingSegmentId" : "123456789",
  "goals" : [ "[]" ],
  "sdkLanguageType" : "ANDROID",
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277"
}

Response body

FeatureFlag

Name	Type	Description
id	long	This field is generated by the system to uniquely identify a feature flag
name	string	The name of the feature flag
identificationKey	string
description	string
tags	array
siteId	long	The website id that a feature flag belongs to
expositionRate	double	Rate of the feature flag that will be exposed
targetingSegmentId	long
goals	array
sdkLanguageType	enum	. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
status	string	The status of the given feature flag
dateCreated	datetime
dateModified	datetime

List feature flags

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/feature-flags"

GET /feature-flags

Get the list of all feature flags

[ {
  "id" : "123456789",
  "name" : "string",
  "identificationKey" : "string",
  "description" : "string",
  "tags" : [ "[]" ],
  "siteId" : "123456789",
  "expositionRate" : "132.987",
  "targetingSegmentId" : "123456789",
  "goals" : [ "[]" ],
  "sdkLanguageType" : "ANDROID",
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277"
} ]

Response body

FeatureFlag

Name	Type	Description
id	long	This field is generated by the system to uniquely identify a feature flag
name	string	The name of the feature flag
identificationKey	string
description	string
tags	array
siteId	long	The website id that a feature flag belongs to
expositionRate	double	Rate of the feature flag that will be exposed
targetingSegmentId	long
goals	array
sdkLanguageType	enum	. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
status	string	The status of the given feature flag
dateCreated	datetime
dateModified	datetime

Request feature flag's results

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/feature-flags/{featureFlagId}/results"
{
  "interval" : "HOUR",
  "visitorData" : "false",
  "allVariationsData" : "false",
  "bayesian" : "false",
  "breakdown" : {
    "type" : "BROWSER"
  },
  "goalsIds" : [ "[]" ],
  "filters" : [ {
    "type" : "string"
  } ],
  "dateIntervals" : [ {
    "start" : "2021-04-07T10:13:22.814277",
    "end" : "2021-04-07T10:13:22.814277"
  } ],
  "callbackUrl" : "string",
  "stringForHash" : "string"
}

POST /feature-flags/{featureFlagId}/results

Send a request to generate the report for the results of the given feature flag

Request arguments

Name	Place	Type	Description
featureFlagId	path	long	featureFlagId

Request body

DataRequestParams

Name	Type	Description
interval	enum	. Can be [HOUR, DAY, WEEK, MONTH, YEAR]
visitorData	boolean
allVariationsData	boolean
bayesian	boolean
breakdown	Breakdown
goalsIds	array
filters	array[Filter]
dateIntervals	array[DateInterval]
callbackUrl	string
stringForHash	string

Filter

Name	Type	Description
type `*required`	string

Breakdown

Name	Type	Description
type	enum	. Can be [BROWSER, CUSTOM_DATUM, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OS, PAGE_TITLE, NUMBER_PAGES, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, DAYS_OF_WEEK, VISIT_DURATION, WEATHER_CODE, DAY, TEMPERATURE, NUMBER_VISITS, FIRST_REFERRER_URL, MAX_NUMBER_TABS, KEY_PAGE, INTEREST, TARGETING_SEGMENT, TIME_SINCE_PREVIOUS_VISIT, KEYWORD, YSANCE_SEGMENT, YSANCE_ATTRIBUTE, COUNTRY, REGION, CITY, LANGUAGE, JAVA_ENABLED, LANDING_PAGE, TIME_ZONE_GROUP, SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_RESOLUTION, REFERRER, TIME_ZONE_ID, LOCALE_LANGUAGE_CODE, LOCALE_COUNTRY_CODE, LOCALE_LANGUAGE_TAG, PERSONALIZATION_UNEXPOSITION_CAUSE]

DateInterval

Name	Type	Description
start	datetime
end	datetime

DeviceTypeFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [DESKTOP, TABLET, PHONE]
include	boolean

TimeSpentFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

PageURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

AdBlockerFilter

Name	Type	Description
type	string
include	boolean

WeatherFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, ATMOSPHERIC_DISTURBANCES]
include	boolean

KeyPageFilter

Name	Type	Description
type	string
include	boolean
values	array

NumberTabsFilter

Name	Type	Description
type	string
include	boolean
value `*required`	integer

CustomDataFilter

Name	Type	Description
type	string
include	boolean
customDataId `*required`	long
value	string

TimeSlotFilter

Name	Type	Description
type	string
include	boolean
visitorCalendar	boolean
values	array

TargetingSegmentFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NewVisitorFilter

Name	Type	Description
type	string
visitorsType	enum	. Can be [NEW_VISITORS, RETURNING_VISITORS]

FilterContainer

Name	Type	Description
param	enum	. Can be [GREATER, LOWER, EQUAL, BETWEEN]
value	integer
unit	enum	. Can be [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

PageTitleFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

BrowserFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [CHROME, EXPLORER, FIREFOX, SAFARI, OPERA]
include	boolean

FirstReferrerFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NumberVisitsFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

LandingPageURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NumberPagesFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

TemperatureFilter

Name	Type	Description
type	string
include	boolean
param `*required`	enum	. Can be [GREATER, LOWER, EQUAL, BETWEEN]
from `*required`	integer
to	integer

BrowserLanguageFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [AB, AA, AF, AK, SQ, AM, AR, AN, HY, AS, AV, AE, AY, AZ, BM, BA, EU, BE, BN, BH, BI, BS, BR, BG, MY, CA, CH, CE, NY, ZH, CV, KW, CO, CR, HR, CS, DA, DV, NL, DZ, EN, EO, ET, EE, FO, FJ, FI, FR, FF, GL, KA, DE, EL, GN, GU, HT, HA, HE, HZ, HI, HO, HU, IA, ID, IE, GA, IG, IK, IO, IS, IT, IU, JA, JV, KL, KN, KR, KS, KK, KM, KI, RW, KY, KV, KG, KO, KU, KJ, LA, LB, LG, LI, LN, LO, LT, LU, LV, GV, MK, MG, MS, ML, MT, MI, MR, MH, MN, NA, NV, ND, NE, NG, NB, NN, NO, II, NR, OC, OJ, CU, OM, OR, OS, PA, PI, FA, PL, PS, PT, QU, RM, RN, RO, RU, SA, SC, SD, SE, SM, SG, SR, GD, SN, SI, SK, SL, SO, ST, ES, SU, SW, SS, SV, TA, TE, TG, TH, TI, BO, TK, TL, TN, TO, TR, TS, TT, TW, TY, UG, UK, UR, UZ, VE, VI, VO, WA, CY, WO, FY, XH, YI, YO, ZA, ZU]
include	boolean

DayFilter

Name	Type	Description
type	string
include	boolean

OperatingSystemFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [WINDOWS, MAC_OS, I_OS, LINUX, ANDROID, WINDOWS_PHONE]
include	boolean

ReferrerURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

SinceLastVisitFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

TrafficFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [SEO, DIRECT, SEM, EMAIL, AFFILIATION]
include	boolean

ConversionsFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

WeekdayFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
include	boolean
visitorCalendar	boolean

CustomDatumBreakdown

Name	Type	Description
type	enum	. Can be [BROWSER, CUSTOM_DATUM, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OS, PAGE_TITLE, NUMBER_PAGES, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, DAYS_OF_WEEK, VISIT_DURATION, WEATHER_CODE, DAY, TEMPERATURE, NUMBER_VISITS, FIRST_REFERRER_URL, MAX_NUMBER_TABS, KEY_PAGE, INTEREST, TARGETING_SEGMENT, TIME_SINCE_PREVIOUS_VISIT, KEYWORD, YSANCE_SEGMENT, YSANCE_ATTRIBUTE, COUNTRY, REGION, CITY, LANGUAGE, JAVA_ENABLED, LANDING_PAGE, TIME_ZONE_GROUP, SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_RESOLUTION, REFERRER, TIME_ZONE_ID, LOCALE_LANGUAGE_CODE, LOCALE_COUNTRY_CODE, LOCALE_LANGUAGE_TAG, PERSONALIZATION_UNEXPOSITION_CAUSE]
index `*required`	integer

{
  "dataCode" : "string"
}

Response body

DataCodeResponseIO

Name	Type	Description
dataCode	string

Partial update feature flag

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/feature-flags/{featureFlagId}"

PATCH /feature-flags/{featureFlagId}

Update several fields of feature flag

Request arguments

Name	Place	Type	Description
featureFlagId	path	long	featureFlagId
action	query	string	Action to change the status of feature flag

{
  "id" : "123456789",
  "name" : "string",
  "identificationKey" : "string",
  "description" : "string",
  "tags" : [ "[]" ],
  "siteId" : "123456789",
  "expositionRate" : "132.987",
  "targetingSegmentId" : "123456789",
  "goals" : [ "[]" ],
  "sdkLanguageType" : "ANDROID",
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277"
}

Response body

FeatureFlag

Name	Type	Description
id	long	This field is generated by the system to uniquely identify a feature flag
name	string	The name of the feature flag
identificationKey	string
description	string
tags	array
siteId	long	The website id that a feature flag belongs to
expositionRate	double	Rate of the feature flag that will be exposed
targetingSegmentId	long
goals	array
sdkLanguageType	enum	. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
status	string	The status of the given feature flag
dateCreated	datetime
dateModified	datetime

Remove feature flag

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/feature-flags/{featureFlagId}"

DELETE /feature-flags/{featureFlagId}

Remove feature flag with given id

Request arguments

Name	Place	Type	Description
featureFlagId	path	long	featureFlagId

Get one feature flag

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/feature-flags/{featureFlagId}"

GET /feature-flags/{featureFlagId}

Get one feature flag with given id

Request arguments

Name	Place	Type	Description
featureFlagId	path	long	featureFlagId

{
  "id" : "123456789",
  "name" : "string",
  "identificationKey" : "string",
  "description" : "string",
  "tags" : [ "[]" ],
  "siteId" : "123456789",
  "expositionRate" : "132.987",
  "targetingSegmentId" : "123456789",
  "goals" : [ "[]" ],
  "sdkLanguageType" : "ANDROID",
  "status" : "string",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277"
}

Response body

FeatureFlag

Name	Type	Description
id	long	This field is generated by the system to uniquely identify a feature flag
name	string	The name of the feature flag
identificationKey	string
description	string
tags	array
siteId	long	The website id that a feature flag belongs to
expositionRate	double	Rate of the feature flag that will be exposed
targetingSegmentId	long
goals	array
sdkLanguageType	enum	. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
status	string	The status of the given feature flag
dateCreated	datetime
dateModified	datetime

Goals

To measure the efficiency of an experiment or a personalization, it must be linked to one or several goals. All goals can be managed through Kameleoon interface or Automation API. There are variety of different goals you can choose from to better measure the results.

Partial update goal

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/goals/{goalId}"
{
  "name" : "string",
  "description" : "string",
  "isMainGoal" : "false",
  "mentalistWeight" : "132.987",
  "hasMultipleConversions" : "false",
  "type" : "CLICK",
  "params" : { },
  "trackingTools" : [ "GOOGLE_ANALYTICS" ],
  "tags" : [ "[]" ]
}

PATCH /goals/{goalId}

Update several fields of a goal

Request arguments

Name	Place	Type	Description
goalId	path	long	goalId

Request body

GoalUpdate

Name	Type	Description
name	string	Name of goal
description	string
isMainGoal	boolean
mentalistWeight	double
hasMultipleConversions	boolean
type	enum	. Can be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
params	GoalParams	Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.
trackingTools	array	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
tags	array

ClickTrackingGoalParams

Name	Type	Description
url	string	URL of the page on which you want to create your click tracker. Example: www.mozilla.org
customCssSelectors	array	Selection with a CSS selector. CSS selector to track the corresponding element

AccessToPageGoalParams

Name	Type	Description
matchType	enum	. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
matchString	string

TimeSpentGoalParams

Name	Type	Description
matchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
timeSeconds	integer

ScrollTrackingGoalParams

Name	Type	Description
type	enum	When the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
value	double	Scroll tracking value

PageViewsGoalParams

Name	Type	Description
numberMatchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
numberOfVisitedPages	integer

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "mentalistWeight" : "132.987",
  "hasMultipleConversions" : "false",
  "type" : "CLICK",
  "params" : { },
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "trackingTools" : [ "GOOGLE_ANALYTICS" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "isTargetingSegmentMentalist" : "false",
  "createdBy" : "123456789",
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

Response body

Goal

Name	Type	Description
id	long	Unique identifier of goal
name	string	Name of goal
siteId	long
description	string
mentalistWeight	double
hasMultipleConversions	boolean
type	enum	. Can be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
params	GoalParams	Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.
dateCreated	datetime
trackingTools	array	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
dateModified	datetime
tags	array
isTargetingSegmentMentalist	boolean
createdBy	long	Account id to whom created this experiment
experimentAmount	long	Number of experiments using this goal. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this goal. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this goal. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this goal. This is an optional field needs to specify in request params.

ClickTrackingGoalParams

Name	Type	Description
url	string	URL of the page on which you want to create your click tracker. Example: www.mozilla.org
customCssSelectors	array	Selection with a CSS selector. CSS selector to track the corresponding element

AccessToPageGoalParams

Name	Type	Description
matchType	enum	. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
matchString	string

TimeSpentGoalParams

Name	Type	Description
matchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
timeSeconds	integer

ScrollTrackingGoalParams

Name	Type	Description
type	enum	When the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
value	double	Scroll tracking value

PageViewsGoalParams

Name	Type	Description
numberMatchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
numberOfVisitedPages	integer

Remove goal

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/goals/{goalId}"

DELETE /goals/{goalId}

Remove goal with given id

Request arguments

Name	Place	Type	Description
goalId	path	long	goalId

Get one goal

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/goals/{goalId}"

GET /goals/{goalId}

Get one goal with given id

Request arguments

Name	Place	Type	Description
goalId	path	long	goalId
optionalFields	query	array	optionalFields

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "mentalistWeight" : "132.987",
  "hasMultipleConversions" : "false",
  "type" : "CLICK",
  "params" : { },
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "trackingTools" : [ "GOOGLE_ANALYTICS" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "isTargetingSegmentMentalist" : "false",
  "createdBy" : "123456789",
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

Response body

Goal

Name	Type	Description
id	long	Unique identifier of goal
name	string	Name of goal
siteId	long
description	string
mentalistWeight	double
hasMultipleConversions	boolean
type	enum	. Can be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
params	GoalParams	Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.
dateCreated	datetime
trackingTools	array	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
dateModified	datetime
tags	array
isTargetingSegmentMentalist	boolean
createdBy	long	Account id to whom created this experiment
experimentAmount	long	Number of experiments using this goal. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this goal. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this goal. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this goal. This is an optional field needs to specify in request params.

ClickTrackingGoalParams

Name	Type	Description
url	string	URL of the page on which you want to create your click tracker. Example: www.mozilla.org
customCssSelectors	array	Selection with a CSS selector. CSS selector to track the corresponding element

AccessToPageGoalParams

Name	Type	Description
matchType	enum	. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
matchString	string

TimeSpentGoalParams

Name	Type	Description
matchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
timeSeconds	integer

ScrollTrackingGoalParams

Name	Type	Description
type	enum	When the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
value	double	Scroll tracking value

PageViewsGoalParams

Name	Type	Description
numberMatchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
numberOfVisitedPages	integer

Update goal

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/goals/{goalId}"
{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "mentalistWeight" : "132.987",
  "hasMultipleConversions" : "false",
  "type" : "CLICK",
  "params" : { },
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "trackingTools" : [ "GOOGLE_ANALYTICS" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "isTargetingSegmentMentalist" : "false",
  "createdBy" : "123456789",
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

PUT /goals/{goalId}

Update goal with given id

Request arguments

Name	Place	Type	Description
goalId	path	long	goalId

Request body

Goal

Name	Type	Description
id `*read only`	long	Unique identifier of goal
name	string	Name of goal
siteId	long
description	string
mentalistWeight	double
hasMultipleConversions	boolean
type	enum	. Can be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
params	GoalParams	Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.
dateCreated `*read only`	datetime
trackingTools	array	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
dateModified `*read only`	datetime
tags	array
isTargetingSegmentMentalist `*read only`	boolean
createdBy `*read only`	long	Account id to whom created this experiment
experimentAmount `*read only`	long	Number of experiments using this goal. This is an optional field needs to specify in request params.
personalizationAmount `*read only`	long	Number of personalizations using this goal. This is an optional field needs to specify in request params.
experiments `*read only`	array	List of experiment ids using this goal. This is an optional field needs to specify in request params.
personalizations `*read only`	array	List of personalization ids using this goal. This is an optional field needs to specify in request params.

ClickTrackingGoalParams

Name	Type	Description
url	string	URL of the page on which you want to create your click tracker. Example: www.mozilla.org
customCssSelectors	array	Selection with a CSS selector. CSS selector to track the corresponding element

AccessToPageGoalParams

Name	Type	Description
matchType	enum	. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
matchString	string

TimeSpentGoalParams

Name	Type	Description
matchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
timeSeconds	integer

ScrollTrackingGoalParams

Name	Type	Description
type	enum	When the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
value	double	Scroll tracking value

PageViewsGoalParams

Name	Type	Description
numberMatchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
numberOfVisitedPages	integer

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "mentalistWeight" : "132.987",
  "hasMultipleConversions" : "false",
  "type" : "CLICK",
  "params" : { },
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "trackingTools" : [ "GOOGLE_ANALYTICS" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "isTargetingSegmentMentalist" : "false",
  "createdBy" : "123456789",
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

Response body

Goal

Name	Type	Description
id	long	Unique identifier of goal
name	string	Name of goal
siteId	long
description	string
mentalistWeight	double
hasMultipleConversions	boolean
type	enum	. Can be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
params	GoalParams	Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.
dateCreated	datetime
trackingTools	array	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
dateModified	datetime
tags	array
isTargetingSegmentMentalist	boolean
createdBy	long	Account id to whom created this experiment
experimentAmount	long	Number of experiments using this goal. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this goal. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this goal. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this goal. This is an optional field needs to specify in request params.

ClickTrackingGoalParams

Name	Type	Description
url	string	URL of the page on which you want to create your click tracker. Example: www.mozilla.org
customCssSelectors	array	Selection with a CSS selector. CSS selector to track the corresponding element

AccessToPageGoalParams

Name	Type	Description
matchType	enum	. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
matchString	string

TimeSpentGoalParams

Name	Type	Description
matchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
timeSeconds	integer

ScrollTrackingGoalParams

Name	Type	Description
type	enum	When the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
value	double	Scroll tracking value

PageViewsGoalParams

Name	Type	Description
numberMatchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
numberOfVisitedPages	integer

Create new goal

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/goals"
{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "mentalistWeight" : "132.987",
  "hasMultipleConversions" : "false",
  "type" : "CLICK",
  "params" : { },
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "trackingTools" : [ "GOOGLE_ANALYTICS" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "isTargetingSegmentMentalist" : "false",
  "createdBy" : "123456789",
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

POST /goals

Create new goal with given parameters

Request body

Goal

Name	Type	Description
id `*read only`	long	Unique identifier of goal
name	string	Name of goal
siteId	long
description	string
mentalistWeight	double
hasMultipleConversions	boolean
type	enum	. Can be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
params	GoalParams	Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.
dateCreated `*read only`	datetime
trackingTools	array	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
dateModified `*read only`	datetime
tags	array
isTargetingSegmentMentalist `*read only`	boolean
createdBy `*read only`	long	Account id to whom created this experiment
experimentAmount `*read only`	long	Number of experiments using this goal. This is an optional field needs to specify in request params.
personalizationAmount `*read only`	long	Number of personalizations using this goal. This is an optional field needs to specify in request params.
experiments `*read only`	array	List of experiment ids using this goal. This is an optional field needs to specify in request params.
personalizations `*read only`	array	List of personalization ids using this goal. This is an optional field needs to specify in request params.

ClickTrackingGoalParams

Name	Type	Description
url	string	URL of the page on which you want to create your click tracker. Example: www.mozilla.org
customCssSelectors	array	Selection with a CSS selector. CSS selector to track the corresponding element

AccessToPageGoalParams

Name	Type	Description
matchType	enum	. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
matchString	string

TimeSpentGoalParams

Name	Type	Description
matchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
timeSeconds	integer

ScrollTrackingGoalParams

Name	Type	Description
type	enum	When the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
value	double	Scroll tracking value

PageViewsGoalParams

Name	Type	Description
numberMatchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
numberOfVisitedPages	integer

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "mentalistWeight" : "132.987",
  "hasMultipleConversions" : "false",
  "type" : "CLICK",
  "params" : { },
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "trackingTools" : [ "GOOGLE_ANALYTICS" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "isTargetingSegmentMentalist" : "false",
  "createdBy" : "123456789",
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

Response body

Goal

Name	Type	Description
id	long	Unique identifier of goal
name	string	Name of goal
siteId	long
description	string
mentalistWeight	double
hasMultipleConversions	boolean
type	enum	. Can be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
params	GoalParams	Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.
dateCreated	datetime
trackingTools	array	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
dateModified	datetime
tags	array
isTargetingSegmentMentalist	boolean
createdBy	long	Account id to whom created this experiment
experimentAmount	long	Number of experiments using this goal. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this goal. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this goal. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this goal. This is an optional field needs to specify in request params.

ClickTrackingGoalParams

Name	Type	Description
url	string	URL of the page on which you want to create your click tracker. Example: www.mozilla.org
customCssSelectors	array	Selection with a CSS selector. CSS selector to track the corresponding element

AccessToPageGoalParams

Name	Type	Description
matchType	enum	. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
matchString	string

TimeSpentGoalParams

Name	Type	Description
matchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
timeSeconds	integer

ScrollTrackingGoalParams

Name	Type	Description
type	enum	When the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
value	double	Scroll tracking value

PageViewsGoalParams

Name	Type	Description
numberMatchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
numberOfVisitedPages	integer

List goals

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/goals"

GET /goals

Get list of goals

Request arguments

Name	Place	Type	Description
optionalFields	query	array	optionalFields

[ {
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "mentalistWeight" : "132.987",
  "hasMultipleConversions" : "false",
  "type" : "CLICK",
  "params" : { },
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "trackingTools" : [ "GOOGLE_ANALYTICS" ],
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "isTargetingSegmentMentalist" : "false",
  "createdBy" : "123456789",
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
} ]

Response body

Goal

Name	Type	Description
id	long	Unique identifier of goal
name	string	Name of goal
siteId	long
description	string
mentalistWeight	double
hasMultipleConversions	boolean
type	enum	. Can be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
params	GoalParams	Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.
dateCreated	datetime
trackingTools	array	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
dateModified	datetime
tags	array
isTargetingSegmentMentalist	boolean
createdBy	long	Account id to whom created this experiment
experimentAmount	long	Number of experiments using this goal. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this goal. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this goal. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this goal. This is an optional field needs to specify in request params.

ClickTrackingGoalParams

Name	Type	Description
url	string	URL of the page on which you want to create your click tracker. Example: www.mozilla.org
customCssSelectors	array	Selection with a CSS selector. CSS selector to track the corresponding element

AccessToPageGoalParams

Name	Type	Description
matchType	enum	. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
matchString	string

TimeSpentGoalParams

Name	Type	Description
matchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
timeSeconds	integer

ScrollTrackingGoalParams

Name	Type	Description
type	enum	When the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
value	double	Scroll tracking value

PageViewsGoalParams

Name	Type	Description
numberMatchType	enum	. Can be [MORE_THAN, EQUALS, LESS_THAN]
numberOfVisitedPages	integer

Export goals

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/goals/export"

GET /goals/export

Export goals depending on specified format

Request arguments

Name	Place	Type	Description
fileName	query	string	fileName
format	query	string	format

Interests

Interests allow you to target visitors that visited one or several websites in particular before yours. Interests make your targeting more precise. They indicate which websites users visited before arriving on your pages, even if they are visiting your website for the first time.

Partial update interest

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/interests/{interestId}"
{
  "name" : "string",
  "specifications" : [ {
    "method" : "string",
    "parameters" : "string"
  } ]
}

PATCH /interests/{interestId}

Update several fields of interest

Request arguments

Name	Place	Type	Description
interestId	path	long	interestId

Request body

InterestUpdate

Name	Type	Description
name	string	The name of the interest
specifications	array[InterestSpecification]

InterestSpecification

Name	Type	Description
method	string
parameters	string

{
  "id" : "123456789",
  "index" : "1234",
  "lastTimeCrawled" : "123456789",
  "name" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "specifications" : [ {
    "method" : "string",
    "parameters" : "string"
  } ],
  "siteId" : "123456789"
}

Response body

Interest

Name	Type	Description
id	long	The unique identifier of the given interest
index	integer	The index for the given interest
lastTimeCrawled	long	Date and time the interest was crawled by a bot
name	string	The name of the interest
creationDate	datetime	Date and time an interest is created
modificationDate	datetime	Date and time an interest is modified
specifications	array[InterestSpecification]
siteId	long	Unique site identifier assigned with current interest

InterestSpecification

Name	Type	Description
method	string
parameters	string

Remove an interest

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/interests/{interestId}"

DELETE /interests/{interestId}

Remove interest with given id

Request arguments

Name	Place	Type	Description
interestId	path	long	interestId

Get one interest

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/interests/{interestId}"

GET /interests/{interestId}

Get one interest with the given id

Request arguments

Name	Place	Type	Description
interestId	path	long	interestId

{
  "id" : "123456789",
  "index" : "1234",
  "lastTimeCrawled" : "123456789",
  "name" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "specifications" : [ {
    "method" : "string",
    "parameters" : "string"
  } ],
  "siteId" : "123456789"
}

Response body

Interest

Name	Type	Description
id	long	The unique identifier of the given interest
index	integer	The index for the given interest
lastTimeCrawled	long	Date and time the interest was crawled by a bot
name	string	The name of the interest
creationDate	datetime	Date and time an interest is created
modificationDate	datetime	Date and time an interest is modified
specifications	array[InterestSpecification]
siteId	long	Unique site identifier assigned with current interest

InterestSpecification

Name	Type	Description
method	string
parameters	string

Update an interest

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/interests/{interestId}"
{
  "id" : "123456789",
  "index" : "1234",
  "lastTimeCrawled" : "123456789",
  "name" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "specifications" : [ {
    "method" : "string",
    "parameters" : "string"
  } ],
  "siteId" : "123456789"
}

PUT /interests/{interestId}

Update interest with given id

Request arguments

Name	Place	Type	Description
interestId	path	long	interestId

Request body

Interest

Name	Type	Description
id `*read only`	long	The unique identifier of the given interest
index `*read only`	integer	The index for the given interest
lastTimeCrawled `*read only`	long	Date and time the interest was crawled by a bot
name	string	The name of the interest
creationDate `*read only`	datetime	Date and time an interest is created
modificationDate `*read only`	datetime	Date and time an interest is modified
specifications	array[InterestSpecification]
siteId	long	Unique site identifier assigned with current interest

InterestSpecification

Name	Type	Description
method	string
parameters	string

{
  "id" : "123456789",
  "index" : "1234",
  "lastTimeCrawled" : "123456789",
  "name" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "specifications" : [ {
    "method" : "string",
    "parameters" : "string"
  } ],
  "siteId" : "123456789"
}

Response body

Interest

Name	Type	Description
id	long	The unique identifier of the given interest
index	integer	The index for the given interest
lastTimeCrawled	long	Date and time the interest was crawled by a bot
name	string	The name of the interest
creationDate	datetime	Date and time an interest is created
modificationDate	datetime	Date and time an interest is modified
specifications	array[InterestSpecification]
siteId	long	Unique site identifier assigned with current interest

InterestSpecification

Name	Type	Description
method	string
parameters	string

Create a new interest

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/interests"
{
  "id" : "123456789",
  "index" : "1234",
  "lastTimeCrawled" : "123456789",
  "name" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "specifications" : [ {
    "method" : "string",
    "parameters" : "string"
  } ],
  "siteId" : "123456789"
}

POST /interests

Create new interest with given parameters

Request body

Interest

Name	Type	Description
id `*read only`	long	The unique identifier of the given interest
index `*read only`	integer	The index for the given interest
lastTimeCrawled `*read only`	long	Date and time the interest was crawled by a bot
name	string	The name of the interest
creationDate `*read only`	datetime	Date and time an interest is created
modificationDate `*read only`	datetime	Date and time an interest is modified
specifications	array[InterestSpecification]
siteId	long	Unique site identifier assigned with current interest

InterestSpecification

Name	Type	Description
method	string
parameters	string

{
  "id" : "123456789",
  "index" : "1234",
  "lastTimeCrawled" : "123456789",
  "name" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "specifications" : [ {
    "method" : "string",
    "parameters" : "string"
  } ],
  "siteId" : "123456789"
}

Response body

Interest

Name	Type	Description
id	long	The unique identifier of the given interest
index	integer	The index for the given interest
lastTimeCrawled	long	Date and time the interest was crawled by a bot
name	string	The name of the interest
creationDate	datetime	Date and time an interest is created
modificationDate	datetime	Date and time an interest is modified
specifications	array[InterestSpecification]
siteId	long	Unique site identifier assigned with current interest

InterestSpecification

Name	Type	Description
method	string
parameters	string

List interests

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/interests"

GET /interests

Get list of all interests

[ {
  "id" : "123456789",
  "index" : "1234",
  "lastTimeCrawled" : "123456789",
  "name" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "specifications" : [ {
    "method" : "string",
    "parameters" : "string"
  } ],
  "siteId" : "123456789"
} ]

Response body

Interest

Name	Type	Description
id	long	The unique identifier of the given interest
index	integer	The index for the given interest
lastTimeCrawled	long	Date and time the interest was crawled by a bot
name	string	The name of the interest
creationDate	datetime	Date and time an interest is created
modificationDate	datetime	Date and time an interest is modified
specifications	array[InterestSpecification]
siteId	long	Unique site identifier assigned with current interest

InterestSpecification

Name	Type	Description
method	string
parameters	string

Key pages

Key pages allow you to target visitors that visited a particular page or multiple pages on your website.

Partial update key page

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/key-pages/{keyPageId}"
{
  "name" : "string",
  "relativeUrlRegExp" : "string",
  "matchType" : "string",
  "totalCount" : "1234",
  "secondMatchType" : "string"
}

PATCH /key-pages/{keyPageId}

Update several fields of a key page

Request arguments

Name	Place	Type	Description
keyPageId	path	long	keyPageId

Request body

KeyPageUpdate

Name	Type	Description
name	string	The name of the key page
relativeUrlRegExp	string	Regular expression for the relative URL
matchType	string	Type of matching for the given key page
totalCount	integer	Number of impressions for the key page
secondMatchType	string	Second type of matching for the given key page if needed

{
  "id" : "123456789",
  "name" : "string",
  "relativeUrlRegExp" : "string",
  "matchType" : "string",
  "totalCount" : "1234",
  "secondMatchType" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

KeyPage

Name	Type	Description
id	long	The unique identifier of the given key page
name	string	The name of the key page
relativeUrlRegExp	string	Regular expression for the relative URL
matchType	string	Type of matching for the given key page
totalCount	integer	Number of impressions for the key page
secondMatchType	string	Second type of matching for the given key page if needed
creationDate	datetime	Date and time a key page is created
modificationDate	datetime	Date and time a key page is modified
siteId	long	Unique site identifier assigned with the key page

Remove key page

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/key-pages/{keyPageId}"

DELETE /key-pages/{keyPageId}

Remove a key page with the provided id

Request arguments

Name	Place	Type	Description
keyPageId	path	long	keyPageId

Get one key page

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/key-pages/{keyPageId}"

GET /key-pages/{keyPageId}

Get one key page with the given id

Request arguments

Name	Place	Type	Description
keyPageId	path	long	keyPageId

{
  "id" : "123456789",
  "name" : "string",
  "relativeUrlRegExp" : "string",
  "matchType" : "string",
  "totalCount" : "1234",
  "secondMatchType" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

KeyPage

Name	Type	Description
id	long	The unique identifier of the given key page
name	string	The name of the key page
relativeUrlRegExp	string	Regular expression for the relative URL
matchType	string	Type of matching for the given key page
totalCount	integer	Number of impressions for the key page
secondMatchType	string	Second type of matching for the given key page if needed
creationDate	datetime	Date and time a key page is created
modificationDate	datetime	Date and time a key page is modified
siteId	long	Unique site identifier assigned with the key page

Update key page

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/key-pages/{keyPageId}"
{
  "id" : "123456789",
  "name" : "string",
  "relativeUrlRegExp" : "string",
  "matchType" : "string",
  "totalCount" : "1234",
  "secondMatchType" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

PUT /key-pages/{keyPageId}

Update a key page with the given id

Request arguments

Name	Place	Type	Description
keyPageId	path	long	keyPageId

Request body

KeyPage

Name	Type	Description
id `*read only`	long	The unique identifier of the given key page
name	string	The name of the key page
relativeUrlRegExp	string	Regular expression for the relative URL
matchType	string	Type of matching for the given key page
totalCount	integer	Number of impressions for the key page
secondMatchType	string	Second type of matching for the given key page if needed
creationDate `*read only`	datetime	Date and time a key page is created
modificationDate `*read only`	datetime	Date and time a key page is modified
siteId	long	Unique site identifier assigned with the key page

{
  "id" : "123456789",
  "name" : "string",
  "relativeUrlRegExp" : "string",
  "matchType" : "string",
  "totalCount" : "1234",
  "secondMatchType" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

KeyPage

Name	Type	Description
id	long	The unique identifier of the given key page
name	string	The name of the key page
relativeUrlRegExp	string	Regular expression for the relative URL
matchType	string	Type of matching for the given key page
totalCount	integer	Number of impressions for the key page
secondMatchType	string	Second type of matching for the given key page if needed
creationDate	datetime	Date and time a key page is created
modificationDate	datetime	Date and time a key page is modified
siteId	long	Unique site identifier assigned with the key page

Create a new key page

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/key-pages"
{
  "id" : "123456789",
  "name" : "string",
  "relativeUrlRegExp" : "string",
  "matchType" : "string",
  "totalCount" : "1234",
  "secondMatchType" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

POST /key-pages

Create a new key page with the given parameters

Request body

KeyPage

Name	Type	Description
id `*read only`	long	The unique identifier of the given key page
name	string	The name of the key page
relativeUrlRegExp	string	Regular expression for the relative URL
matchType	string	Type of matching for the given key page
totalCount	integer	Number of impressions for the key page
secondMatchType	string	Second type of matching for the given key page if needed
creationDate `*read only`	datetime	Date and time a key page is created
modificationDate `*read only`	datetime	Date and time a key page is modified
siteId	long	Unique site identifier assigned with the key page

{
  "id" : "123456789",
  "name" : "string",
  "relativeUrlRegExp" : "string",
  "matchType" : "string",
  "totalCount" : "1234",
  "secondMatchType" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

KeyPage

Name	Type	Description
id	long	The unique identifier of the given key page
name	string	The name of the key page
relativeUrlRegExp	string	Regular expression for the relative URL
matchType	string	Type of matching for the given key page
totalCount	integer	Number of impressions for the key page
secondMatchType	string	Second type of matching for the given key page if needed
creationDate	datetime	Date and time a key page is created
modificationDate	datetime	Date and time a key page is modified
siteId	long	Unique site identifier assigned with the key page

List of key pages

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/key-pages"

GET /key-pages

Get list of all the key pages

[ {
  "id" : "123456789",
  "name" : "string",
  "relativeUrlRegExp" : "string",
  "matchType" : "string",
  "totalCount" : "1234",
  "secondMatchType" : "string",
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
} ]

Response body

KeyPage

Name	Type	Description
id	long	The unique identifier of the given key page
name	string	The name of the key page
relativeUrlRegExp	string	Regular expression for the relative URL
matchType	string	Type of matching for the given key page
totalCount	integer	Number of impressions for the key page
secondMatchType	string	Second type of matching for the given key page if needed
creationDate	datetime	Date and time a key page is created
modificationDate	datetime	Date and time a key page is modified
siteId	long	Unique site identifier assigned with the key page

Personalizations

Web personalization consists in offering visitors a tailored experience in order to optimize your conversion rate. Personalization object contains all vital information about a personalization as well as segments and variations used in it.

Create new personalization

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/personalizations"
{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "variationId" : "123456789",
  "status" : "string",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "goals" : [ "[]" ],
  "customExpositionRate" : "132.987",
  "globalCappingNumberVisitors" : "false",
  "globalCappingVisitorsConfig" : "NUMBER_VISITORS",
  "globalCappingGoalId" : "123456789",
  "visitExpositionFrequency" : "1234",
  "visitorExpositionFrequency" : "1234",
  "expositionFrequencyDelay" : "123456789",
  "multiExpositionFrequencyDelay" : "123456789",
  "cappingPerVisitorExpositions" : "false",
  "visitorExpositionFrequencyMax" : "1234",
  "cappingPerVisitorExposedVisits" : "false",
  "exposedVisitsSameVisitorMax" : "1234",
  "cappingPerVisitorConvertGoal" : "false",
  "cappingPerVisitorGoalId" : "123456789",
  "maxNumberVisitorsExposed" : "123456789",
  "checkConditionsRule" : "ALL_CONDITIONS",
  "priority" : "1234",
  "popIn" : {
    "targetBlank" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "stickyBlock" : {
    "targetBlank" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "imageInPage" : {
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "width" : "string",
    "height" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "redirectURL" : "string",
    "htmlContent" : "string"
  },
  "emailAction" : {
    "emailSolution" : "CUSTOM",
    "solutionKey" : "string",
    "solutionSecret" : "string",
    "solutionUrl" : "string",
    "customSolutionName" : "string",
    "fetchingMethod" : "CUSTOM_DATA",
    "fetchingScript" : "string",
    "customDataIndex" : "1234",
    "emailContentSolution" : "CUSTOM_TEMPLATE",
    "emailTemplateId" : "string",
    "htmlContent" : "string",
    "randomTagId" : "string",
    "headerSenderName" : "string",
    "headerSenderEmail" : "string",
    "headerReplyEmail" : "string",
    "headerEmailSubject" : "string",
    "emailTags" : "string",
    "sendAtOnce" : "false",
    "secondsDelayToSend" : "123456789",
    "neverCancelSending" : "false",
    "goalCancellingId" : "123456789"
  },
  "countDownBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "contentType" : "TEXT",
    "year" : "1234",
    "month" : "1234",
    "dayOfMonth" : "1234",
    "hourOfDay" : "1234",
    "minute" : "1234",
    "second" : "1234",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "textColor" : "string",
    "backgroundColor" : "string"
  },
  "googleForm" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "googleFormURL" : "string",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string"
  },
  "cookieInfoBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "redirectText" : "string",
    "message" : "string"
  },
  "iAdvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  },
  "socialBar" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "urlToShare" : "string",
    "urlType" : "CURRENT",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "orientation" : "HORIZONTAL",
    "marginTop" : "string",
    "marginBottom" : "string",
    "marginLeft" : "string",
    "marginRight" : "string"
  },
  "popInVideo" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "url" : "string",
    "addBackground" : "false",
    "closePopin" : "false",
    "autoPlay" : "false",
    "autoSize" : "false"
  },
  "adBlock" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "type" : "POPIN",
    "actionType" : "SHOW_MESSAGE",
    "imageType" : "NONE",
    "blockNavigationType" : "ALL",
    "messageContent" : "string",
    "messageTitle" : "string",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "showMessage" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "trackAction" : "false",
    "goalName" : "string"
  },
  "visitsCounter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "descriptionText" : "string",
    "counterFromType" : "DAY",
    "counterFromDate" : "2021-04-07T10:13:22.814277",
    "counterFormat" : "FRENCH",
    "minimumVisits" : "123456789"
  },
  "newsLetter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "titleEnabled" : "false",
    "legalNoticeUrl" : "string",
    "backgroundColor" : "string",
    "confirmationText" : "string",
    "backgroundImage" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "type" : "FORM",
    "requestType" : "GET",
    "url" : "string",
    "pageUrl" : "string",
    "emailKey" : "string",
    "overlayEnabled" : "false",
    "outsideClose" : "false",
    "timerClose" : "1234"
  },
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "description" : "string",
  "isArchived" : "false",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "type" : "CLASSIC",
  "createdBy" : "123456789",
  "cssCode" : "string",
  "javaScriptCode" : "string",
  "iadvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  }
}

POST /personalizations

Create new personalization with given parameters

Request body

Personalization

Name	Type	Description
id `*read only`	long	This field is generated by the system to uniquely identify a personalization
name `*required`	string	The name of the personalization
siteId `*required`	long	The website id that a personalization belongs to
variationId	long	The variation id of the given personalization
status `*read only`	string	The status of the given personalization
dateStatusModified `*read only`	datetime	Last moment when status was updated
targetingSegmentId `*read only`	long	Selected targeting segment
mainGoalId `*read only`	long	Main goal
goals `*read only`	array	Selected goals
customExpositionRate `*read only`	double	The segment percentage exposed to personalization
globalCappingNumberVisitors `*read only`	boolean	This option allows you to set the capping configuration
globalCappingVisitorsConfig `*read only`	enum	The visitors configuration for threshold of total number of exposed visitors. Can be [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]
globalCappingGoalId `*read only`	long	The goal for threshold of total number of exposed visitors
visitExpositionFrequency `*read only`	integer	Exposition frequency during a unique visit
visitorExpositionFrequency `*read only`	integer	Exposition frequency during a unique visitor
expositionFrequencyDelay `*read only`	long	Period of time of exposition frequency during different visitors
multiExpositionFrequencyDelay `*read only`	long	Minimum delay between each exposition
cappingPerVisitorExpositions `*read only`	boolean	If true stop exposing a same visitor when the total number of expositions exceeds this threshold
visitorExpositionFrequencyMax `*read only`	integer	Stop exposing a same visitor when the total number of expositions exceeds this threshold
cappingPerVisitorExposedVisits `*read only`	boolean	If true stop exposing a same visitor when the number of visits exceeds this threshold
exposedVisitsSameVisitorMax `*read only`	integer	Stop exposing a same visitor when the number of visits exceeds this threshold
cappingPerVisitorConvertGoal `*read only`	boolean	If true stop exposing a same visitor when the goal is completed
cappingPerVisitorGoalId `*read only`	long	Stop exposing a same visitor when the goal with given id is completed
maxNumberVisitorsExposed `*read only`	long	Threshold of the total number of exposed visitors
checkConditionsRule `*read only`	enum	The behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
priority `*read only`	integer	The priority of the personalization
popIn	PopIn	Pop-In settings
stickyBlock	StickyBlock	Sticky block settings
imageInPage	ImageInPage	Settings of an image in page
emailAction	EmailAction	Settings of an email
countDownBanner	CountDownBanner	Settings of a countdown banner widget
googleForm	GoogleForm	Settings of a Google form widget
cookieInfoBanner	CookieInfoBanner	Settings of a cookie banner widget
iAdvize	IAdvize	Settings of an iAdvize chat widget
socialBar	SocialBar	Settings of a social sharing bar widget
popInVideo	PopInVideo	Settings of a video pop-in widget
adBlock	AdBlock	Settings of an Adblocker widget
visitsCounter	VisitsCounter	Settings of a visits counter widget
newsLetter	NewsLetter	Settings of a newsletter subscription form widget
trackingTools	array[TrackingTool]	List of tracking tools
tags	array	List of tags
dateCreated `*read only`	datetime	Date and time when personalization was created
dateStarted `*read only`	datetime	Date and time when personalization was started
description	string	This is description of personalization
isArchived	boolean	If true the personalization is archived
dateModified `*read only`	datetime	Date and time when personalization was updated last time
type	enum	Type of personalization. Can be [CLASSIC, AUTOPROMO, IA, MAIL]
createdBy `*read only`	long	Account id to whom created this personalization
cssCode	string	CSS code to add in the page
javaScriptCode	string	JavaScript code to add in the page
iadvize	IAdvize	Settings of an iAdvize chat widget

IAdvize

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
iAdvizeIdentifier	string
platformType	enum	. Can be [STANDARD, HIGH_AVAILABILITY]
iadvizeIdentifier	string

VisitsCounter

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
descriptionText	string
counterFromType	enum	. Can be [DAY, WEEK, DAYS_15, PRECISE_DATE]
counterFromDate	datetime
counterFormat	enum	. Can be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
minimumVisits	long

AdBlock

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
type	enum	. Can be [POPIN, STICKY_BLOCK]
actionType	enum	. Can be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
imageType	enum	. Can be [NONE, DEFAULT, CUSTOM]
blockNavigationType	enum	. Can be [ALL, OPAQUE, REDIRECT]
messageContent	string
messageTitle	string
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
fontSize	string
textColor	string
backgroundColor	string
image	Image
showMessage	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
shouldScrollTo	boolean
shiftContent	boolean
trackAction	boolean
goalName	string

PopInVideo

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
url	string
addBackground	boolean
closePopin	boolean
autoPlay	boolean
autoSize	boolean

Image

Name	Type	Description
siteId	long
source	string
fileName	string
width	integer
height	integer
colorDepth	integer
fileWeight	long
shared	boolean
baseColor	integer
format	enum	. Can be [PNG, JPEG, GIF]
name	string
date	datetime
keywords	array

PopIn

Name	Type	Description
targetBlank	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

ImageInPage

Name	Type	Description
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
width	string
height	string
image	Image
redirectURL	string
htmlContent	string

GoogleForm

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
googleFormURL	string
withOverlay	boolean
closeWithClickOnOverlay	boolean
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string

SocialBar

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
urlToShare	string
urlType	enum	. Can be [CURRENT, FIXED]
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
orientation	enum	. Can be [HORIZONTAL, VERTICAL]
marginTop	string
marginBottom	string
marginLeft	string
marginRight	string

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
titleEnabled	boolean
legalNoticeUrl	string
backgroundColor	string
confirmationText	string
backgroundImage	Image
type	enum	. Can be [FORM, SERVICE]
requestType	enum	. Can be [GET, POST]
url	string
pageUrl	string
emailKey	string
overlayEnabled	boolean
outsideClose	boolean
timerClose	integer

StickyBlock

Name	Type	Description
targetBlank	boolean
shouldScrollTo	boolean
shiftContent	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

EmailAction

Name	Type	Description
emailSolution	enum	. Can be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
solutionKey	string
solutionSecret	string
solutionUrl	string
customSolutionName	string
fetchingMethod	enum	. Can be [CUSTOM_DATA, SCRIPT, NONE]
fetchingScript	string
customDataIndex	integer
emailContentSolution	enum	. Can be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
emailTemplateId	string
htmlContent	string
randomTagId	string
headerSenderName	string
headerSenderEmail	string
headerReplyEmail	string
headerEmailSubject	string
emailTags	string
sendAtOnce	boolean
secondsDelayToSend	long
neverCancelSending	boolean
goalCancellingId	long

CookieInfoBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
redirectText	string
message	string

CountDownBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
textContent	string
htmlContent	string
contentType	enum	. Can be [TEXT, HTML]
year	integer
month	integer
dayOfMonth	integer
hourOfDay	integer
minute	integer
second	integer
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
textColor	string
backgroundColor	string

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "variationId" : "123456789",
  "status" : "string",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "goals" : [ "[]" ],
  "customExpositionRate" : "132.987",
  "globalCappingNumberVisitors" : "false",
  "globalCappingVisitorsConfig" : "NUMBER_VISITORS",
  "globalCappingGoalId" : "123456789",
  "visitExpositionFrequency" : "1234",
  "visitorExpositionFrequency" : "1234",
  "expositionFrequencyDelay" : "123456789",
  "multiExpositionFrequencyDelay" : "123456789",
  "cappingPerVisitorExpositions" : "false",
  "visitorExpositionFrequencyMax" : "1234",
  "cappingPerVisitorExposedVisits" : "false",
  "exposedVisitsSameVisitorMax" : "1234",
  "cappingPerVisitorConvertGoal" : "false",
  "cappingPerVisitorGoalId" : "123456789",
  "maxNumberVisitorsExposed" : "123456789",
  "checkConditionsRule" : "ALL_CONDITIONS",
  "priority" : "1234",
  "popIn" : {
    "targetBlank" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "stickyBlock" : {
    "targetBlank" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "imageInPage" : {
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "width" : "string",
    "height" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "redirectURL" : "string",
    "htmlContent" : "string"
  },
  "emailAction" : {
    "emailSolution" : "CUSTOM",
    "solutionKey" : "string",
    "solutionSecret" : "string",
    "solutionUrl" : "string",
    "customSolutionName" : "string",
    "fetchingMethod" : "CUSTOM_DATA",
    "fetchingScript" : "string",
    "customDataIndex" : "1234",
    "emailContentSolution" : "CUSTOM_TEMPLATE",
    "emailTemplateId" : "string",
    "htmlContent" : "string",
    "randomTagId" : "string",
    "headerSenderName" : "string",
    "headerSenderEmail" : "string",
    "headerReplyEmail" : "string",
    "headerEmailSubject" : "string",
    "emailTags" : "string",
    "sendAtOnce" : "false",
    "secondsDelayToSend" : "123456789",
    "neverCancelSending" : "false",
    "goalCancellingId" : "123456789"
  },
  "countDownBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "contentType" : "TEXT",
    "year" : "1234",
    "month" : "1234",
    "dayOfMonth" : "1234",
    "hourOfDay" : "1234",
    "minute" : "1234",
    "second" : "1234",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "textColor" : "string",
    "backgroundColor" : "string"
  },
  "googleForm" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "googleFormURL" : "string",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string"
  },
  "cookieInfoBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "redirectText" : "string",
    "message" : "string"
  },
  "iAdvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  },
  "socialBar" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "urlToShare" : "string",
    "urlType" : "CURRENT",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "orientation" : "HORIZONTAL",
    "marginTop" : "string",
    "marginBottom" : "string",
    "marginLeft" : "string",
    "marginRight" : "string"
  },
  "popInVideo" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "url" : "string",
    "addBackground" : "false",
    "closePopin" : "false",
    "autoPlay" : "false",
    "autoSize" : "false"
  },
  "adBlock" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "type" : "POPIN",
    "actionType" : "SHOW_MESSAGE",
    "imageType" : "NONE",
    "blockNavigationType" : "ALL",
    "messageContent" : "string",
    "messageTitle" : "string",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "showMessage" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "trackAction" : "false",
    "goalName" : "string"
  },
  "visitsCounter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "descriptionText" : "string",
    "counterFromType" : "DAY",
    "counterFromDate" : "2021-04-07T10:13:22.814277",
    "counterFormat" : "FRENCH",
    "minimumVisits" : "123456789"
  },
  "newsLetter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "titleEnabled" : "false",
    "legalNoticeUrl" : "string",
    "backgroundColor" : "string",
    "confirmationText" : "string",
    "backgroundImage" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "type" : "FORM",
    "requestType" : "GET",
    "url" : "string",
    "pageUrl" : "string",
    "emailKey" : "string",
    "overlayEnabled" : "false",
    "outsideClose" : "false",
    "timerClose" : "1234"
  },
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "description" : "string",
  "isArchived" : "false",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "type" : "CLASSIC",
  "createdBy" : "123456789",
  "cssCode" : "string",
  "javaScriptCode" : "string",
  "iadvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  }
}

Response body

Personalization

Name	Type	Description
id	long	This field is generated by the system to uniquely identify a personalization
name	string	The name of the personalization
siteId	long	The website id that a personalization belongs to
variationId	long	The variation id of the given personalization
status	string	The status of the given personalization
dateStatusModified	datetime	Last moment when status was updated
targetingSegmentId	long	Selected targeting segment
mainGoalId	long	Main goal
goals	array	Selected goals
customExpositionRate	double	The segment percentage exposed to personalization
globalCappingNumberVisitors	boolean	This option allows you to set the capping configuration
globalCappingVisitorsConfig	enum	The visitors configuration for threshold of total number of exposed visitors. Can be [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]
globalCappingGoalId	long	The goal for threshold of total number of exposed visitors
visitExpositionFrequency	integer	Exposition frequency during a unique visit
visitorExpositionFrequency	integer	Exposition frequency during a unique visitor
expositionFrequencyDelay	long	Period of time of exposition frequency during different visitors
multiExpositionFrequencyDelay	long	Minimum delay between each exposition
cappingPerVisitorExpositions	boolean	If true stop exposing a same visitor when the total number of expositions exceeds this threshold
visitorExpositionFrequencyMax	integer	Stop exposing a same visitor when the total number of expositions exceeds this threshold
cappingPerVisitorExposedVisits	boolean	If true stop exposing a same visitor when the number of visits exceeds this threshold
exposedVisitsSameVisitorMax	integer	Stop exposing a same visitor when the number of visits exceeds this threshold
cappingPerVisitorConvertGoal	boolean	If true stop exposing a same visitor when the goal is completed
cappingPerVisitorGoalId	long	Stop exposing a same visitor when the goal with given id is completed
maxNumberVisitorsExposed	long	Threshold of the total number of exposed visitors
checkConditionsRule	enum	The behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
priority	integer	The priority of the personalization
popIn	PopIn	Pop-In settings
stickyBlock	StickyBlock	Sticky block settings
imageInPage	ImageInPage	Settings of an image in page
emailAction	EmailAction	Settings of an email
countDownBanner	CountDownBanner	Settings of a countdown banner widget
googleForm	GoogleForm	Settings of a Google form widget
cookieInfoBanner	CookieInfoBanner	Settings of a cookie banner widget
iAdvize	IAdvize	Settings of an iAdvize chat widget
socialBar	SocialBar	Settings of a social sharing bar widget
popInVideo	PopInVideo	Settings of a video pop-in widget
adBlock	AdBlock	Settings of an Adblocker widget
visitsCounter	VisitsCounter	Settings of a visits counter widget
newsLetter	NewsLetter	Settings of a newsletter subscription form widget
trackingTools	array[TrackingTool]	List of tracking tools
tags	array	List of tags
dateCreated	datetime	Date and time when personalization was created
dateStarted	datetime	Date and time when personalization was started
description	string	This is description of personalization
isArchived	boolean	If true the personalization is archived
dateModified	datetime	Date and time when personalization was updated last time
type	enum	Type of personalization. Can be [CLASSIC, AUTOPROMO, IA, MAIL]
createdBy	long	Account id to whom created this personalization
cssCode	string	CSS code to add in the page
javaScriptCode	string	JavaScript code to add in the page
iadvize	IAdvize	Settings of an iAdvize chat widget

IAdvize

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
iAdvizeIdentifier	string
platformType	enum	. Can be [STANDARD, HIGH_AVAILABILITY]
iadvizeIdentifier	string

VisitsCounter

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
descriptionText	string
counterFromType	enum	. Can be [DAY, WEEK, DAYS_15, PRECISE_DATE]
counterFromDate	datetime
counterFormat	enum	. Can be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
minimumVisits	long

AdBlock

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
type	enum	. Can be [POPIN, STICKY_BLOCK]
actionType	enum	. Can be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
imageType	enum	. Can be [NONE, DEFAULT, CUSTOM]
blockNavigationType	enum	. Can be [ALL, OPAQUE, REDIRECT]
messageContent	string
messageTitle	string
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
fontSize	string
textColor	string
backgroundColor	string
image	Image
showMessage	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
shouldScrollTo	boolean
shiftContent	boolean
trackAction	boolean
goalName	string

PopInVideo

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
url	string
addBackground	boolean
closePopin	boolean
autoPlay	boolean
autoSize	boolean

Image

Name	Type	Description
siteId	long
source	string
fileName	string
width	integer
height	integer
colorDepth	integer
fileWeight	long
shared	boolean
baseColor	integer
format	enum	. Can be [PNG, JPEG, GIF]
name	string
date	datetime
keywords	array

PopIn

Name	Type	Description
targetBlank	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

ImageInPage

Name	Type	Description
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
width	string
height	string
image	Image
redirectURL	string
htmlContent	string

GoogleForm

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
googleFormURL	string
withOverlay	boolean
closeWithClickOnOverlay	boolean
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string

SocialBar

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
urlToShare	string
urlType	enum	. Can be [CURRENT, FIXED]
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
orientation	enum	. Can be [HORIZONTAL, VERTICAL]
marginTop	string
marginBottom	string
marginLeft	string
marginRight	string

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
titleEnabled	boolean
legalNoticeUrl	string
backgroundColor	string
confirmationText	string
backgroundImage	Image
type	enum	. Can be [FORM, SERVICE]
requestType	enum	. Can be [GET, POST]
url	string
pageUrl	string
emailKey	string
overlayEnabled	boolean
outsideClose	boolean
timerClose	integer

StickyBlock

Name	Type	Description
targetBlank	boolean
shouldScrollTo	boolean
shiftContent	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

EmailAction

Name	Type	Description
emailSolution	enum	. Can be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
solutionKey	string
solutionSecret	string
solutionUrl	string
customSolutionName	string
fetchingMethod	enum	. Can be [CUSTOM_DATA, SCRIPT, NONE]
fetchingScript	string
customDataIndex	integer
emailContentSolution	enum	. Can be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
emailTemplateId	string
htmlContent	string
randomTagId	string
headerSenderName	string
headerSenderEmail	string
headerReplyEmail	string
headerEmailSubject	string
emailTags	string
sendAtOnce	boolean
secondsDelayToSend	long
neverCancelSending	boolean
goalCancellingId	long

CookieInfoBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
redirectText	string
message	string

CountDownBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
textContent	string
htmlContent	string
contentType	enum	. Can be [TEXT, HTML]
year	integer
month	integer
dayOfMonth	integer
hourOfDay	integer
minute	integer
second	integer
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
textColor	string
backgroundColor	string

List personalizations

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/personalizations"

GET /personalizations

Get list of all personalizations

Request arguments

Name	Place	Type	Description
optionalFields	query	array	optionalFields

[ {
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "variationId" : "123456789",
  "status" : "string",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "goals" : [ "[]" ],
  "customExpositionRate" : "132.987",
  "globalCappingNumberVisitors" : "false",
  "globalCappingVisitorsConfig" : "NUMBER_VISITORS",
  "globalCappingGoalId" : "123456789",
  "visitExpositionFrequency" : "1234",
  "visitorExpositionFrequency" : "1234",
  "expositionFrequencyDelay" : "123456789",
  "multiExpositionFrequencyDelay" : "123456789",
  "cappingPerVisitorExpositions" : "false",
  "visitorExpositionFrequencyMax" : "1234",
  "cappingPerVisitorExposedVisits" : "false",
  "exposedVisitsSameVisitorMax" : "1234",
  "cappingPerVisitorConvertGoal" : "false",
  "cappingPerVisitorGoalId" : "123456789",
  "maxNumberVisitorsExposed" : "123456789",
  "checkConditionsRule" : "ALL_CONDITIONS",
  "priority" : "1234",
  "popIn" : {
    "targetBlank" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "stickyBlock" : {
    "targetBlank" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "imageInPage" : {
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "width" : "string",
    "height" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "redirectURL" : "string",
    "htmlContent" : "string"
  },
  "emailAction" : {
    "emailSolution" : "CUSTOM",
    "solutionKey" : "string",
    "solutionSecret" : "string",
    "solutionUrl" : "string",
    "customSolutionName" : "string",
    "fetchingMethod" : "CUSTOM_DATA",
    "fetchingScript" : "string",
    "customDataIndex" : "1234",
    "emailContentSolution" : "CUSTOM_TEMPLATE",
    "emailTemplateId" : "string",
    "htmlContent" : "string",
    "randomTagId" : "string",
    "headerSenderName" : "string",
    "headerSenderEmail" : "string",
    "headerReplyEmail" : "string",
    "headerEmailSubject" : "string",
    "emailTags" : "string",
    "sendAtOnce" : "false",
    "secondsDelayToSend" : "123456789",
    "neverCancelSending" : "false",
    "goalCancellingId" : "123456789"
  },
  "countDownBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "contentType" : "TEXT",
    "year" : "1234",
    "month" : "1234",
    "dayOfMonth" : "1234",
    "hourOfDay" : "1234",
    "minute" : "1234",
    "second" : "1234",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "textColor" : "string",
    "backgroundColor" : "string"
  },
  "googleForm" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "googleFormURL" : "string",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string"
  },
  "cookieInfoBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "redirectText" : "string",
    "message" : "string"
  },
  "iAdvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  },
  "socialBar" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "urlToShare" : "string",
    "urlType" : "CURRENT",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "orientation" : "HORIZONTAL",
    "marginTop" : "string",
    "marginBottom" : "string",
    "marginLeft" : "string",
    "marginRight" : "string"
  },
  "popInVideo" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "url" : "string",
    "addBackground" : "false",
    "closePopin" : "false",
    "autoPlay" : "false",
    "autoSize" : "false"
  },
  "adBlock" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "type" : "POPIN",
    "actionType" : "SHOW_MESSAGE",
    "imageType" : "NONE",
    "blockNavigationType" : "ALL",
    "messageContent" : "string",
    "messageTitle" : "string",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "showMessage" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "trackAction" : "false",
    "goalName" : "string"
  },
  "visitsCounter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "descriptionText" : "string",
    "counterFromType" : "DAY",
    "counterFromDate" : "2021-04-07T10:13:22.814277",
    "counterFormat" : "FRENCH",
    "minimumVisits" : "123456789"
  },
  "newsLetter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "titleEnabled" : "false",
    "legalNoticeUrl" : "string",
    "backgroundColor" : "string",
    "confirmationText" : "string",
    "backgroundImage" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "type" : "FORM",
    "requestType" : "GET",
    "url" : "string",
    "pageUrl" : "string",
    "emailKey" : "string",
    "overlayEnabled" : "false",
    "outsideClose" : "false",
    "timerClose" : "1234"
  },
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "description" : "string",
  "isArchived" : "false",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "type" : "CLASSIC",
  "createdBy" : "123456789",
  "cssCode" : "string",
  "javaScriptCode" : "string",
  "iadvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  }
} ]

Response body

Personalization

Name	Type	Description
id	long	This field is generated by the system to uniquely identify a personalization
name	string	The name of the personalization
siteId	long	The website id that a personalization belongs to
variationId	long	The variation id of the given personalization
status	string	The status of the given personalization
dateStatusModified	datetime	Last moment when status was updated
targetingSegmentId	long	Selected targeting segment
mainGoalId	long	Main goal
goals	array	Selected goals
customExpositionRate	double	The segment percentage exposed to personalization
globalCappingNumberVisitors	boolean	This option allows you to set the capping configuration
globalCappingVisitorsConfig	enum	The visitors configuration for threshold of total number of exposed visitors. Can be [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]
globalCappingGoalId	long	The goal for threshold of total number of exposed visitors
visitExpositionFrequency	integer	Exposition frequency during a unique visit
visitorExpositionFrequency	integer	Exposition frequency during a unique visitor
expositionFrequencyDelay	long	Period of time of exposition frequency during different visitors
multiExpositionFrequencyDelay	long	Minimum delay between each exposition
cappingPerVisitorExpositions	boolean	If true stop exposing a same visitor when the total number of expositions exceeds this threshold
visitorExpositionFrequencyMax	integer	Stop exposing a same visitor when the total number of expositions exceeds this threshold
cappingPerVisitorExposedVisits	boolean	If true stop exposing a same visitor when the number of visits exceeds this threshold
exposedVisitsSameVisitorMax	integer	Stop exposing a same visitor when the number of visits exceeds this threshold
cappingPerVisitorConvertGoal	boolean	If true stop exposing a same visitor when the goal is completed
cappingPerVisitorGoalId	long	Stop exposing a same visitor when the goal with given id is completed
maxNumberVisitorsExposed	long	Threshold of the total number of exposed visitors
checkConditionsRule	enum	The behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
priority	integer	The priority of the personalization
popIn	PopIn	Pop-In settings
stickyBlock	StickyBlock	Sticky block settings
imageInPage	ImageInPage	Settings of an image in page
emailAction	EmailAction	Settings of an email
countDownBanner	CountDownBanner	Settings of a countdown banner widget
googleForm	GoogleForm	Settings of a Google form widget
cookieInfoBanner	CookieInfoBanner	Settings of a cookie banner widget
iAdvize	IAdvize	Settings of an iAdvize chat widget
socialBar	SocialBar	Settings of a social sharing bar widget
popInVideo	PopInVideo	Settings of a video pop-in widget
adBlock	AdBlock	Settings of an Adblocker widget
visitsCounter	VisitsCounter	Settings of a visits counter widget
newsLetter	NewsLetter	Settings of a newsletter subscription form widget
trackingTools	array[TrackingTool]	List of tracking tools
tags	array	List of tags
dateCreated	datetime	Date and time when personalization was created
dateStarted	datetime	Date and time when personalization was started
description	string	This is description of personalization
isArchived	boolean	If true the personalization is archived
dateModified	datetime	Date and time when personalization was updated last time
type	enum	Type of personalization. Can be [CLASSIC, AUTOPROMO, IA, MAIL]
createdBy	long	Account id to whom created this personalization
cssCode	string	CSS code to add in the page
javaScriptCode	string	JavaScript code to add in the page
iadvize	IAdvize	Settings of an iAdvize chat widget

IAdvize

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
iAdvizeIdentifier	string
platformType	enum	. Can be [STANDARD, HIGH_AVAILABILITY]
iadvizeIdentifier	string

VisitsCounter

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
descriptionText	string
counterFromType	enum	. Can be [DAY, WEEK, DAYS_15, PRECISE_DATE]
counterFromDate	datetime
counterFormat	enum	. Can be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
minimumVisits	long

AdBlock

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
type	enum	. Can be [POPIN, STICKY_BLOCK]
actionType	enum	. Can be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
imageType	enum	. Can be [NONE, DEFAULT, CUSTOM]
blockNavigationType	enum	. Can be [ALL, OPAQUE, REDIRECT]
messageContent	string
messageTitle	string
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
fontSize	string
textColor	string
backgroundColor	string
image	Image
showMessage	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
shouldScrollTo	boolean
shiftContent	boolean
trackAction	boolean
goalName	string

PopInVideo

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
url	string
addBackground	boolean
closePopin	boolean
autoPlay	boolean
autoSize	boolean

Image

Name	Type	Description
siteId	long
source	string
fileName	string
width	integer
height	integer
colorDepth	integer
fileWeight	long
shared	boolean
baseColor	integer
format	enum	. Can be [PNG, JPEG, GIF]
name	string
date	datetime
keywords	array

PopIn

Name	Type	Description
targetBlank	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

ImageInPage

Name	Type	Description
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
width	string
height	string
image	Image
redirectURL	string
htmlContent	string

GoogleForm

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
googleFormURL	string
withOverlay	boolean
closeWithClickOnOverlay	boolean
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string

SocialBar

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
urlToShare	string
urlType	enum	. Can be [CURRENT, FIXED]
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
orientation	enum	. Can be [HORIZONTAL, VERTICAL]
marginTop	string
marginBottom	string
marginLeft	string
marginRight	string

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
titleEnabled	boolean
legalNoticeUrl	string
backgroundColor	string
confirmationText	string
backgroundImage	Image
type	enum	. Can be [FORM, SERVICE]
requestType	enum	. Can be [GET, POST]
url	string
pageUrl	string
emailKey	string
overlayEnabled	boolean
outsideClose	boolean
timerClose	integer

StickyBlock

Name	Type	Description
targetBlank	boolean
shouldScrollTo	boolean
shiftContent	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

EmailAction

Name	Type	Description
emailSolution	enum	. Can be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
solutionKey	string
solutionSecret	string
solutionUrl	string
customSolutionName	string
fetchingMethod	enum	. Can be [CUSTOM_DATA, SCRIPT, NONE]
fetchingScript	string
customDataIndex	integer
emailContentSolution	enum	. Can be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
emailTemplateId	string
htmlContent	string
randomTagId	string
headerSenderName	string
headerSenderEmail	string
headerReplyEmail	string
headerEmailSubject	string
emailTags	string
sendAtOnce	boolean
secondsDelayToSend	long
neverCancelSending	boolean
goalCancellingId	long

CookieInfoBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
redirectText	string
message	string

CountDownBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
textContent	string
htmlContent	string
contentType	enum	. Can be [TEXT, HTML]
year	integer
month	integer
dayOfMonth	integer
hourOfDay	integer
minute	integer
second	integer
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
textColor	string
backgroundColor	string

Request personalization's results

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/personalizations/{personalizationId}/results"
{
  "interval" : "HOUR",
  "visitorData" : "false",
  "allVariationsData" : "false",
  "bayesian" : "false",
  "breakdown" : {
    "type" : "BROWSER"
  },
  "goalsIds" : [ "[]" ],
  "filters" : [ {
    "type" : "string"
  } ],
  "dateIntervals" : [ {
    "start" : "2021-04-07T10:13:22.814277",
    "end" : "2021-04-07T10:13:22.814277"
  } ],
  "callbackUrl" : "string",
  "stringForHash" : "string"
}

POST /personalizations/{personalizationId}/results

Send a request to generate the report for the results of the given personalization

Request arguments

Name	Place	Type	Description
personalizationId	path	long	personalizationId

Request body

DataRequestParams

Name	Type	Description
interval	enum	. Can be [HOUR, DAY, WEEK, MONTH, YEAR]
visitorData	boolean
allVariationsData	boolean
bayesian	boolean
breakdown	Breakdown
goalsIds	array
filters	array[Filter]
dateIntervals	array[DateInterval]
callbackUrl	string
stringForHash	string

Filter

Name	Type	Description
type `*required`	string

Breakdown

Name	Type	Description
type	enum	. Can be [BROWSER, CUSTOM_DATUM, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OS, PAGE_TITLE, NUMBER_PAGES, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, DAYS_OF_WEEK, VISIT_DURATION, WEATHER_CODE, DAY, TEMPERATURE, NUMBER_VISITS, FIRST_REFERRER_URL, MAX_NUMBER_TABS, KEY_PAGE, INTEREST, TARGETING_SEGMENT, TIME_SINCE_PREVIOUS_VISIT, KEYWORD, YSANCE_SEGMENT, YSANCE_ATTRIBUTE, COUNTRY, REGION, CITY, LANGUAGE, JAVA_ENABLED, LANDING_PAGE, TIME_ZONE_GROUP, SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_RESOLUTION, REFERRER, TIME_ZONE_ID, LOCALE_LANGUAGE_CODE, LOCALE_COUNTRY_CODE, LOCALE_LANGUAGE_TAG, PERSONALIZATION_UNEXPOSITION_CAUSE]

DateInterval

Name	Type	Description
start	datetime
end	datetime

DeviceTypeFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [DESKTOP, TABLET, PHONE]
include	boolean

TimeSpentFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

PageURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

AdBlockerFilter

Name	Type	Description
type	string
include	boolean

WeatherFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, ATMOSPHERIC_DISTURBANCES]
include	boolean

KeyPageFilter

Name	Type	Description
type	string
include	boolean
values	array

NumberTabsFilter

Name	Type	Description
type	string
include	boolean
value `*required`	integer

CustomDataFilter

Name	Type	Description
type	string
include	boolean
customDataId `*required`	long
value	string

TimeSlotFilter

Name	Type	Description
type	string
include	boolean
visitorCalendar	boolean
values	array

TargetingSegmentFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NewVisitorFilter

Name	Type	Description
type	string
visitorsType	enum	. Can be [NEW_VISITORS, RETURNING_VISITORS]

FilterContainer

Name	Type	Description
param	enum	. Can be [GREATER, LOWER, EQUAL, BETWEEN]
value	integer
unit	enum	. Can be [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

PageTitleFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

BrowserFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [CHROME, EXPLORER, FIREFOX, SAFARI, OPERA]
include	boolean

FirstReferrerFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NumberVisitsFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

LandingPageURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

NumberPagesFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

TemperatureFilter

Name	Type	Description
type	string
include	boolean
param `*required`	enum	. Can be [GREATER, LOWER, EQUAL, BETWEEN]
from `*required`	integer
to	integer

BrowserLanguageFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [AB, AA, AF, AK, SQ, AM, AR, AN, HY, AS, AV, AE, AY, AZ, BM, BA, EU, BE, BN, BH, BI, BS, BR, BG, MY, CA, CH, CE, NY, ZH, CV, KW, CO, CR, HR, CS, DA, DV, NL, DZ, EN, EO, ET, EE, FO, FJ, FI, FR, FF, GL, KA, DE, EL, GN, GU, HT, HA, HE, HZ, HI, HO, HU, IA, ID, IE, GA, IG, IK, IO, IS, IT, IU, JA, JV, KL, KN, KR, KS, KK, KM, KI, RW, KY, KV, KG, KO, KU, KJ, LA, LB, LG, LI, LN, LO, LT, LU, LV, GV, MK, MG, MS, ML, MT, MI, MR, MH, MN, NA, NV, ND, NE, NG, NB, NN, NO, II, NR, OC, OJ, CU, OM, OR, OS, PA, PI, FA, PL, PS, PT, QU, RM, RN, RO, RU, SA, SC, SD, SE, SM, SG, SR, GD, SN, SI, SK, SL, SO, ST, ES, SU, SW, SS, SV, TA, TE, TG, TH, TI, BO, TK, TL, TN, TO, TR, TS, TT, TW, TY, UG, UK, UR, UZ, VE, VI, VO, WA, CY, WO, FY, XH, YI, YO, ZA, ZU]
include	boolean

DayFilter

Name	Type	Description
type	string
include	boolean

OperatingSystemFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [WINDOWS, MAC_OS, I_OS, LINUX, ANDROID, WINDOWS_PHONE]
include	boolean

ReferrerURLFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

SinceLastVisitFilter

Name	Type	Description
type	string
values `*required`	array[FilterContainer]
include	boolean

TrafficFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [SEO, DIRECT, SEM, EMAIL, AFFILIATION]
include	boolean

ConversionsFilter

Name	Type	Description
type	string
values `*required`	array
include	boolean

WeekdayFilter

Name	Type	Description
type	string
values `*required`	array	. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
include	boolean
visitorCalendar	boolean

CustomDatumBreakdown

Name	Type	Description
type	enum	. Can be [BROWSER, CUSTOM_DATUM, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OS, PAGE_TITLE, NUMBER_PAGES, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, DAYS_OF_WEEK, VISIT_DURATION, WEATHER_CODE, DAY, TEMPERATURE, NUMBER_VISITS, FIRST_REFERRER_URL, MAX_NUMBER_TABS, KEY_PAGE, INTEREST, TARGETING_SEGMENT, TIME_SINCE_PREVIOUS_VISIT, KEYWORD, YSANCE_SEGMENT, YSANCE_ATTRIBUTE, COUNTRY, REGION, CITY, LANGUAGE, JAVA_ENABLED, LANDING_PAGE, TIME_ZONE_GROUP, SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_RESOLUTION, REFERRER, TIME_ZONE_ID, LOCALE_LANGUAGE_CODE, LOCALE_COUNTRY_CODE, LOCALE_LANGUAGE_TAG, PERSONALIZATION_UNEXPOSITION_CAUSE]
index `*required`	integer

{
  "dataCode" : "string"
}

Response body

DataCodeResponseIO

Name	Type	Description
dataCode	string

Partial update personalization

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/personalizations/{personalizationId}"
{
  "name" : "string",
  "mainGoalId" : "string",
  "tags" : [ "[]" ],
  "description" : "string",
  "isArchived" : "false",
  "cssCode" : "string",
  "javaScriptCode" : "string"
}

PATCH /personalizations/{personalizationId}

Update several fields of personalization

Request arguments

Name	Place	Type	Description
personalizationId	path	long	personalizationId
action	query	string	Action to change the status of personalization

Request body

PersonalizationUpdate

Name	Type	Description
name	string	The name of the personalization
mainGoalId	string	The main goal id of the personalization
tags	array	List of tags
description	string	This is description of personalization
isArchived	boolean	If true the personalization is archived
cssCode	string	CSS code to add in the page
javaScriptCode	string	JavaScript code to add in the page

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "variationId" : "123456789",
  "status" : "string",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "goals" : [ "[]" ],
  "customExpositionRate" : "132.987",
  "globalCappingNumberVisitors" : "false",
  "globalCappingVisitorsConfig" : "NUMBER_VISITORS",
  "globalCappingGoalId" : "123456789",
  "visitExpositionFrequency" : "1234",
  "visitorExpositionFrequency" : "1234",
  "expositionFrequencyDelay" : "123456789",
  "multiExpositionFrequencyDelay" : "123456789",
  "cappingPerVisitorExpositions" : "false",
  "visitorExpositionFrequencyMax" : "1234",
  "cappingPerVisitorExposedVisits" : "false",
  "exposedVisitsSameVisitorMax" : "1234",
  "cappingPerVisitorConvertGoal" : "false",
  "cappingPerVisitorGoalId" : "123456789",
  "maxNumberVisitorsExposed" : "123456789",
  "checkConditionsRule" : "ALL_CONDITIONS",
  "priority" : "1234",
  "popIn" : {
    "targetBlank" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "stickyBlock" : {
    "targetBlank" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "imageInPage" : {
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "width" : "string",
    "height" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "redirectURL" : "string",
    "htmlContent" : "string"
  },
  "emailAction" : {
    "emailSolution" : "CUSTOM",
    "solutionKey" : "string",
    "solutionSecret" : "string",
    "solutionUrl" : "string",
    "customSolutionName" : "string",
    "fetchingMethod" : "CUSTOM_DATA",
    "fetchingScript" : "string",
    "customDataIndex" : "1234",
    "emailContentSolution" : "CUSTOM_TEMPLATE",
    "emailTemplateId" : "string",
    "htmlContent" : "string",
    "randomTagId" : "string",
    "headerSenderName" : "string",
    "headerSenderEmail" : "string",
    "headerReplyEmail" : "string",
    "headerEmailSubject" : "string",
    "emailTags" : "string",
    "sendAtOnce" : "false",
    "secondsDelayToSend" : "123456789",
    "neverCancelSending" : "false",
    "goalCancellingId" : "123456789"
  },
  "countDownBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "contentType" : "TEXT",
    "year" : "1234",
    "month" : "1234",
    "dayOfMonth" : "1234",
    "hourOfDay" : "1234",
    "minute" : "1234",
    "second" : "1234",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "textColor" : "string",
    "backgroundColor" : "string"
  },
  "googleForm" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "googleFormURL" : "string",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string"
  },
  "cookieInfoBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "redirectText" : "string",
    "message" : "string"
  },
  "iAdvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  },
  "socialBar" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "urlToShare" : "string",
    "urlType" : "CURRENT",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "orientation" : "HORIZONTAL",
    "marginTop" : "string",
    "marginBottom" : "string",
    "marginLeft" : "string",
    "marginRight" : "string"
  },
  "popInVideo" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "url" : "string",
    "addBackground" : "false",
    "closePopin" : "false",
    "autoPlay" : "false",
    "autoSize" : "false"
  },
  "adBlock" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "type" : "POPIN",
    "actionType" : "SHOW_MESSAGE",
    "imageType" : "NONE",
    "blockNavigationType" : "ALL",
    "messageContent" : "string",
    "messageTitle" : "string",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "showMessage" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "trackAction" : "false",
    "goalName" : "string"
  },
  "visitsCounter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "descriptionText" : "string",
    "counterFromType" : "DAY",
    "counterFromDate" : "2021-04-07T10:13:22.814277",
    "counterFormat" : "FRENCH",
    "minimumVisits" : "123456789"
  },
  "newsLetter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "titleEnabled" : "false",
    "legalNoticeUrl" : "string",
    "backgroundColor" : "string",
    "confirmationText" : "string",
    "backgroundImage" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "type" : "FORM",
    "requestType" : "GET",
    "url" : "string",
    "pageUrl" : "string",
    "emailKey" : "string",
    "overlayEnabled" : "false",
    "outsideClose" : "false",
    "timerClose" : "1234"
  },
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "description" : "string",
  "isArchived" : "false",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "type" : "CLASSIC",
  "createdBy" : "123456789",
  "cssCode" : "string",
  "javaScriptCode" : "string",
  "iadvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  }
}

Response body

Personalization

Name	Type	Description
id	long	This field is generated by the system to uniquely identify a personalization
name	string	The name of the personalization
siteId	long	The website id that a personalization belongs to
variationId	long	The variation id of the given personalization
status	string	The status of the given personalization
dateStatusModified	datetime	Last moment when status was updated
targetingSegmentId	long	Selected targeting segment
mainGoalId	long	Main goal
goals	array	Selected goals
customExpositionRate	double	The segment percentage exposed to personalization
globalCappingNumberVisitors	boolean	This option allows you to set the capping configuration
globalCappingVisitorsConfig	enum	The visitors configuration for threshold of total number of exposed visitors. Can be [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]
globalCappingGoalId	long	The goal for threshold of total number of exposed visitors
visitExpositionFrequency	integer	Exposition frequency during a unique visit
visitorExpositionFrequency	integer	Exposition frequency during a unique visitor
expositionFrequencyDelay	long	Period of time of exposition frequency during different visitors
multiExpositionFrequencyDelay	long	Minimum delay between each exposition
cappingPerVisitorExpositions	boolean	If true stop exposing a same visitor when the total number of expositions exceeds this threshold
visitorExpositionFrequencyMax	integer	Stop exposing a same visitor when the total number of expositions exceeds this threshold
cappingPerVisitorExposedVisits	boolean	If true stop exposing a same visitor when the number of visits exceeds this threshold
exposedVisitsSameVisitorMax	integer	Stop exposing a same visitor when the number of visits exceeds this threshold
cappingPerVisitorConvertGoal	boolean	If true stop exposing a same visitor when the goal is completed
cappingPerVisitorGoalId	long	Stop exposing a same visitor when the goal with given id is completed
maxNumberVisitorsExposed	long	Threshold of the total number of exposed visitors
checkConditionsRule	enum	The behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
priority	integer	The priority of the personalization
popIn	PopIn	Pop-In settings
stickyBlock	StickyBlock	Sticky block settings
imageInPage	ImageInPage	Settings of an image in page
emailAction	EmailAction	Settings of an email
countDownBanner	CountDownBanner	Settings of a countdown banner widget
googleForm	GoogleForm	Settings of a Google form widget
cookieInfoBanner	CookieInfoBanner	Settings of a cookie banner widget
iAdvize	IAdvize	Settings of an iAdvize chat widget
socialBar	SocialBar	Settings of a social sharing bar widget
popInVideo	PopInVideo	Settings of a video pop-in widget
adBlock	AdBlock	Settings of an Adblocker widget
visitsCounter	VisitsCounter	Settings of a visits counter widget
newsLetter	NewsLetter	Settings of a newsletter subscription form widget
trackingTools	array[TrackingTool]	List of tracking tools
tags	array	List of tags
dateCreated	datetime	Date and time when personalization was created
dateStarted	datetime	Date and time when personalization was started
description	string	This is description of personalization
isArchived	boolean	If true the personalization is archived
dateModified	datetime	Date and time when personalization was updated last time
type	enum	Type of personalization. Can be [CLASSIC, AUTOPROMO, IA, MAIL]
createdBy	long	Account id to whom created this personalization
cssCode	string	CSS code to add in the page
javaScriptCode	string	JavaScript code to add in the page
iadvize	IAdvize	Settings of an iAdvize chat widget

IAdvize

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
iAdvizeIdentifier	string
platformType	enum	. Can be [STANDARD, HIGH_AVAILABILITY]
iadvizeIdentifier	string

VisitsCounter

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
descriptionText	string
counterFromType	enum	. Can be [DAY, WEEK, DAYS_15, PRECISE_DATE]
counterFromDate	datetime
counterFormat	enum	. Can be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
minimumVisits	long

AdBlock

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
type	enum	. Can be [POPIN, STICKY_BLOCK]
actionType	enum	. Can be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
imageType	enum	. Can be [NONE, DEFAULT, CUSTOM]
blockNavigationType	enum	. Can be [ALL, OPAQUE, REDIRECT]
messageContent	string
messageTitle	string
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
fontSize	string
textColor	string
backgroundColor	string
image	Image
showMessage	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
shouldScrollTo	boolean
shiftContent	boolean
trackAction	boolean
goalName	string

PopInVideo

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
url	string
addBackground	boolean
closePopin	boolean
autoPlay	boolean
autoSize	boolean

Image

Name	Type	Description
siteId	long
source	string
fileName	string
width	integer
height	integer
colorDepth	integer
fileWeight	long
shared	boolean
baseColor	integer
format	enum	. Can be [PNG, JPEG, GIF]
name	string
date	datetime
keywords	array

PopIn

Name	Type	Description
targetBlank	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

ImageInPage

Name	Type	Description
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
width	string
height	string
image	Image
redirectURL	string
htmlContent	string

GoogleForm

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
googleFormURL	string
withOverlay	boolean
closeWithClickOnOverlay	boolean
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string

SocialBar

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
urlToShare	string
urlType	enum	. Can be [CURRENT, FIXED]
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
orientation	enum	. Can be [HORIZONTAL, VERTICAL]
marginTop	string
marginBottom	string
marginLeft	string
marginRight	string

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
titleEnabled	boolean
legalNoticeUrl	string
backgroundColor	string
confirmationText	string
backgroundImage	Image
type	enum	. Can be [FORM, SERVICE]
requestType	enum	. Can be [GET, POST]
url	string
pageUrl	string
emailKey	string
overlayEnabled	boolean
outsideClose	boolean
timerClose	integer

StickyBlock

Name	Type	Description
targetBlank	boolean
shouldScrollTo	boolean
shiftContent	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

EmailAction

Name	Type	Description
emailSolution	enum	. Can be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
solutionKey	string
solutionSecret	string
solutionUrl	string
customSolutionName	string
fetchingMethod	enum	. Can be [CUSTOM_DATA, SCRIPT, NONE]
fetchingScript	string
customDataIndex	integer
emailContentSolution	enum	. Can be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
emailTemplateId	string
htmlContent	string
randomTagId	string
headerSenderName	string
headerSenderEmail	string
headerReplyEmail	string
headerEmailSubject	string
emailTags	string
sendAtOnce	boolean
secondsDelayToSend	long
neverCancelSending	boolean
goalCancellingId	long

CookieInfoBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
redirectText	string
message	string

CountDownBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
textContent	string
htmlContent	string
contentType	enum	. Can be [TEXT, HTML]
year	integer
month	integer
dayOfMonth	integer
hourOfDay	integer
minute	integer
second	integer
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
textColor	string
backgroundColor	string

Remove personalization

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/personalizations/{personalizationId}"

DELETE /personalizations/{personalizationId}

Remove personalization with given id

Request arguments

Name	Place	Type	Description
personalizationId	path	long	personalizationId

Get one personalization

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/personalizations/{personalizationId}"

GET /personalizations/{personalizationId}

Get one personalization with given id

Request arguments

Name	Place	Type	Description
personalizationId	path	long	personalizationId
optionalFields	query	array	optionalFields

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "variationId" : "123456789",
  "status" : "string",
  "dateStatusModified" : "2021-04-07T10:13:22.814277",
  "targetingSegmentId" : "123456789",
  "mainGoalId" : "123456789",
  "goals" : [ "[]" ],
  "customExpositionRate" : "132.987",
  "globalCappingNumberVisitors" : "false",
  "globalCappingVisitorsConfig" : "NUMBER_VISITORS",
  "globalCappingGoalId" : "123456789",
  "visitExpositionFrequency" : "1234",
  "visitorExpositionFrequency" : "1234",
  "expositionFrequencyDelay" : "123456789",
  "multiExpositionFrequencyDelay" : "123456789",
  "cappingPerVisitorExpositions" : "false",
  "visitorExpositionFrequencyMax" : "1234",
  "cappingPerVisitorExposedVisits" : "false",
  "exposedVisitsSameVisitorMax" : "1234",
  "cappingPerVisitorConvertGoal" : "false",
  "cappingPerVisitorGoalId" : "123456789",
  "maxNumberVisitorsExposed" : "123456789",
  "checkConditionsRule" : "ALL_CONDITIONS",
  "priority" : "1234",
  "popIn" : {
    "targetBlank" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "stickyBlock" : {
    "targetBlank" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "name" : "string",
    "position" : "TOP",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
    "animationType" : "NONE",
    "animationDirection" : "TOP",
    "animationTrigger" : "ON_OPEN",
    "imageDesktop" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageDesktop" : "string",
    "heightImageDesktop" : "string",
    "imageTablet" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageTablet" : "string",
    "heightImageTablet" : "string",
    "imageMobile" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "widthImageMobile" : "string",
    "heightImageMobile" : "string",
    "idTarget2Sell" : "string",
    "redirectURL" : "string",
    "type" : "SINGLE_IMAGE",
    "template" : "false"
  },
  "imageInPage" : {
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "width" : "string",
    "height" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "redirectURL" : "string",
    "htmlContent" : "string"
  },
  "emailAction" : {
    "emailSolution" : "CUSTOM",
    "solutionKey" : "string",
    "solutionSecret" : "string",
    "solutionUrl" : "string",
    "customSolutionName" : "string",
    "fetchingMethod" : "CUSTOM_DATA",
    "fetchingScript" : "string",
    "customDataIndex" : "1234",
    "emailContentSolution" : "CUSTOM_TEMPLATE",
    "emailTemplateId" : "string",
    "htmlContent" : "string",
    "randomTagId" : "string",
    "headerSenderName" : "string",
    "headerSenderEmail" : "string",
    "headerReplyEmail" : "string",
    "headerEmailSubject" : "string",
    "emailTags" : "string",
    "sendAtOnce" : "false",
    "secondsDelayToSend" : "123456789",
    "neverCancelSending" : "false",
    "goalCancellingId" : "123456789"
  },
  "countDownBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "textContent" : "string",
    "htmlContent" : "string",
    "contentType" : "TEXT",
    "year" : "1234",
    "month" : "1234",
    "dayOfMonth" : "1234",
    "hourOfDay" : "1234",
    "minute" : "1234",
    "second" : "1234",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "textColor" : "string",
    "backgroundColor" : "string"
  },
  "googleForm" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "googleFormURL" : "string",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string"
  },
  "cookieInfoBanner" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "redirectText" : "string",
    "message" : "string"
  },
  "iAdvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  },
  "socialBar" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "urlToShare" : "string",
    "urlType" : "CURRENT",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "orientation" : "HORIZONTAL",
    "marginTop" : "string",
    "marginBottom" : "string",
    "marginLeft" : "string",
    "marginRight" : "string"
  },
  "popInVideo" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "url" : "string",
    "addBackground" : "false",
    "closePopin" : "false",
    "autoPlay" : "false",
    "autoSize" : "false"
  },
  "adBlock" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "redirectURL" : "string",
    "positionDefinition" : "EDITOR",
    "domElementSelector" : "string",
    "positionSelectorRelative" : "REPLACE",
    "mainPageUrl" : "string",
    "type" : "POPIN",
    "actionType" : "SHOW_MESSAGE",
    "imageType" : "NONE",
    "blockNavigationType" : "ALL",
    "messageContent" : "string",
    "messageTitle" : "string",
    "verticalAlignmentType" : "TOP",
    "horizontalAlignmentType" : "LEFT",
    "fontSize" : "string",
    "textColor" : "string",
    "backgroundColor" : "string",
    "image" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "showMessage" : "false",
    "withOverlay" : "false",
    "closeWithClickOnOverlay" : "false",
    "shouldScrollTo" : "false",
    "shiftContent" : "false",
    "trackAction" : "false",
    "goalName" : "string"
  },
  "visitsCounter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "descriptionText" : "string",
    "counterFromType" : "DAY",
    "counterFromDate" : "2021-04-07T10:13:22.814277",
    "counterFormat" : "FRENCH",
    "minimumVisits" : "123456789"
  },
  "newsLetter" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "titleEnabled" : "false",
    "legalNoticeUrl" : "string",
    "backgroundColor" : "string",
    "confirmationText" : "string",
    "backgroundImage" : {
      "siteId" : "123456789",
      "source" : "string",
      "fileName" : "string",
      "width" : "1234",
      "height" : "1234",
      "colorDepth" : "1234",
      "fileWeight" : "123456789",
      "shared" : "false",
      "baseColor" : "1234",
      "format" : "PNG",
      "name" : "string",
      "date" : "2021-04-07T10:13:22.814277",
      "keywords" : [ "[]" ]
    },
    "type" : "FORM",
    "requestType" : "GET",
    "url" : "string",
    "pageUrl" : "string",
    "emailKey" : "string",
    "overlayEnabled" : "false",
    "outsideClose" : "false",
    "timerClose" : "1234"
  },
  "trackingTools" : [ {
    "type" : "GOOGLE_ANALYTICS",
    "customVariable" : "1234",
    "googleAnalyticsTracker" : "string",
    "universalAnalyticsDimension" : "1234",
    "adobeOmnitureObject" : "string",
    "eulerianUserCentricParameter" : "string",
    "heatMapPageWidth" : "1234",
    "comScoreCustomerId" : "string",
    "comScoreDomain" : "string",
    "reportingScript" : "string"
  } ],
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateStarted" : "2021-04-07T10:13:22.814277",
  "description" : "string",
  "isArchived" : "false",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "type" : "CLASSIC",
  "createdBy" : "123456789",
  "cssCode" : "string",
  "javaScriptCode" : "string",
  "iadvize" : {
    "position" : "TOP",
    "width" : "string",
    "height" : "string",
    "customPositionAxisX" : "string",
    "customPositionAxisY" : "string",
    "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
    "personalizationPluginLocation" : "INSIDE_PAGES",
    "iAdvizeIdentifier" : "string",
    "platformType" : "STANDARD",
    "iadvizeIdentifier" : "string"
  }
}

Response body

Personalization

Name	Type	Description
id	long	This field is generated by the system to uniquely identify a personalization
name	string	The name of the personalization
siteId	long	The website id that a personalization belongs to
variationId	long	The variation id of the given personalization
status	string	The status of the given personalization
dateStatusModified	datetime	Last moment when status was updated
targetingSegmentId	long	Selected targeting segment
mainGoalId	long	Main goal
goals	array	Selected goals
customExpositionRate	double	The segment percentage exposed to personalization
globalCappingNumberVisitors	boolean	This option allows you to set the capping configuration
globalCappingVisitorsConfig	enum	The visitors configuration for threshold of total number of exposed visitors. Can be [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]
globalCappingGoalId	long	The goal for threshold of total number of exposed visitors
visitExpositionFrequency	integer	Exposition frequency during a unique visit
visitorExpositionFrequency	integer	Exposition frequency during a unique visitor
expositionFrequencyDelay	long	Period of time of exposition frequency during different visitors
multiExpositionFrequencyDelay	long	Minimum delay between each exposition
cappingPerVisitorExpositions	boolean	If true stop exposing a same visitor when the total number of expositions exceeds this threshold
visitorExpositionFrequencyMax	integer	Stop exposing a same visitor when the total number of expositions exceeds this threshold
cappingPerVisitorExposedVisits	boolean	If true stop exposing a same visitor when the number of visits exceeds this threshold
exposedVisitsSameVisitorMax	integer	Stop exposing a same visitor when the number of visits exceeds this threshold
cappingPerVisitorConvertGoal	boolean	If true stop exposing a same visitor when the goal is completed
cappingPerVisitorGoalId	long	Stop exposing a same visitor when the goal with given id is completed
maxNumberVisitorsExposed	long	Threshold of the total number of exposed visitors
checkConditionsRule	enum	The behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
priority	integer	The priority of the personalization
popIn	PopIn	Pop-In settings
stickyBlock	StickyBlock	Sticky block settings
imageInPage	ImageInPage	Settings of an image in page
emailAction	EmailAction	Settings of an email
countDownBanner	CountDownBanner	Settings of a countdown banner widget
googleForm	GoogleForm	Settings of a Google form widget
cookieInfoBanner	CookieInfoBanner	Settings of a cookie banner widget
iAdvize	IAdvize	Settings of an iAdvize chat widget
socialBar	SocialBar	Settings of a social sharing bar widget
popInVideo	PopInVideo	Settings of a video pop-in widget
adBlock	AdBlock	Settings of an Adblocker widget
visitsCounter	VisitsCounter	Settings of a visits counter widget
newsLetter	NewsLetter	Settings of a newsletter subscription form widget
trackingTools	array[TrackingTool]	List of tracking tools
tags	array	List of tags
dateCreated	datetime	Date and time when personalization was created
dateStarted	datetime	Date and time when personalization was started
description	string	This is description of personalization
isArchived	boolean	If true the personalization is archived
dateModified	datetime	Date and time when personalization was updated last time
type	enum	Type of personalization. Can be [CLASSIC, AUTOPROMO, IA, MAIL]
createdBy	long	Account id to whom created this personalization
cssCode	string	CSS code to add in the page
javaScriptCode	string	JavaScript code to add in the page
iadvize	IAdvize	Settings of an iAdvize chat widget

IAdvize

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
iAdvizeIdentifier	string
platformType	enum	. Can be [STANDARD, HIGH_AVAILABILITY]
iadvizeIdentifier	string

VisitsCounter

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
descriptionText	string
counterFromType	enum	. Can be [DAY, WEEK, DAYS_15, PRECISE_DATE]
counterFromDate	datetime
counterFormat	enum	. Can be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
minimumVisits	long

AdBlock

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
type	enum	. Can be [POPIN, STICKY_BLOCK]
actionType	enum	. Can be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
imageType	enum	. Can be [NONE, DEFAULT, CUSTOM]
blockNavigationType	enum	. Can be [ALL, OPAQUE, REDIRECT]
messageContent	string
messageTitle	string
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
fontSize	string
textColor	string
backgroundColor	string
image	Image
showMessage	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
shouldScrollTo	boolean
shiftContent	boolean
trackAction	boolean
goalName	string

PopInVideo

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
url	string
addBackground	boolean
closePopin	boolean
autoPlay	boolean
autoSize	boolean

Image

Name	Type	Description
siteId	long
source	string
fileName	string
width	integer
height	integer
colorDepth	integer
fileWeight	long
shared	boolean
baseColor	integer
format	enum	. Can be [PNG, JPEG, GIF]
name	string
date	datetime
keywords	array

PopIn

Name	Type	Description
targetBlank	boolean
withOverlay	boolean
closeWithClickOnOverlay	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

TrackingTool

Name	Type	Description
type	enum	. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
customVariable	integer
googleAnalyticsTracker	string
universalAnalyticsDimension	integer
adobeOmnitureObject	string
eulerianUserCentricParameter	string
heatMapPageWidth	integer
comScoreCustomerId	string
comScoreDomain	string
reportingScript	string

ImageInPage

Name	Type	Description
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
width	string
height	string
image	Image
redirectURL	string
htmlContent	string

GoogleForm

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
googleFormURL	string
withOverlay	boolean
closeWithClickOnOverlay	boolean
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string

SocialBar

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
urlToShare	string
urlType	enum	. Can be [CURRENT, FIXED]
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
orientation	enum	. Can be [HORIZONTAL, VERTICAL]
marginTop	string
marginBottom	string
marginLeft	string
marginRight	string

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
titleEnabled	boolean
legalNoticeUrl	string
backgroundColor	string
confirmationText	string
backgroundImage	Image
type	enum	. Can be [FORM, SERVICE]
requestType	enum	. Can be [GET, POST]
url	string
pageUrl	string
emailKey	string
overlayEnabled	boolean
outsideClose	boolean
timerClose	integer

StickyBlock

Name	Type	Description
targetBlank	boolean
shouldScrollTo	boolean
shiftContent	boolean
name	string
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
fontSize	string
textColor	string
backgroundColor	string
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
textContent	string
htmlContent	string
image	Image
displayImageConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
animationType	enum	. Can be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
animationDirection	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
animationTrigger	enum	. Can be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
imageDesktop	Image
widthImageDesktop	string
heightImageDesktop	string
imageTablet	Image
widthImageTablet	string
heightImageTablet	string
imageMobile	Image
widthImageMobile	string
heightImageMobile	string
idTarget2Sell	string
redirectURL	string
type	enum	. Can be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
template	boolean

EmailAction

Name	Type	Description
emailSolution	enum	. Can be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
solutionKey	string
solutionSecret	string
solutionUrl	string
customSolutionName	string
fetchingMethod	enum	. Can be [CUSTOM_DATA, SCRIPT, NONE]
fetchingScript	string
customDataIndex	integer
emailContentSolution	enum	. Can be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
emailTemplateId	string
htmlContent	string
randomTagId	string
headerSenderName	string
headerSenderEmail	string
headerReplyEmail	string
headerEmailSubject	string
emailTags	string
sendAtOnce	boolean
secondsDelayToSend	long
neverCancelSending	boolean
goalCancellingId	long

CookieInfoBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
redirectText	string
message	string

CountDownBanner

Name	Type	Description
position	enum	. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
width	string
height	string
customPositionAxisX	string
customPositionAxisY	string
displayPluginConfiguration	enum	. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
personalizationPluginLocation	enum	. Can be [INSIDE_PAGES, ABOVE_PAGES]
redirectURL	string
positionDefinition	enum	. Can be [EDITOR, SELECTOR]
domElementSelector	string
positionSelectorRelative	enum	. Can be [REPLACE, BEFORE, AFTER]
mainPageUrl	string
textContent	string
htmlContent	string
contentType	enum	. Can be [TEXT, HTML]
year	integer
month	integer
dayOfMonth	integer
hourOfDay	integer
minute	integer
second	integer
verticalAlignmentType	enum	. Can be [TOP, CENTER, BOTTOM]
horizontalAlignmentType	enum	. Can be [LEFT, CENTER, RIGHT]
textColor	string
backgroundColor	string

Referrers

Referrer is an advanced tool that allows you to target visitors according to acquisition methods that lead them to your website. Kameleoon automatically creates 5 default channels: Bing, Baidu, Google, Yahoo and Google Adwords.

Partial update referrer

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/referrers/{referrerId}"
{
  "name" : "string",
  "priority" : "1234",
  "tags" : "string",
  "detections" : [ {
    "method" : "string",
    "parameters" : "string",
    "and" : "false",
    "andMethod" : "string",
    "andParameters" : "string"
  } ]
}

PATCH /referrers/{referrerId}

Update several fields of a referrer

Request arguments

Name	Place	Type	Description
referrerId	path	long	referrerId

Request body

ReferrerUpdate

Name	Type	Description
name	string	The name of the referrer
priority	integer	Priority for the given referrer
tags	string	Tags associated with the given referrer
detections	array[ReferrerDetection]

ReferrerDetection

Name	Type	Description
method	string
parameters	string
and	boolean
andMethod	string
andParameters	string

{
  "id" : "123456789",
  "index" : "1234",
  "name" : "string",
  "priority" : "1234",
  "tags" : "string",
  "detections" : [ {
    "method" : "string",
    "parameters" : "string",
    "and" : "false",
    "andMethod" : "string",
    "andParameters" : "string"
  } ],
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

Referrer

Name	Type	Description
id	long	The unique identifier of the given referrer
index	integer	The index of the referrer
name	string	The name of the referrer
priority	integer	Priority for the given referrer
tags	string	Tags associated with the given referrer
detections	array[ReferrerDetection]
creationDate	datetime	Date and time referred is created
modificationDate	datetime	Date and time referred is modified
siteId	long	Unique site identifier assigned with the referrer

ReferrerDetection

Name	Type	Description
method	string
parameters	string
and	boolean
andMethod	string
andParameters	string

Remove referrer

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/referrers/{referrerId}"

DELETE /referrers/{referrerId}

Remove referrer with given id

Request arguments

Name	Place	Type	Description
referrerId	path	long	referrerId

Get one referrer

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/referrers/{referrerId}"

GET /referrers/{referrerId}

Get one referrer with given id

Request arguments

Name	Place	Type	Description
referrerId	path	long	referrerId

{
  "id" : "123456789",
  "index" : "1234",
  "name" : "string",
  "priority" : "1234",
  "tags" : "string",
  "detections" : [ {
    "method" : "string",
    "parameters" : "string",
    "and" : "false",
    "andMethod" : "string",
    "andParameters" : "string"
  } ],
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

Referrer

Name	Type	Description
id	long	The unique identifier of the given referrer
index	integer	The index of the referrer
name	string	The name of the referrer
priority	integer	Priority for the given referrer
tags	string	Tags associated with the given referrer
detections	array[ReferrerDetection]
creationDate	datetime	Date and time referred is created
modificationDate	datetime	Date and time referred is modified
siteId	long	Unique site identifier assigned with the referrer

ReferrerDetection

Name	Type	Description
method	string
parameters	string
and	boolean
andMethod	string
andParameters	string

Update referrer

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/referrers/{referrerId}"
{
  "id" : "123456789",
  "index" : "1234",
  "name" : "string",
  "priority" : "1234",
  "tags" : "string",
  "detections" : [ {
    "method" : "string",
    "parameters" : "string",
    "and" : "false",
    "andMethod" : "string",
    "andParameters" : "string"
  } ],
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

PUT /referrers/{referrerId}

Update referrer with given id

Request arguments

Name	Place	Type	Description
referrerId	path	long	referrerId

Request body

Referrer

Name	Type	Description
id `*read only`	long	The unique identifier of the given referrer
index `*read only`	integer	The index of the referrer
name	string	The name of the referrer
priority	integer	Priority for the given referrer
tags	string	Tags associated with the given referrer
detections	array[ReferrerDetection]
creationDate `*read only`	datetime	Date and time referred is created
modificationDate `*read only`	datetime	Date and time referred is modified
siteId	long	Unique site identifier assigned with the referrer

ReferrerDetection

Name	Type	Description
method	string
parameters	string
and	boolean
andMethod	string
andParameters	string

{
  "id" : "123456789",
  "index" : "1234",
  "name" : "string",
  "priority" : "1234",
  "tags" : "string",
  "detections" : [ {
    "method" : "string",
    "parameters" : "string",
    "and" : "false",
    "andMethod" : "string",
    "andParameters" : "string"
  } ],
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

Referrer

Name	Type	Description
id	long	The unique identifier of the given referrer
index	integer	The index of the referrer
name	string	The name of the referrer
priority	integer	Priority for the given referrer
tags	string	Tags associated with the given referrer
detections	array[ReferrerDetection]
creationDate	datetime	Date and time referred is created
modificationDate	datetime	Date and time referred is modified
siteId	long	Unique site identifier assigned with the referrer

ReferrerDetection

Name	Type	Description
method	string
parameters	string
and	boolean
andMethod	string
andParameters	string

Create new referrer

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/referrers"
{
  "id" : "123456789",
  "index" : "1234",
  "name" : "string",
  "priority" : "1234",
  "tags" : "string",
  "detections" : [ {
    "method" : "string",
    "parameters" : "string",
    "and" : "false",
    "andMethod" : "string",
    "andParameters" : "string"
  } ],
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

POST /referrers

Create new referrer with given parameters

Request body

Referrer

Name	Type	Description
id `*read only`	long	The unique identifier of the given referrer
index `*read only`	integer	The index of the referrer
name	string	The name of the referrer
priority	integer	Priority for the given referrer
tags	string	Tags associated with the given referrer
detections	array[ReferrerDetection]
creationDate `*read only`	datetime	Date and time referred is created
modificationDate `*read only`	datetime	Date and time referred is modified
siteId	long	Unique site identifier assigned with the referrer

ReferrerDetection

Name	Type	Description
method	string
parameters	string
and	boolean
andMethod	string
andParameters	string

{
  "id" : "123456789",
  "index" : "1234",
  "name" : "string",
  "priority" : "1234",
  "tags" : "string",
  "detections" : [ {
    "method" : "string",
    "parameters" : "string",
    "and" : "false",
    "andMethod" : "string",
    "andParameters" : "string"
  } ],
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
}

Response body

Referrer

Name	Type	Description
id	long	The unique identifier of the given referrer
index	integer	The index of the referrer
name	string	The name of the referrer
priority	integer	Priority for the given referrer
tags	string	Tags associated with the given referrer
detections	array[ReferrerDetection]
creationDate	datetime	Date and time referred is created
modificationDate	datetime	Date and time referred is modified
siteId	long	Unique site identifier assigned with the referrer

ReferrerDetection

Name	Type	Description
method	string
parameters	string
and	boolean
andMethod	string
andParameters	string

List custom referrers

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/referrers"

GET /referrers

Get list of all referrers

[ {
  "id" : "123456789",
  "index" : "1234",
  "name" : "string",
  "priority" : "1234",
  "tags" : "string",
  "detections" : [ {
    "method" : "string",
    "parameters" : "string",
    "and" : "false",
    "andMethod" : "string",
    "andParameters" : "string"
  } ],
  "creationDate" : "2021-04-07T10:13:22.814277",
  "modificationDate" : "2021-04-07T10:13:22.814277",
  "siteId" : "123456789"
} ]

Response body

Referrer

Name	Type	Description
id	long	The unique identifier of the given referrer
index	integer	The index of the referrer
name	string	The name of the referrer
priority	integer	Priority for the given referrer
tags	string	Tags associated with the given referrer
detections	array[ReferrerDetection]
creationDate	datetime	Date and time referred is created
modificationDate	datetime	Date and time referred is modified
siteId	long	Unique site identifier assigned with the referrer

ReferrerDetection

Name	Type	Description
method	string
parameters	string
and	boolean
andMethod	string
andParameters	string

Results

poll

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/results"

GET /results

Request arguments

Name	Place	Type	Description
dataCode	query	string	dataCode

{
  "status" : "ERROR",
  "data" : {
    "dataCode" : "string",
    "variationData" : "",
    "ventilationNames" : ""
  }
}

Response body

DataRequestResultIO

Name	Type	Description
status	enum	. Can be [ERROR, READY, WAITING]
data	DataResultIO

DataResultIO

Name	Type	Description
dataCode	string
variationData	map
ventilationNames	map

Segments

Segmentation helps you precisely target your visitors. You can create, modify and duplicate segments with Segment Builder, a tool in Kameleoon's back office or through our Automation API.

Partial update segment

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/segments/{segmentId}"
{
  "name" : "string",
  "description" : "string",
  "audienceTracking" : "false",
  "isFavorite" : "false",
  "tags" : [ "[]" ]
}

PATCH /segments/{segmentId}

Update several fields of a segment besides 'conditionData'. Use PUT method to update many conditions. Or use the separate PATCH method to update a single condition

Request arguments

Name	Place	Type	Description
segmentId	path	long	segmentId

Request body

SegmentUpdate

Name	Type	Description
name	string	Name of segment
description	string	Description of segment
audienceTracking	boolean	Segment is used in audience
isFavorite	boolean
tags	array

{
  "id" : "123456789",
  "name" : "string",
  "description" : "string",
  "conditionsData" : {
    "firstLevelOrOperators" : [ "[]" ],
    "firstLevel" : [ {
      "orOperators" : [ "[]" ],
      "conditions" : [ {
        "id" : "123456789",
        "targetingType" : "PAGE_URL",
        "weight" : "1234"
      } ]
    } ]
  },
  "siteId" : "123456789",
  "audienceTracking" : "false",
  "audienceTrackingEditable" : "false",
  "isFavorite" : "false",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

Response body

Segment

Name	Type	Description
id	long	Unique identifier of segment
name	string	Name of segment
description	string	Description of segment
conditionsData	ConditionsData	Conditions by which visitors will be segmented
siteId	long	Unique identifier of site for which the segment is going to be or was created
audienceTracking	boolean	Segment is used in audience
audienceTrackingEditable	boolean	This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking can't be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.
isFavorite	boolean	Indicates whether the segment is considered as favorite.
dateCreated	datetime
dateModified	datetime
tags	array
experimentAmount	long	Number of experiments using this segment. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this segment. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this segment. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this segment. This is an optional field needs to specify in request params.

ConditionsData

Name	Type	Description
firstLevelOrOperators	array	Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.
firstLevel	array[FirstLevel]	First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)

TargetingCondition

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

FirstLevel

Name	Type	Description
orOperators	array	Array of booleans ("or"=true, "and"=false) for binding conditions of second level.
conditions	array[TargetingCondition]	Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.

ORIGIN_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
trafficType	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
elementType	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
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'

BelongingPriceParams

Name	Type	Description
value	integer	To which fraction of products the product belongs
productWayOfCounting	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Number of visits for today
matchType	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyWordIndex	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
event	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	string	Since time. Time format: hh:MM
to	string	To time. Time format: hh:MM
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Landing URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
dayPeriod	enum	. Can be [DAY, NIGHT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitorsType	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

FORECAST_SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

DEVICE_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
device	enum	. Can be [DESKTOP, TABLET, PHONE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
audiences	array[TealiumAudience]	List of tealium audiences
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
country	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
jsCode	string	Custom JavaScript condition
applied	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
badges	array[TealiumBadge]	List of tealium badges
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
attribute	string	Ysance attribute
value	string	Attribute value
valueMatchType	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
name	string	Cookie name
value	string	Cookie value
nameMatchType	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
segments	array	Ysance segments
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
day	enum	. Can be [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'

PAGE_TITLE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
title	string	Title template
matchType	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
lowerBound	integer	Lower bound of the probability in percents. Max value: 100
upperBound	integer	Upper bound of the probability in percents. Max value: 100
goalId	long	Unique identifier of a goal
keyMomentId	long	Unique identifier of a key moment
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
browser	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id	long	Badge unique identifier
name	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Previous page URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyPageIndex	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	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'

FIRST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
pageCount	integer	Number of page views
matchType	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Referring website URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
language	string	Browser language code in ISO 639-1
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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'

OPERATING_SYSTEM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
os	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
period	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count	integer	Amount of visits
countMatchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
interestIndex	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Total amount of visits
matchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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
value	string	Value which was retrieved by specified custom data
valueMatchType	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	Unique identifier of a goal expected to be converted
probability	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	URL template
matchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id	string	Audience unique identifier
name	string	Audience name

TABS_ON_SITE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
tabCount	integer	Number of tabs opened
matchType	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

Remove segment

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/segments/{segmentId}"

DELETE /segments/{segmentId}

Remove segment with given id

Request arguments

Name	Place	Type	Description
segmentId	path	long	segmentId

Get one segment

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/segments/{segmentId}"

GET /segments/{segmentId}

Get one segment with given id

Request arguments

Name	Place	Type	Description
segmentId	path	long	segmentId
optionalFields	query	array	optionalFields

{
  "id" : "123456789",
  "name" : "string",
  "description" : "string",
  "conditionsData" : {
    "firstLevelOrOperators" : [ "[]" ],
    "firstLevel" : [ {
      "orOperators" : [ "[]" ],
      "conditions" : [ {
        "id" : "123456789",
        "targetingType" : "PAGE_URL",
        "weight" : "1234"
      } ]
    } ]
  },
  "siteId" : "123456789",
  "audienceTracking" : "false",
  "audienceTrackingEditable" : "false",
  "isFavorite" : "false",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

Response body

Segment

Name	Type	Description
id	long	Unique identifier of segment
name	string	Name of segment
description	string	Description of segment
conditionsData	ConditionsData	Conditions by which visitors will be segmented
siteId	long	Unique identifier of site for which the segment is going to be or was created
audienceTracking	boolean	Segment is used in audience
audienceTrackingEditable	boolean	This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking can't be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.
isFavorite	boolean	Indicates whether the segment is considered as favorite.
dateCreated	datetime
dateModified	datetime
tags	array
experimentAmount	long	Number of experiments using this segment. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this segment. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this segment. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this segment. This is an optional field needs to specify in request params.

ConditionsData

Name	Type	Description
firstLevelOrOperators	array	Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.
firstLevel	array[FirstLevel]	First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)

TargetingCondition

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

FirstLevel

Name	Type	Description
orOperators	array	Array of booleans ("or"=true, "and"=false) for binding conditions of second level.
conditions	array[TargetingCondition]	Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.

ORIGIN_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
trafficType	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
elementType	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
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'

BelongingPriceParams

Name	Type	Description
value	integer	To which fraction of products the product belongs
productWayOfCounting	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Number of visits for today
matchType	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyWordIndex	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
event	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	string	Since time. Time format: hh:MM
to	string	To time. Time format: hh:MM
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Landing URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
dayPeriod	enum	. Can be [DAY, NIGHT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitorsType	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

FORECAST_SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

DEVICE_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
device	enum	. Can be [DESKTOP, TABLET, PHONE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
audiences	array[TealiumAudience]	List of tealium audiences
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
country	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
jsCode	string	Custom JavaScript condition
applied	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
badges	array[TealiumBadge]	List of tealium badges
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
attribute	string	Ysance attribute
value	string	Attribute value
valueMatchType	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
name	string	Cookie name
value	string	Cookie value
nameMatchType	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
segments	array	Ysance segments
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
day	enum	. Can be [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'

PAGE_TITLE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
title	string	Title template
matchType	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
lowerBound	integer	Lower bound of the probability in percents. Max value: 100
upperBound	integer	Upper bound of the probability in percents. Max value: 100
goalId	long	Unique identifier of a goal
keyMomentId	long	Unique identifier of a key moment
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
browser	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id	long	Badge unique identifier
name	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Previous page URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyPageIndex	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	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'

FIRST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
pageCount	integer	Number of page views
matchType	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Referring website URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
language	string	Browser language code in ISO 639-1
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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'

OPERATING_SYSTEM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
os	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
period	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count	integer	Amount of visits
countMatchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
interestIndex	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Total amount of visits
matchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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
value	string	Value which was retrieved by specified custom data
valueMatchType	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	Unique identifier of a goal expected to be converted
probability	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	URL template
matchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id	string	Audience unique identifier
name	string	Audience name

TABS_ON_SITE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
tabCount	integer	Number of tabs opened
matchType	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

Update segment

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/segments/{segmentId}"
{
  "id" : "123456789",
  "name" : "string",
  "description" : "string",
  "conditionsData" : {
    "firstLevelOrOperators" : [ "[]" ],
    "firstLevel" : [ {
      "orOperators" : [ "[]" ],
      "conditions" : [ {
        "id" : "123456789",
        "targetingType" : "PAGE_URL",
        "weight" : "1234"
      } ]
    } ]
  },
  "siteId" : "123456789",
  "audienceTracking" : "false",
  "audienceTrackingEditable" : "false",
  "isFavorite" : "false",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

PUT /segments/{segmentId}

Update segment with given id

Request arguments

Name	Place	Type	Description
segmentId	path	long	segmentId

Request body

Segment

Name	Type	Description
id `*read only`	long	Unique identifier of segment
name `*required`	string	Name of segment
description	string	Description of segment
conditionsData	ConditionsData	Conditions by which visitors will be segmented
siteId `*required`	long	Unique identifier of site for which the segment is going to be or was created
audienceTracking	boolean	Segment is used in audience
audienceTrackingEditable `*read only`	boolean	This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking can't be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.
isFavorite	boolean	Indicates whether the segment is considered as favorite.
dateCreated `*read only`	datetime
dateModified `*read only`	datetime
tags	array
experimentAmount `*read only`	long	Number of experiments using this segment. This is an optional field needs to specify in request params.
personalizationAmount `*read only`	long	Number of personalizations using this segment. This is an optional field needs to specify in request params.
experiments `*read only`	array	List of experiment ids using this segment. This is an optional field needs to specify in request params.
personalizations `*read only`	array	List of personalization ids using this segment. This is an optional field needs to specify in request params.

ConditionsData

Name	Type	Description
firstLevelOrOperators	array	Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.
firstLevel	array[FirstLevel]	First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)

TargetingCondition

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1

FirstLevel

Name	Type	Description
orOperators	array	Array of booleans ("or"=true, "and"=false) for binding conditions of second level.
conditions	array[TargetingCondition]	Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.

ORIGIN_TYPE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
trafficType `*required`	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
elementType `*required`	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
elementValue	string	Element on the page (id, class, ...) if 'elementType' is SINGLE.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BelongingPriceParams

Name	Type	Description
value `*required`	integer	To which fraction of products the product belongs
productWayOfCounting `*required`	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory `*required`	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching `*required`	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType `*required`	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType `*required`	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitCount `*required`	integer	Number of visits for today
matchType `*required`	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
since `*required`	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to `*required`	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
keyWordIndex `*required`	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count `*required`	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url `*required`	string	URL template
urlMatchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
event `*required`	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
countOfPages `*required`	integer	Amount of visited pages
countOfPagesMatchType `*required`	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType `*required`	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
since `*required`	string	Since time. Time format: hh:MM
to `*required`	string	To time. Time format: hh:MM
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Landing URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
dayPeriod `*required`	enum	. Can be [DAY, NIGHT]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
countOfPages `*required`	integer	Amount of visited pages
countOfPagesMatchType `*required`	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitorsType `*required`	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType `*required`	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays `*required`	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange `*required`	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType `*required`	enum	How to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

FORECAST_SKY_STATUS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays `*required`	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange `*required`	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType `*required`	enum	How to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DEVICE_TYPE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
device `*required`	enum	. Can be [DESKTOP, TABLET, PHONE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
audiences `*required`	array[TealiumAudience]	List of tealium audiences
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
country `*required`	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
jsCode `*required`	string	Custom JavaScript condition
applied `*required`	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
badges `*required`	array[TealiumBadge]	List of tealium badges
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
attribute `*required`	string	Ysance attribute
value `*required`	string	Attribute value
valueMatchType `*required`	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
name `*required`	string	Cookie name
value `*required`	string	Cookie value
nameMatchType `*required`	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType `*required`	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
segments `*required`	array	Ysance segments
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
day `*required`	enum	. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_TITLE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
title `*required`	string	Title template
matchType `*required`	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration `*required`	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType `*required`	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue `*required`	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency `*required`	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
lowerBound `*required`	integer	Lower bound of the probability in percents. Max value: 100
upperBound `*required`	integer	Upper bound of the probability in percents. Max value: 100
goalId `*required`	long	Unique identifier of a goal
keyMomentId `*required`	long	Unique identifier of a key moment
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
browser `*required`	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType `*required`	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
priceMatchType `*required`	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id `*required`	long	Badge unique identifier
name `*required`	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Previous page URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
keyPageIndex `*required`	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
goalId	long	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 `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

FIRST_VISIT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count `*required`	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
pageCount `*required`	integer	Number of page views
matchType `*required`	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Referring website URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
language `*required`	string	Browser language code in ISO 639-1
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType `*required`	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count `*required`	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

OPERATING_SYSTEM

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
os `*required`	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
period `*required`	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count `*required`	integer	Amount of visits
countMatchType `*required`	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url `*required`	string	URL template
urlMatchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
interestIndex `*required`	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitCount `*required`	integer	Total amount of visits
matchType `*required`	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
customDataIndex `*required`	string	Value can be the index of specific custom data. Or 'ANY' to segment visitors by presence of any custom data
value	string	Value which was retrieved by specified custom data
valueMatchType `*required`	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
goalId `*required`	long	Unique identifier of a goal expected to be converted
probability `*required`	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	URL template
matchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id `*required`	string	Audience unique identifier
name `*required`	string	Audience name

TABS_ON_SITE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
tabCount `*required`	integer	Number of tabs opened
matchType `*required`	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count `*required`	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

{
  "id" : "123456789",
  "name" : "string",
  "description" : "string",
  "conditionsData" : {
    "firstLevelOrOperators" : [ "[]" ],
    "firstLevel" : [ {
      "orOperators" : [ "[]" ],
      "conditions" : [ {
        "id" : "123456789",
        "targetingType" : "PAGE_URL",
        "weight" : "1234"
      } ]
    } ]
  },
  "siteId" : "123456789",
  "audienceTracking" : "false",
  "audienceTrackingEditable" : "false",
  "isFavorite" : "false",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

Response body

Segment

Name	Type	Description
id	long	Unique identifier of segment
name	string	Name of segment
description	string	Description of segment
conditionsData	ConditionsData	Conditions by which visitors will be segmented
siteId	long	Unique identifier of site for which the segment is going to be or was created
audienceTracking	boolean	Segment is used in audience
audienceTrackingEditable	boolean	This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking can't be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.
isFavorite	boolean	Indicates whether the segment is considered as favorite.
dateCreated	datetime
dateModified	datetime
tags	array
experimentAmount	long	Number of experiments using this segment. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this segment. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this segment. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this segment. This is an optional field needs to specify in request params.

ConditionsData

Name	Type	Description
firstLevelOrOperators	array	Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.
firstLevel	array[FirstLevel]	First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)

TargetingCondition

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

FirstLevel

Name	Type	Description
orOperators	array	Array of booleans ("or"=true, "and"=false) for binding conditions of second level.
conditions	array[TargetingCondition]	Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.

ORIGIN_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
trafficType	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
elementType	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
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'

BelongingPriceParams

Name	Type	Description
value	integer	To which fraction of products the product belongs
productWayOfCounting	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Number of visits for today
matchType	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyWordIndex	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
event	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	string	Since time. Time format: hh:MM
to	string	To time. Time format: hh:MM
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Landing URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
dayPeriod	enum	. Can be [DAY, NIGHT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitorsType	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

FORECAST_SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

DEVICE_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
device	enum	. Can be [DESKTOP, TABLET, PHONE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
audiences	array[TealiumAudience]	List of tealium audiences
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
country	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
jsCode	string	Custom JavaScript condition
applied	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
badges	array[TealiumBadge]	List of tealium badges
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
attribute	string	Ysance attribute
value	string	Attribute value
valueMatchType	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
name	string	Cookie name
value	string	Cookie value
nameMatchType	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
segments	array	Ysance segments
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
day	enum	. Can be [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'

PAGE_TITLE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
title	string	Title template
matchType	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
lowerBound	integer	Lower bound of the probability in percents. Max value: 100
upperBound	integer	Upper bound of the probability in percents. Max value: 100
goalId	long	Unique identifier of a goal
keyMomentId	long	Unique identifier of a key moment
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
browser	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id	long	Badge unique identifier
name	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Previous page URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyPageIndex	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	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'

FIRST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
pageCount	integer	Number of page views
matchType	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Referring website URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
language	string	Browser language code in ISO 639-1
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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'

OPERATING_SYSTEM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
os	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
period	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count	integer	Amount of visits
countMatchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
interestIndex	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Total amount of visits
matchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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
value	string	Value which was retrieved by specified custom data
valueMatchType	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	Unique identifier of a goal expected to be converted
probability	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	URL template
matchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id	string	Audience unique identifier
name	string	Audience name

TABS_ON_SITE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
tabCount	integer	Number of tabs opened
matchType	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

Update condition

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/segments/{segmentId}/conditions/{conditionId}"
{
  "id" : "123456789",
  "targetingType" : "PAGE_URL",
  "weight" : "1234",
  "trafficType" : "SEO",
  "include" : "false"
}

PUT /segments/{segmentId}/conditions/{conditionId}

Update one condition in a segment

Request arguments

Name	Place	Type	Description
segmentId	path	long	segmentId
conditionId	path	long	conditionId

Request body

ORIGIN_TYPE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
trafficType `*required`	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
elementType `*required`	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
elementValue	string	Element on the page (id, class, ...) if 'elementType' is SINGLE.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BelongingPriceParams

Name	Type	Description
value `*required`	integer	To which fraction of products the product belongs
productWayOfCounting `*required`	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory `*required`	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching `*required`	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType `*required`	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType `*required`	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitCount `*required`	integer	Number of visits for today
matchType `*required`	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
since `*required`	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to `*required`	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
keyWordIndex `*required`	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count `*required`	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url `*required`	string	URL template
urlMatchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
event `*required`	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
countOfPages `*required`	integer	Amount of visited pages
countOfPagesMatchType `*required`	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType `*required`	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
since `*required`	string	Since time. Time format: hh:MM
to `*required`	string	To time. Time format: hh:MM
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Landing URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
dayPeriod `*required`	enum	. Can be [DAY, NIGHT]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
countOfPages `*required`	integer	Amount of visited pages
countOfPagesMatchType `*required`	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitorsType `*required`	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType `*required`	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays `*required`	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange `*required`	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType `*required`	enum	How to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

FORECAST_SKY_STATUS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays `*required`	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange `*required`	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType `*required`	enum	How to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DEVICE_TYPE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
device `*required`	enum	. Can be [DESKTOP, TABLET, PHONE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
audiences `*required`	array[TealiumAudience]	List of tealium audiences
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
country `*required`	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
jsCode `*required`	string	Custom JavaScript condition
applied `*required`	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
badges `*required`	array[TealiumBadge]	List of tealium badges
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
attribute `*required`	string	Ysance attribute
value `*required`	string	Attribute value
valueMatchType `*required`	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
name `*required`	string	Cookie name
value `*required`	string	Cookie value
nameMatchType `*required`	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType `*required`	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
segments `*required`	array	Ysance segments
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
day `*required`	enum	. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_TITLE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
title `*required`	string	Title template
matchType `*required`	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration `*required`	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType `*required`	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue `*required`	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency `*required`	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
lowerBound `*required`	integer	Lower bound of the probability in percents. Max value: 100
upperBound `*required`	integer	Upper bound of the probability in percents. Max value: 100
goalId `*required`	long	Unique identifier of a goal
keyMomentId `*required`	long	Unique identifier of a key moment
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
browser `*required`	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType `*required`	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
priceMatchType `*required`	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id `*required`	long	Badge unique identifier
name `*required`	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Previous page URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
keyPageIndex `*required`	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
goalId	long	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 `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

FIRST_VISIT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count `*required`	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
pageCount `*required`	integer	Number of page views
matchType `*required`	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Referring website URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
language `*required`	string	Browser language code in ISO 639-1
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType `*required`	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count `*required`	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

OPERATING_SYSTEM

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
os `*required`	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
period `*required`	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count `*required`	integer	Amount of visits
countMatchType `*required`	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url `*required`	string	URL template
urlMatchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
interestIndex `*required`	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitCount `*required`	integer	Total amount of visits
matchType `*required`	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
customDataIndex `*required`	string	Value can be the index of specific custom data. Or 'ANY' to segment visitors by presence of any custom data
value	string	Value which was retrieved by specified custom data
valueMatchType `*required`	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
goalId `*required`	long	Unique identifier of a goal expected to be converted
probability `*required`	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	URL template
matchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id `*required`	string	Audience unique identifier
name `*required`	string	Audience name

TABS_ON_SITE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
tabCount `*required`	integer	Number of tabs opened
matchType `*required`	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count `*required`	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

{
  "id" : "123456789",
  "targetingType" : "PAGE_URL",
  "weight" : "1234",
  "trafficType" : "SEO",
  "include" : "false"
}

Response body

ORIGIN_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
trafficType	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
elementType	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
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'

BelongingPriceParams

Name	Type	Description
value	integer	To which fraction of products the product belongs
productWayOfCounting	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Number of visits for today
matchType	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyWordIndex	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
event	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	string	Since time. Time format: hh:MM
to	string	To time. Time format: hh:MM
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Landing URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
dayPeriod	enum	. Can be [DAY, NIGHT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitorsType	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

FORECAST_SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

DEVICE_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
device	enum	. Can be [DESKTOP, TABLET, PHONE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
audiences	array[TealiumAudience]	List of tealium audiences
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
country	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
jsCode	string	Custom JavaScript condition
applied	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
badges	array[TealiumBadge]	List of tealium badges
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
attribute	string	Ysance attribute
value	string	Attribute value
valueMatchType	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
name	string	Cookie name
value	string	Cookie value
nameMatchType	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
segments	array	Ysance segments
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
day	enum	. Can be [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'

PAGE_TITLE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
title	string	Title template
matchType	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
lowerBound	integer	Lower bound of the probability in percents. Max value: 100
upperBound	integer	Upper bound of the probability in percents. Max value: 100
goalId	long	Unique identifier of a goal
keyMomentId	long	Unique identifier of a key moment
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
browser	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id	long	Badge unique identifier
name	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Previous page URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyPageIndex	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	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'

FIRST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
pageCount	integer	Number of page views
matchType	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Referring website URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
language	string	Browser language code in ISO 639-1
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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'

OPERATING_SYSTEM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
os	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
period	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count	integer	Amount of visits
countMatchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
interestIndex	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Total amount of visits
matchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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
value	string	Value which was retrieved by specified custom data
valueMatchType	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	Unique identifier of a goal expected to be converted
probability	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	URL template
matchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id	string	Audience unique identifier
name	string	Audience name

TABS_ON_SITE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
tabCount	integer	Number of tabs opened
matchType	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

Create a new segment

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/segments"
{
  "id" : "123456789",
  "name" : "string",
  "description" : "string",
  "conditionsData" : {
    "firstLevelOrOperators" : [ "[]" ],
    "firstLevel" : [ {
      "orOperators" : [ "[]" ],
      "conditions" : [ {
        "id" : "123456789",
        "targetingType" : "PAGE_URL",
        "weight" : "1234"
      } ]
    } ]
  },
  "siteId" : "123456789",
  "audienceTracking" : "false",
  "audienceTrackingEditable" : "false",
  "isFavorite" : "false",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

POST /segments

Create a new segment with given parameters

Request body

Segment

Name	Type	Description
id `*read only`	long	Unique identifier of segment
name `*required`	string	Name of segment
description	string	Description of segment
conditionsData	ConditionsData	Conditions by which visitors will be segmented
siteId `*required`	long	Unique identifier of site for which the segment is going to be or was created
audienceTracking	boolean	Segment is used in audience
audienceTrackingEditable `*read only`	boolean	This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking can't be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.
isFavorite	boolean	Indicates whether the segment is considered as favorite.
dateCreated `*read only`	datetime
dateModified `*read only`	datetime
tags	array
experimentAmount `*read only`	long	Number of experiments using this segment. This is an optional field needs to specify in request params.
personalizationAmount `*read only`	long	Number of personalizations using this segment. This is an optional field needs to specify in request params.
experiments `*read only`	array	List of experiment ids using this segment. This is an optional field needs to specify in request params.
personalizations `*read only`	array	List of personalization ids using this segment. This is an optional field needs to specify in request params.

ConditionsData

Name	Type	Description
firstLevelOrOperators	array	Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.
firstLevel	array[FirstLevel]	First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)

TargetingCondition

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1

FirstLevel

Name	Type	Description
orOperators	array	Array of booleans ("or"=true, "and"=false) for binding conditions of second level.
conditions	array[TargetingCondition]	Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.

ORIGIN_TYPE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
trafficType `*required`	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
elementType `*required`	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
elementValue	string	Element on the page (id, class, ...) if 'elementType' is SINGLE.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BelongingPriceParams

Name	Type	Description
value `*required`	integer	To which fraction of products the product belongs
productWayOfCounting `*required`	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory `*required`	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching `*required`	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType `*required`	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType `*required`	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitCount `*required`	integer	Number of visits for today
matchType `*required`	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
since `*required`	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to `*required`	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
keyWordIndex `*required`	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count `*required`	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url `*required`	string	URL template
urlMatchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
event `*required`	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
countOfPages `*required`	integer	Amount of visited pages
countOfPagesMatchType `*required`	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType `*required`	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
since `*required`	string	Since time. Time format: hh:MM
to `*required`	string	To time. Time format: hh:MM
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Landing URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
dayPeriod `*required`	enum	. Can be [DAY, NIGHT]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
countOfPages `*required`	integer	Amount of visited pages
countOfPagesMatchType `*required`	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitorsType `*required`	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType `*required`	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays `*required`	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange `*required`	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType `*required`	enum	How to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

FORECAST_SKY_STATUS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays `*required`	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange `*required`	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType `*required`	enum	How to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DEVICE_TYPE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
device `*required`	enum	. Can be [DESKTOP, TABLET, PHONE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
audiences `*required`	array[TealiumAudience]	List of tealium audiences
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
country `*required`	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
jsCode `*required`	string	Custom JavaScript condition
applied `*required`	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
badges `*required`	array[TealiumBadge]	List of tealium badges
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
attribute `*required`	string	Ysance attribute
value `*required`	string	Attribute value
valueMatchType `*required`	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
name `*required`	string	Cookie name
value `*required`	string	Cookie value
nameMatchType `*required`	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType `*required`	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
segments `*required`	array	Ysance segments
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
day `*required`	enum	. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_TITLE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
title `*required`	string	Title template
matchType `*required`	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration `*required`	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType `*required`	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue `*required`	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency `*required`	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
lowerBound `*required`	integer	Lower bound of the probability in percents. Max value: 100
upperBound `*required`	integer	Upper bound of the probability in percents. Max value: 100
goalId `*required`	long	Unique identifier of a goal
keyMomentId `*required`	long	Unique identifier of a key moment
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
browser `*required`	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType `*required`	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
priceMatchType `*required`	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id `*required`	long	Badge unique identifier
name `*required`	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Previous page URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
keyPageIndex `*required`	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
goalId	long	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 `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

FIRST_VISIT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count `*required`	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
pageCount `*required`	integer	Number of page views
matchType `*required`	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	Referring website URL template
matchType `*required`	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
language `*required`	string	Browser language code in ISO 639-1
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType `*required`	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count `*required`	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

OPERATING_SYSTEM

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
os `*required`	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
period `*required`	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count `*required`	integer	Amount of visits
countMatchType `*required`	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url `*required`	string	URL template
urlMatchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
interestIndex `*required`	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
visitCount `*required`	integer	Total amount of visits
matchType `*required`	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
customDataIndex `*required`	string	Value can be the index of specific custom data. Or 'ANY' to segment visitors by presence of any custom data
value	string	Value which was retrieved by specified custom data
valueMatchType `*required`	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
goalId `*required`	long	Unique identifier of a goal expected to be converted
probability `*required`	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
url `*required`	string	URL template
matchType `*required`	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id `*required`	string	Audience unique identifier
name `*required`	string	Audience name

TABS_ON_SITE

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
tabCount `*required`	integer	Number of tabs opened
matchType `*required`	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id `*read only`	long	Unique identifier
targetingType `*required`	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight `*required`	integer	More important conditions have greater values. Default value: 1
unitOfTime `*required`	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count `*required`	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType `*required`	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include `*required`	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

{
  "id" : "123456789",
  "name" : "string",
  "description" : "string",
  "conditionsData" : {
    "firstLevelOrOperators" : [ "[]" ],
    "firstLevel" : [ {
      "orOperators" : [ "[]" ],
      "conditions" : [ {
        "id" : "123456789",
        "targetingType" : "PAGE_URL",
        "weight" : "1234"
      } ]
    } ]
  },
  "siteId" : "123456789",
  "audienceTracking" : "false",
  "audienceTrackingEditable" : "false",
  "isFavorite" : "false",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
}

Response body

Segment

Name	Type	Description
id	long	Unique identifier of segment
name	string	Name of segment
description	string	Description of segment
conditionsData	ConditionsData	Conditions by which visitors will be segmented
siteId	long	Unique identifier of site for which the segment is going to be or was created
audienceTracking	boolean	Segment is used in audience
audienceTrackingEditable	boolean	This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking can't be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.
isFavorite	boolean	Indicates whether the segment is considered as favorite.
dateCreated	datetime
dateModified	datetime
tags	array
experimentAmount	long	Number of experiments using this segment. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this segment. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this segment. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this segment. This is an optional field needs to specify in request params.

ConditionsData

Name	Type	Description
firstLevelOrOperators	array	Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.
firstLevel	array[FirstLevel]	First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)

TargetingCondition

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

FirstLevel

Name	Type	Description
orOperators	array	Array of booleans ("or"=true, "and"=false) for binding conditions of second level.
conditions	array[TargetingCondition]	Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.

ORIGIN_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
trafficType	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
elementType	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
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'

BelongingPriceParams

Name	Type	Description
value	integer	To which fraction of products the product belongs
productWayOfCounting	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Number of visits for today
matchType	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyWordIndex	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
event	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	string	Since time. Time format: hh:MM
to	string	To time. Time format: hh:MM
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Landing URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
dayPeriod	enum	. Can be [DAY, NIGHT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitorsType	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

FORECAST_SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

DEVICE_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
device	enum	. Can be [DESKTOP, TABLET, PHONE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
audiences	array[TealiumAudience]	List of tealium audiences
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
country	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
jsCode	string	Custom JavaScript condition
applied	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
badges	array[TealiumBadge]	List of tealium badges
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
attribute	string	Ysance attribute
value	string	Attribute value
valueMatchType	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
name	string	Cookie name
value	string	Cookie value
nameMatchType	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
segments	array	Ysance segments
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
day	enum	. Can be [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'

PAGE_TITLE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
title	string	Title template
matchType	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
lowerBound	integer	Lower bound of the probability in percents. Max value: 100
upperBound	integer	Upper bound of the probability in percents. Max value: 100
goalId	long	Unique identifier of a goal
keyMomentId	long	Unique identifier of a key moment
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
browser	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id	long	Badge unique identifier
name	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Previous page URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyPageIndex	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	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'

FIRST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
pageCount	integer	Number of page views
matchType	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Referring website URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
language	string	Browser language code in ISO 639-1
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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'

OPERATING_SYSTEM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
os	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
period	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count	integer	Amount of visits
countMatchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
interestIndex	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Total amount of visits
matchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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
value	string	Value which was retrieved by specified custom data
valueMatchType	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	Unique identifier of a goal expected to be converted
probability	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	URL template
matchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id	string	Audience unique identifier
name	string	Audience name

TABS_ON_SITE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
tabCount	integer	Number of tabs opened
matchType	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

List segments

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/segments"

GET /segments

Get list of segments

Request arguments

Name	Place	Type	Description
optionalFields	query	array	optionalFields

[ {
  "id" : "123456789",
  "name" : "string",
  "description" : "string",
  "conditionsData" : {
    "firstLevelOrOperators" : [ "[]" ],
    "firstLevel" : [ {
      "orOperators" : [ "[]" ],
      "conditions" : [ {
        "id" : "123456789",
        "targetingType" : "PAGE_URL",
        "weight" : "1234"
      } ]
    } ]
  },
  "siteId" : "123456789",
  "audienceTracking" : "false",
  "audienceTrackingEditable" : "false",
  "isFavorite" : "false",
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "tags" : [ "[]" ],
  "experimentAmount" : "123456789",
  "personalizationAmount" : "123456789",
  "experiments" : [ "[]" ],
  "personalizations" : [ "[]" ]
} ]

Response body

Segment

Name	Type	Description
id	long	Unique identifier of segment
name	string	Name of segment
description	string	Description of segment
conditionsData	ConditionsData	Conditions by which visitors will be segmented
siteId	long	Unique identifier of site for which the segment is going to be or was created
audienceTracking	boolean	Segment is used in audience
audienceTrackingEditable	boolean	This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking can't be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.
isFavorite	boolean	Indicates whether the segment is considered as favorite.
dateCreated	datetime
dateModified	datetime
tags	array
experimentAmount	long	Number of experiments using this segment. This is an optional field needs to specify in request params.
personalizationAmount	long	Number of personalizations using this segment. This is an optional field needs to specify in request params.
experiments	array	List of experiment ids using this segment. This is an optional field needs to specify in request params.
personalizations	array	List of personalization ids using this segment. This is an optional field needs to specify in request params.

ConditionsData

Name	Type	Description
firstLevelOrOperators	array	Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.
firstLevel	array[FirstLevel]	First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)

TargetingCondition

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

FirstLevel

Name	Type	Description
orOperators	array	Array of booleans ("or"=true, "and"=false) for binding conditions of second level.
conditions	array[TargetingCondition]	Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.

ORIGIN_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
trafficType	enum	Traffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DOM_ELEMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
elementType	enum	Type of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
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'

BelongingPriceParams

Name	Type	Description
value	integer	To which fraction of products the product belongs
productWayOfCounting	enum	How to count 'value'?. Can be [PERCENT, COUNTS]
priceCategory	enum	. Can be [EXPENSIVE, CHEAP]
areaOfPriceMatching	enum	. Can be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
productEan	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
category	string	Has to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'

SCREEN_DIMENSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
width	integer	Should be specified if 'widthMatchType' is not 'INCLUDE'
widthLowerBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthUpperBound	integer	Should be specified if 'widthMatchType' is 'INCLUDE'
widthMatchType	enum	How to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
height	integer	Should be specified if 'heightMatchType' is not 'INCLUDE'
heightLowerBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightUpperBound	integer	Should be specified if 'heightMatchType' is 'INCLUDE'
heightMatchType	enum	How to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

SAME_DAY_VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Number of visits for today
matchType	enum	How to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	datetime	Since date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
to	datetime	To date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERNAL_SEARCH_KEYWORDS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyWordIndex	string	Value can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TIME_SINCE_PAGE_LOAD

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
countMatchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EVENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
event	string	Custom event

NUMBER_OF_VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
category	string	Product category
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

HOUR_MINUTE_RANGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
since	string	Since time. Time format: hh:MM
to	string	To time. Time format: hh:MM
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LANDING_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Landing URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITOR_IP

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
ip	string	Exact visitor ip address
secondIp	string	Second exact visitor ip address
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
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
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_NIGHT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
dayPeriod	enum	. Can be [DAY, NIGHT]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITED_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
countOfPages	integer	Amount of visited pages
countOfPagesMatchType	enum	How to match 'countOfPages'?. Can be [GREATER, EXACT, LOWER]
productEan	string	Pages of which product should be visited?
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

NEW_VISITORS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitorsType	enum	. Can be [NEW, RETURNING]

FORECAST_TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
forecastDays	integer	Amount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

FORECAST_SKY_STATUS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
skyStatusGroup	enum	Group of sky statuses. Each group can include many sky statuses. Can be null if 'skyStatus' is filled. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, DISTURBED_ATMOSPHERE]
skyStatus	enum	Specific status of the sky. Can be null if 'skyStatusGroup' is filled. Can be [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]
forecastDays	integer	Amount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
daysRange	integer	Range of days during which the forecast is expected. This value can't be less than 'forecastDays'
forecastMatchType	enum	How to match the specified amount of days. Can be [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'

DEVICE_TYPE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
device	enum	. Can be [DESKTOP, TABLET, PHONE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_AUDIENCE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
audiences	array[TealiumAudience]	List of tealium audiences
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

GEOLOCATION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
country	string	Visitor's country
region	string	Visitor's region
city	string	Visitor's city
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

JS_CODE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
jsCode	string	Custom JavaScript condition
applied	enum	Run js code after DOM ready or immediate? Default value: DOM_READY. Can be [DOM_READY, IMMEDIATE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TEALIUM_BADGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
badges	array[TealiumBadge]	List of tealium badges
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_ATTRIBUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
attribute	string	Ysance attribute
value	string	Attribute value
valueMatchType	enum	How to match the specified attribute value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

COOKIE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
name	string	Cookie name
value	string	Cookie value
nameMatchType	enum	How to match the specified cookie name. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
valueMatchType	enum	How to match the specified cookie value. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

YSANCE_SEGMENT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
segments	array	Ysance segments
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

DAY_OF_WEEK

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
day	enum	. Can be [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'

PAGE_TITLE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
title	string	Title template
matchType	enum	How to match the specified title. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PriceChangeParams

Name	Type	Description
changeDuration	enum	Time range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
firstDate	datetime	Has to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondDate	datetime	Has to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
changeMatchType	enum	How to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
firstChangeValue	double	To this value selected 'changeMatchType' will be applied
firstChangeCurrency	enum	. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
secondChangeValue	double	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
secondChangeCurrency	enum	Has to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'. Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]

HEAT_SLICE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
lowerBound	integer	Lower bound of the probability in percents. Max value: 100
upperBound	integer	Upper bound of the probability in percents. Max value: 100
goalId	long	Unique identifier of a goal
keyMomentId	long	Unique identifier of a key moment
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
browser	enum	The type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
version	string	Browser version
versionMatchType	enum	How to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PRICE_OF_DISPLAYED_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
priceMatchType	enum	How match by price? According to this field it's necessary to add some additional pricing parameters. Can be [ANY, GREATER, LOWER, EQUAL, BELONG, BETWEEN, INCREASED, DECREASED]
priceParams	PriceParams	Type of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ExactPriceParams

Name	Type	Description
priceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
value	string	Depending on 'priceCalculationType' here has to be exact price value

TealiumBadge

Name	Type	Description
id	long	Badge unique identifier
name	string	Badge name

PREVIOUS_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Previous page URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

KEY_PAGES

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
keyPageIndex	string	Value can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CONVERSIONS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	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'

FIRST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the first visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BetweenPriceParams

Name	Type	Description
firstPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
firstValue	string	Depending on 'priceCalculationType' here has to be exact price value
secondPriceCalculationType	enum	. Can be [FIXED_PRICE, PRICE_OF_SPECIFIC_PRODUCT, AVERAGE_PRICE_SELECTION, MAX_PRICE_SELECTION, MIN_PRICE_SELECTION, AVERAGE_PRICE_CATEGORY, MAX_PRICE_CATEGORY, MIN_PRICE_CATEGORY, CUSTOM_DATA_VALUE]
secondValue	string	Depending on 'priceCalculationType' here has to be exact price value

PAGE_VIEWS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
pageCount	integer	Number of page views
matchType	enum	How to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ORIGIN

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	Referring website URL template
matchType	enum	How to match the specified url. Default value: 'EXACT'. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

BROWSER_LANGUAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
language	string	Browser language code in ISO 639-1
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

EXPERIMENTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

TEMPERATURE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
measurement	enum	Default value: 'CELSIUS'. Can be [CELSIUS, FAHRENHEIT]
value	integer	Exact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
lowerBoundValue	integer	Lower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
upperBoundValue	integer	Upper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
temperatureMatchType	enum	How to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

ACTIVE_SESSION

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	What unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
count	integer	Count of time elapsed since session became active according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

AD_BLOCKER

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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'

OPERATING_SYSTEM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
os	enum	. Can be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS_BY_PAGE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
period	enum	Per what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
count	integer	Amount of visits
countMatchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
url	string	URL template
urlMatchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

INTERESTS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
interestIndex	string	Value can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

VISITS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
visitCount	integer	Total amount of visits
matchType	enum	How to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

CUSTOM_DATUM

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	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
value	string	Value which was retrieved by specified custom data
valueMatchType	enum	How to match the retrieved value? Depends on specified format of data retrieved by the custom data. Can be [TRUE, FALSE, EXACT, CONTAINS, REGULAR_EXPRESSION, EQUAL, LOWER, GREATER, UNDEFINED]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

MOUSE_OUT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1

CONVERSION_PROBABILITY

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
goalId	long	Unique identifier of a goal expected to be converted
probability	enum	Approximate or exact probability of conversion of the goal. For the values 'BETWEEN', 'GREATER' and 'LOWER', the fields 'percents' or 'percentsLowerBound' and 'percentsUpperBound' should be specified. Can be [HIGH, SOMEWHAT_HIGH, LOW, VERY_LOW, BETWEEN, GREATER, LOWER]
percents	integer	Should be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
percentsLowerBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
percentsUpperBound	integer	Should be specified if the value of the field 'probability' is 'BETWEEN'
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

PAGE_URL

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
url	string	URL template
matchType	enum	Accordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

REFERRERS

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
referrerIndex	string	Value can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

TealiumAudience

Name	Type	Description
id	string	Audience unique identifier
name	string	Audience name

TABS_ON_SITE

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
tabCount	integer	Number of tabs opened
matchType	enum	How to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

LAST_VISIT

Name	Type	Description
id	long	Unique identifier
targetingType	enum	Targeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
weight	integer	More important conditions have greater values. Default value: 1
unitOfTime	enum	Unit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
count	integer	Count of time elapsed since the last visit according to the 'unitOfTime' field
matchType	enum	How to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
include	boolean	Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

Simulations

simulate

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/simulations/simulate"
{
  "containerId" : "123456789",
  "type" : "EXPERIMENT"
}

POST /simulations/simulate

Request body

SimulationInput

Name	Type	Description
containerId `*required`	long
type `*required`	enum	. Can be [EXPERIMENT, PERSONALIZATION]

{
  "id" : "123456789",
  "siteCode" : "string",
  "simulationData" : "string",
  "simulationCode" : "string",
  "shortURL" : "string",
  "longURL" : "string",
  "targetingSegments" : [ "[]" ],
  "siteId" : "123456789"
}

Response body

SimulationOutput

Name	Type	Description
id	long	Unique identifier of simulation
siteCode	string	Site code
simulationData	string
simulationCode	string
shortURL	string
longURL	string
targetingSegments	array
siteId	long

getOne_3

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/simulations/{siteCode}"

GET /simulations/{siteCode}

Request arguments

Name	Place	Type	Description
siteCode	path	string	siteCode
simulationCode	query	string	simulationCode

{
  "id" : "123456789",
  "siteCode" : "string",
  "simulationData" : "string",
  "simulationCode" : "string",
  "shortURL" : "string",
  "longURL" : "string",
  "targetingSegments" : [ "[]" ],
  "siteId" : "123456789"
}

Response body

SimulationOutput

Name	Type	Description
id	long	Unique identifier of simulation
siteCode	string	Site code
simulationData	string
simulationCode	string
shortURL	string
longURL	string
targetingSegments	array
siteId	long

Sites

You can set up several websites with your account. It can be very useful if you want to test both your website and its mobile version or if you want to test Kameleoon on your website in pre-production first, so you can set up different environments.

Partial update site, when only information that is passed is updated

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/sites/{siteId}"
{
  "url" : "string",
  "description" : "string",
  "behaviorWhenTimeout" : "RUN",
  "dataStorage" : "STANDARD_COOKIE",
  "trackingScript" : "string",
  "domainNames" : [ "[]" ],
  "indicators" : [ "RETENTION_RATE" ],
  "isScriptActive" : "false"
}

PATCH /sites/{siteId}

Update several fields of site

Request arguments

Name	Place	Type	Description
siteId	path	long	siteId

Request body

SiteUpdate

Name	Type	Description
url	string	URL of the website
description	string	Website description
behaviorWhenTimeout	enum	Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch with a flicker effect.. Can be [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]
dataStorage	enum	This option allows you to choose source where to store the data of your A/B tests on the the visitor's device. Can be [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]
trackingScript	string	Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.
domainNames	array
indicators	array	List of indicators such as: Retention rate, number of pages seen and dwell time. Can be [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]
isScriptActive	boolean	Identifies if the script is installed successfully and is active on the website

{
  "id" : "123456789",
  "url" : "string",
  "description" : "string",
  "code" : "string",
  "behaviorWhenTimeout" : "RUN",
  "dataStorage" : "STANDARD_COOKIE",
  "trackingScript" : "string",
  "domainNames" : [ "[]" ],
  "indicators" : [ "RETENTION_RATE" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "isScriptActive" : "false",
  "captureEventMethod" : "CLICK",
  "isAudienceUsed" : "false",
  "isKameleoonEnabled" : "false",
  "experimentConfig" : {
    "isEditorLaunchedByShortcut" : "false",
    "isKameleoonReportingEnabled" : "false",
    "customVariationSelectionScript" : "string",
    "minWiningReliability" : "1234",
    "abtestConsent" : "OFF",
    "abtestConsentOptout" : "RUN",
    "beforeAbtestConsent" : "NONE"
  },
  "personalizationConfig" : {
    "personalizationsDeviation" : "132.987",
    "isSameTypePersonalizationEnabled" : "false",
    "isSameJqueryInjectionAllowed" : "false",
    "personalizationConsent" : "OFF",
    "personalizationConsentOptout" : "RUN",
    "beforePersonalizationConsent" : "NONE"
  },
  "audienceConfig" : {
    "mainGoal" : "123456789",
    "includedTargetingTypeList" : [ "PAGE_URL" ],
    "excludedTargetingTypeList" : [ "PAGE_URL" ],
    "includedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "excludedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "includedCustomData" : [ "[]" ],
    "excludedCustomData" : [ "[]" ],
    "includedTargetingSegmentList" : [ "[]" ],
    "excludedTargetingSegmentList" : [ "[]" ],
    "siteType" : "ECOMMERCE",
    "ignoreURLSettings" : "false",
    "predictiveTargeting" : "false",
    "excludedGoalList" : [ "[]" ],
    "includedExperimentList" : [ "[]" ],
    "excludedExperimentList" : [ "[]" ],
    "includedPersonalizationList" : [ "[]" ],
    "excludedPersonalizationList" : [ "[]" ],
    "cartAmountGoal" : "123456789",
    "cartAmountValue" : "123456789"
  }
}

Response body

Site

Name	Type	Description
id	long	The unique identifier for the website
url	string	URL of the website
description	string	Website description
code	string	System generated code to uniquely identify a website.
behaviorWhenTimeout	enum	Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch with a flicker effect.. Can be [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]
dataStorage	enum	This option allows you to choose source where to store the data of your A/B tests on the the visitor's device. Can be [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]
trackingScript	string	Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.
domainNames	array
indicators	array	List of indicators such as: Retention rate, number of pages seen and dwell time. Can be [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]
dateCreated	datetime	Date when the site was created.
isScriptActive	boolean	Identifies if the script is installed successfully and is active on the website
captureEventMethod	enum	. Can be [CLICK, MOUSEDOWN, MOUSEUP]
isAudienceUsed	boolean	Identifies where audience feature is enabled and used for the website
isKameleoonEnabled	boolean	This field represents if Kameleoon application is enbabled for the website
experimentConfig	ExperimentConfig	Configuration of an experiment
personalizationConfig	PersonalizationConfig	Configuration of a personalization
audienceConfig	AudienceConfig	Audience configuration

AudienceConfigUrl

Name	Type	Description
url	string
matchType	enum	. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

PersonalizationConfig

Name	Type	Description
personalizationsDeviation	double	Include visitors. Percentage of your visitors included to personalizations. You can define a visitor rate who will never be exposed to your personalizations. We advise youto keep a sample population, not exposed, in order to determine the efficiency of your personalizations.
isSameTypePersonalizationEnabled	boolean	Advanced options. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
isSameJqueryInjectionAllowed	boolean	Allow the injection of jQuery. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
personalizationConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
personalizationConsentOptout	enum	. Can be [RUN, BLOCK]
beforePersonalizationConsent	enum	. Can be [NONE, PARTIALLY, ALL]

ExperimentConfig

Name	Type	Description
isEditorLaunchedByShortcut	boolean	Editor launching. Enable launching the editor via Shift + F2
isKameleoonReportingEnabled	boolean	Result reporting. Activate Kameleoon’s reporting to view test results
customVariationSelectionScript	string	Variation selection script. By default, the assignation of an experiment's variation to a visitor is done via a random mechanism. You can write a JavaScript code here to customize this behavior. The code must return the id of the assigned variation (consult the documentation for details).
minWiningReliability	integer	Necessary reliability for the determination of a winning variation. The reliability of the variations is inferior to the rate determined in set-up. The variations cannot be considered as winning in your test results, whatever the number of conversions of these variations. Please be parcimonious about changing this parameter, as this has an impact on the results Kameleoon delivers.
abtestConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
abtestConsentOptout	enum	. Can be [RUN, BLOCK]
beforeAbtestConsent	enum	. Can be [NONE, PARTIALLY, ALL]

AudienceConfig

Name	Type	Description
mainGoal	long	Primary goal, it must correspond to the main conversion action of the site
includedTargetingTypeList	array	The 3 targeting criteria to be treated primarily in your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
excludedTargetingTypeList	array	Targeting criteria to be excluded from your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
includedConfigurationUrlList	array[AudienceConfigUrl]	URLs you want to optimize primarily
excludedConfigurationUrlList	array[AudienceConfigUrl]	URLS to be excluded from your recommendations
includedCustomData	array	Personalized data to be treated primarily in your recommendations
excludedCustomData	array	Personalized data to be excluded from your recommendations
includedTargetingSegmentList	array	Additional segments to track. Predictive segments are tracked by default
excludedTargetingSegmentList	array	Segments to be excluded from your recommendations
siteType	enum	Typology of the website. Can be [ECOMMERCE, MEDIA, OTHER]
ignoreURLSettings	boolean	Ignore the settings in the URL of your pages
predictiveTargeting	boolean	Activate predictive targeting option
excludedGoalList	array	Goals to be excluded from your recommendations
includedExperimentList	array	A/B tests to be privileged in your recommendations
excludedExperimentList	array	A/B tests to be excluded from your recommendations
includedPersonalizationList	array	Personalizations to be privileged in your recommendations
excludedPersonalizationList	array	Personalizations to be excluded from your recommendations
cartAmountGoal	long	Goal to which the value of customer's basket is linked
cartAmountValue	long	Conversion value linked to the primary goal

Remove site

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/sites/{siteId}"

DELETE /sites/{siteId}

Remove site with given id

Request arguments

Name	Place	Type	Description
siteId	path	long	siteId

Get one site

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/sites/{siteId}"

GET /sites/{siteId}

Get one site with given id

Request arguments

Name	Place	Type	Description
siteId	path	long	siteId
optionalFields	query	array	optionalFields

{
  "id" : "123456789",
  "url" : "string",
  "description" : "string",
  "code" : "string",
  "behaviorWhenTimeout" : "RUN",
  "dataStorage" : "STANDARD_COOKIE",
  "trackingScript" : "string",
  "domainNames" : [ "[]" ],
  "indicators" : [ "RETENTION_RATE" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "isScriptActive" : "false",
  "captureEventMethod" : "CLICK",
  "isAudienceUsed" : "false",
  "isKameleoonEnabled" : "false",
  "experimentConfig" : {
    "isEditorLaunchedByShortcut" : "false",
    "isKameleoonReportingEnabled" : "false",
    "customVariationSelectionScript" : "string",
    "minWiningReliability" : "1234",
    "abtestConsent" : "OFF",
    "abtestConsentOptout" : "RUN",
    "beforeAbtestConsent" : "NONE"
  },
  "personalizationConfig" : {
    "personalizationsDeviation" : "132.987",
    "isSameTypePersonalizationEnabled" : "false",
    "isSameJqueryInjectionAllowed" : "false",
    "personalizationConsent" : "OFF",
    "personalizationConsentOptout" : "RUN",
    "beforePersonalizationConsent" : "NONE"
  },
  "audienceConfig" : {
    "mainGoal" : "123456789",
    "includedTargetingTypeList" : [ "PAGE_URL" ],
    "excludedTargetingTypeList" : [ "PAGE_URL" ],
    "includedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "excludedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "includedCustomData" : [ "[]" ],
    "excludedCustomData" : [ "[]" ],
    "includedTargetingSegmentList" : [ "[]" ],
    "excludedTargetingSegmentList" : [ "[]" ],
    "siteType" : "ECOMMERCE",
    "ignoreURLSettings" : "false",
    "predictiveTargeting" : "false",
    "excludedGoalList" : [ "[]" ],
    "includedExperimentList" : [ "[]" ],
    "excludedExperimentList" : [ "[]" ],
    "includedPersonalizationList" : [ "[]" ],
    "excludedPersonalizationList" : [ "[]" ],
    "cartAmountGoal" : "123456789",
    "cartAmountValue" : "123456789"
  }
}

Response body

Site

Name	Type	Description
id	long	The unique identifier for the website
url	string	URL of the website
description	string	Website description
code	string	System generated code to uniquely identify a website.
behaviorWhenTimeout	enum	Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch with a flicker effect.. Can be [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]
dataStorage	enum	This option allows you to choose source where to store the data of your A/B tests on the the visitor's device. Can be [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]
trackingScript	string	Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.
domainNames	array
indicators	array	List of indicators such as: Retention rate, number of pages seen and dwell time. Can be [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]
dateCreated	datetime	Date when the site was created.
isScriptActive	boolean	Identifies if the script is installed successfully and is active on the website
captureEventMethod	enum	. Can be [CLICK, MOUSEDOWN, MOUSEUP]
isAudienceUsed	boolean	Identifies where audience feature is enabled and used for the website
isKameleoonEnabled	boolean	This field represents if Kameleoon application is enbabled for the website
experimentConfig	ExperimentConfig	Configuration of an experiment
personalizationConfig	PersonalizationConfig	Configuration of a personalization
audienceConfig	AudienceConfig	Audience configuration

AudienceConfigUrl

Name	Type	Description
url	string
matchType	enum	. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

PersonalizationConfig

Name	Type	Description
personalizationsDeviation	double	Include visitors. Percentage of your visitors included to personalizations. You can define a visitor rate who will never be exposed to your personalizations. We advise youto keep a sample population, not exposed, in order to determine the efficiency of your personalizations.
isSameTypePersonalizationEnabled	boolean	Advanced options. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
isSameJqueryInjectionAllowed	boolean	Allow the injection of jQuery. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
personalizationConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
personalizationConsentOptout	enum	. Can be [RUN, BLOCK]
beforePersonalizationConsent	enum	. Can be [NONE, PARTIALLY, ALL]

ExperimentConfig

Name	Type	Description
isEditorLaunchedByShortcut	boolean	Editor launching. Enable launching the editor via Shift + F2
isKameleoonReportingEnabled	boolean	Result reporting. Activate Kameleoon’s reporting to view test results
customVariationSelectionScript	string	Variation selection script. By default, the assignation of an experiment's variation to a visitor is done via a random mechanism. You can write a JavaScript code here to customize this behavior. The code must return the id of the assigned variation (consult the documentation for details).
minWiningReliability	integer	Necessary reliability for the determination of a winning variation. The reliability of the variations is inferior to the rate determined in set-up. The variations cannot be considered as winning in your test results, whatever the number of conversions of these variations. Please be parcimonious about changing this parameter, as this has an impact on the results Kameleoon delivers.
abtestConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
abtestConsentOptout	enum	. Can be [RUN, BLOCK]
beforeAbtestConsent	enum	. Can be [NONE, PARTIALLY, ALL]

AudienceConfig

Name	Type	Description
mainGoal	long	Primary goal, it must correspond to the main conversion action of the site
includedTargetingTypeList	array	The 3 targeting criteria to be treated primarily in your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
excludedTargetingTypeList	array	Targeting criteria to be excluded from your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
includedConfigurationUrlList	array[AudienceConfigUrl]	URLs you want to optimize primarily
excludedConfigurationUrlList	array[AudienceConfigUrl]	URLS to be excluded from your recommendations
includedCustomData	array	Personalized data to be treated primarily in your recommendations
excludedCustomData	array	Personalized data to be excluded from your recommendations
includedTargetingSegmentList	array	Additional segments to track. Predictive segments are tracked by default
excludedTargetingSegmentList	array	Segments to be excluded from your recommendations
siteType	enum	Typology of the website. Can be [ECOMMERCE, MEDIA, OTHER]
ignoreURLSettings	boolean	Ignore the settings in the URL of your pages
predictiveTargeting	boolean	Activate predictive targeting option
excludedGoalList	array	Goals to be excluded from your recommendations
includedExperimentList	array	A/B tests to be privileged in your recommendations
excludedExperimentList	array	A/B tests to be excluded from your recommendations
includedPersonalizationList	array	Personalizations to be privileged in your recommendations
excludedPersonalizationList	array	Personalizations to be excluded from your recommendations
cartAmountGoal	long	Goal to which the value of customer's basket is linked
cartAmountValue	long	Conversion value linked to the primary goal

Update site

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/sites/{siteId}"
{
  "id" : "123456789",
  "url" : "string",
  "description" : "string",
  "code" : "string",
  "behaviorWhenTimeout" : "RUN",
  "dataStorage" : "STANDARD_COOKIE",
  "trackingScript" : "string",
  "domainNames" : [ "[]" ],
  "indicators" : [ "RETENTION_RATE" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "isScriptActive" : "false",
  "captureEventMethod" : "CLICK",
  "isAudienceUsed" : "false",
  "isKameleoonEnabled" : "false",
  "experimentConfig" : {
    "isEditorLaunchedByShortcut" : "false",
    "isKameleoonReportingEnabled" : "false",
    "customVariationSelectionScript" : "string",
    "minWiningReliability" : "1234",
    "abtestConsent" : "OFF",
    "abtestConsentOptout" : "RUN",
    "beforeAbtestConsent" : "NONE"
  },
  "personalizationConfig" : {
    "personalizationsDeviation" : "132.987",
    "isSameTypePersonalizationEnabled" : "false",
    "isSameJqueryInjectionAllowed" : "false",
    "personalizationConsent" : "OFF",
    "personalizationConsentOptout" : "RUN",
    "beforePersonalizationConsent" : "NONE"
  },
  "audienceConfig" : {
    "mainGoal" : "123456789",
    "includedTargetingTypeList" : [ "PAGE_URL" ],
    "excludedTargetingTypeList" : [ "PAGE_URL" ],
    "includedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "excludedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "includedCustomData" : [ "[]" ],
    "excludedCustomData" : [ "[]" ],
    "includedTargetingSegmentList" : [ "[]" ],
    "excludedTargetingSegmentList" : [ "[]" ],
    "siteType" : "ECOMMERCE",
    "ignoreURLSettings" : "false",
    "predictiveTargeting" : "false",
    "excludedGoalList" : [ "[]" ],
    "includedExperimentList" : [ "[]" ],
    "excludedExperimentList" : [ "[]" ],
    "includedPersonalizationList" : [ "[]" ],
    "excludedPersonalizationList" : [ "[]" ],
    "cartAmountGoal" : "123456789",
    "cartAmountValue" : "123456789"
  }
}

PUT /sites/{siteId}

Update site with given id

Request arguments

Name	Place	Type	Description
siteId	path	long	siteId

Request body

Site

Name	Type	Description
id `*read only`	long	The unique identifier for the website
url `*required`	string	URL of the website
description	string	Website description
code `*read only`	string	System generated code to uniquely identify a website.
behaviorWhenTimeout	enum	Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch with a flicker effect.. Can be [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]
dataStorage	enum	This option allows you to choose source where to store the data of your A/B tests on the the visitor's device. Can be [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]
trackingScript	string	Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.
domainNames	array
indicators	array	List of indicators such as: Retention rate, number of pages seen and dwell time. Can be [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]
dateCreated `*read only`	datetime	Date when the site was created.
isScriptActive	boolean	Identifies if the script is installed successfully and is active on the website
captureEventMethod	enum	. Can be [CLICK, MOUSEDOWN, MOUSEUP]
isAudienceUsed	boolean	Identifies where audience feature is enabled and used for the website
isKameleoonEnabled	boolean	This field represents if Kameleoon application is enbabled for the website
experimentConfig	ExperimentConfig	Configuration of an experiment
personalizationConfig	PersonalizationConfig	Configuration of a personalization
audienceConfig	AudienceConfig	Audience configuration

AudienceConfigUrl

Name	Type	Description
url	string
matchType	enum	. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

PersonalizationConfig

Name	Type	Description
personalizationsDeviation	double	Include visitors. Percentage of your visitors included to personalizations. You can define a visitor rate who will never be exposed to your personalizations. We advise youto keep a sample population, not exposed, in order to determine the efficiency of your personalizations.
isSameTypePersonalizationEnabled	boolean	Advanced options. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
isSameJqueryInjectionAllowed	boolean	Allow the injection of jQuery. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
personalizationConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
personalizationConsentOptout	enum	. Can be [RUN, BLOCK]
beforePersonalizationConsent	enum	. Can be [NONE, PARTIALLY, ALL]

ExperimentConfig

Name	Type	Description
isEditorLaunchedByShortcut	boolean	Editor launching. Enable launching the editor via Shift + F2
isKameleoonReportingEnabled	boolean	Result reporting. Activate Kameleoon’s reporting to view test results
customVariationSelectionScript	string	Variation selection script. By default, the assignation of an experiment's variation to a visitor is done via a random mechanism. You can write a JavaScript code here to customize this behavior. The code must return the id of the assigned variation (consult the documentation for details).
minWiningReliability	integer	Necessary reliability for the determination of a winning variation. The reliability of the variations is inferior to the rate determined in set-up. The variations cannot be considered as winning in your test results, whatever the number of conversions of these variations. Please be parcimonious about changing this parameter, as this has an impact on the results Kameleoon delivers.
abtestConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
abtestConsentOptout	enum	. Can be [RUN, BLOCK]
beforeAbtestConsent	enum	. Can be [NONE, PARTIALLY, ALL]

AudienceConfig

Name	Type	Description
mainGoal `*required`	long	Primary goal, it must correspond to the main conversion action of the site
includedTargetingTypeList	array	The 3 targeting criteria to be treated primarily in your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
excludedTargetingTypeList	array	Targeting criteria to be excluded from your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
includedConfigurationUrlList	array[AudienceConfigUrl]	URLs you want to optimize primarily
excludedConfigurationUrlList	array[AudienceConfigUrl]	URLS to be excluded from your recommendations
includedCustomData	array	Personalized data to be treated primarily in your recommendations
excludedCustomData	array	Personalized data to be excluded from your recommendations
includedTargetingSegmentList	array	Additional segments to track. Predictive segments are tracked by default
excludedTargetingSegmentList	array	Segments to be excluded from your recommendations
siteType	enum	Typology of the website. Can be [ECOMMERCE, MEDIA, OTHER]
ignoreURLSettings	boolean	Ignore the settings in the URL of your pages
predictiveTargeting	boolean	Activate predictive targeting option
excludedGoalList	array	Goals to be excluded from your recommendations
includedExperimentList	array	A/B tests to be privileged in your recommendations
excludedExperimentList	array	A/B tests to be excluded from your recommendations
includedPersonalizationList	array	Personalizations to be privileged in your recommendations
excludedPersonalizationList	array	Personalizations to be excluded from your recommendations
cartAmountGoal	long	Goal to which the value of customer's basket is linked
cartAmountValue	long	Conversion value linked to the primary goal

{
  "id" : "123456789",
  "url" : "string",
  "description" : "string",
  "code" : "string",
  "behaviorWhenTimeout" : "RUN",
  "dataStorage" : "STANDARD_COOKIE",
  "trackingScript" : "string",
  "domainNames" : [ "[]" ],
  "indicators" : [ "RETENTION_RATE" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "isScriptActive" : "false",
  "captureEventMethod" : "CLICK",
  "isAudienceUsed" : "false",
  "isKameleoonEnabled" : "false",
  "experimentConfig" : {
    "isEditorLaunchedByShortcut" : "false",
    "isKameleoonReportingEnabled" : "false",
    "customVariationSelectionScript" : "string",
    "minWiningReliability" : "1234",
    "abtestConsent" : "OFF",
    "abtestConsentOptout" : "RUN",
    "beforeAbtestConsent" : "NONE"
  },
  "personalizationConfig" : {
    "personalizationsDeviation" : "132.987",
    "isSameTypePersonalizationEnabled" : "false",
    "isSameJqueryInjectionAllowed" : "false",
    "personalizationConsent" : "OFF",
    "personalizationConsentOptout" : "RUN",
    "beforePersonalizationConsent" : "NONE"
  },
  "audienceConfig" : {
    "mainGoal" : "123456789",
    "includedTargetingTypeList" : [ "PAGE_URL" ],
    "excludedTargetingTypeList" : [ "PAGE_URL" ],
    "includedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "excludedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "includedCustomData" : [ "[]" ],
    "excludedCustomData" : [ "[]" ],
    "includedTargetingSegmentList" : [ "[]" ],
    "excludedTargetingSegmentList" : [ "[]" ],
    "siteType" : "ECOMMERCE",
    "ignoreURLSettings" : "false",
    "predictiveTargeting" : "false",
    "excludedGoalList" : [ "[]" ],
    "includedExperimentList" : [ "[]" ],
    "excludedExperimentList" : [ "[]" ],
    "includedPersonalizationList" : [ "[]" ],
    "excludedPersonalizationList" : [ "[]" ],
    "cartAmountGoal" : "123456789",
    "cartAmountValue" : "123456789"
  }
}

Response body

Site

Name	Type	Description
id	long	The unique identifier for the website
url	string	URL of the website
description	string	Website description
code	string	System generated code to uniquely identify a website.
behaviorWhenTimeout	enum	Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch with a flicker effect.. Can be [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]
dataStorage	enum	This option allows you to choose source where to store the data of your A/B tests on the the visitor's device. Can be [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]
trackingScript	string	Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.
domainNames	array
indicators	array	List of indicators such as: Retention rate, number of pages seen and dwell time. Can be [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]
dateCreated	datetime	Date when the site was created.
isScriptActive	boolean	Identifies if the script is installed successfully and is active on the website
captureEventMethod	enum	. Can be [CLICK, MOUSEDOWN, MOUSEUP]
isAudienceUsed	boolean	Identifies where audience feature is enabled and used for the website
isKameleoonEnabled	boolean	This field represents if Kameleoon application is enbabled for the website
experimentConfig	ExperimentConfig	Configuration of an experiment
personalizationConfig	PersonalizationConfig	Configuration of a personalization
audienceConfig	AudienceConfig	Audience configuration

AudienceConfigUrl

Name	Type	Description
url	string
matchType	enum	. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

PersonalizationConfig

Name	Type	Description
personalizationsDeviation	double	Include visitors. Percentage of your visitors included to personalizations. You can define a visitor rate who will never be exposed to your personalizations. We advise youto keep a sample population, not exposed, in order to determine the efficiency of your personalizations.
isSameTypePersonalizationEnabled	boolean	Advanced options. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
isSameJqueryInjectionAllowed	boolean	Allow the injection of jQuery. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
personalizationConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
personalizationConsentOptout	enum	. Can be [RUN, BLOCK]
beforePersonalizationConsent	enum	. Can be [NONE, PARTIALLY, ALL]

ExperimentConfig

Name	Type	Description
isEditorLaunchedByShortcut	boolean	Editor launching. Enable launching the editor via Shift + F2
isKameleoonReportingEnabled	boolean	Result reporting. Activate Kameleoon’s reporting to view test results
customVariationSelectionScript	string	Variation selection script. By default, the assignation of an experiment's variation to a visitor is done via a random mechanism. You can write a JavaScript code here to customize this behavior. The code must return the id of the assigned variation (consult the documentation for details).
minWiningReliability	integer	Necessary reliability for the determination of a winning variation. The reliability of the variations is inferior to the rate determined in set-up. The variations cannot be considered as winning in your test results, whatever the number of conversions of these variations. Please be parcimonious about changing this parameter, as this has an impact on the results Kameleoon delivers.
abtestConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
abtestConsentOptout	enum	. Can be [RUN, BLOCK]
beforeAbtestConsent	enum	. Can be [NONE, PARTIALLY, ALL]

AudienceConfig

Name	Type	Description
mainGoal	long	Primary goal, it must correspond to the main conversion action of the site
includedTargetingTypeList	array	The 3 targeting criteria to be treated primarily in your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
excludedTargetingTypeList	array	Targeting criteria to be excluded from your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
includedConfigurationUrlList	array[AudienceConfigUrl]	URLs you want to optimize primarily
excludedConfigurationUrlList	array[AudienceConfigUrl]	URLS to be excluded from your recommendations
includedCustomData	array	Personalized data to be treated primarily in your recommendations
excludedCustomData	array	Personalized data to be excluded from your recommendations
includedTargetingSegmentList	array	Additional segments to track. Predictive segments are tracked by default
excludedTargetingSegmentList	array	Segments to be excluded from your recommendations
siteType	enum	Typology of the website. Can be [ECOMMERCE, MEDIA, OTHER]
ignoreURLSettings	boolean	Ignore the settings in the URL of your pages
predictiveTargeting	boolean	Activate predictive targeting option
excludedGoalList	array	Goals to be excluded from your recommendations
includedExperimentList	array	A/B tests to be privileged in your recommendations
excludedExperimentList	array	A/B tests to be excluded from your recommendations
includedPersonalizationList	array	Personalizations to be privileged in your recommendations
excludedPersonalizationList	array	Personalizations to be excluded from your recommendations
cartAmountGoal	long	Goal to which the value of customer's basket is linked
cartAmountValue	long	Conversion value linked to the primary goal

Get integration tools

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/sites/{siteId}/integration-tools"

GET /sites/{siteId}/integration-tools

Get integration tools on site with given id

Request arguments

Name	Place	Type	Description
siteId	path	long	siteId

[ {
  "enabled" : "false",
  "type" : "GOOGLE_ANALYTICS",
  "settings" : { }
} ]

Response body

IntegrationTool

Name	Type	Description
enabled	boolean	This field indicates where integration tool is enabled
type	enum	Integration type that is selected from a list of available integrations. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
settings	IntegrationSettings	Different settings stored for a given integration. Type of settings depends on 'type' field. 'ADOBE_OMNITURE' - AdobeOmnitureSettings. 'GOOGLE_ANALYTICS' - GoogleAnalyticsSettings. 'UNIVERSAL_ANALYTICS' - UniversalAnalyticsSettings. 'AT_INTERNET' - ATInternetSettings. 'SMART_TAG' - SmartTagSettings. 'HEATMAP' - HeatmapSettings. 'COM_SCORE' - ComScoreSettings. 'TEALIUM' - TealiumSettings. 'YSANCE' - YsanceSettings. 'MANDRILL' - MandrillSettings. 'SMARTFOCUS' - SmartFocusSettings. 'MAILJET' - MailjetSettings. 'MAILUP' - MailupSettings. 'EMARSYS' - EmarsysSettings. 'EXPERT_SENDER' - ExpertSenderSettings. 'CONTENT_SQUARE' - ContentSquareSettings. 'CUSTOM_INTEGRATION' - CustomIntegrationSettings. 'HEAP' - HeapSettings. 'SEGMENT' - SegmentSettings. 'MIXPANEL' - MixpanelSettings. 'IABTCF' - IabtcfSettings. For others types params aren't needed.

SmartFocusSettings

Name	Type	Description
keys	array

YsanceSettings

Name	Type	Description
id	string
tracking	boolean
customVariable	integer

AdobeOmnitureSettings

Name	Type	Description
object	string
anchorReferrer	boolean
objectDetectionScript	string
forbiddenEVars	array
eventCallDelayed	boolean
willIncludeTracksentMarker	boolean

MailupSettings

Name	Type	Description
accounts	array[MailupSettingsAccount]

ATInternetSettings

Name	Type	Description
forceXtCoreMissing	boolean
xtCoreMissingScript	string
predefinedTagName	string

ToolCustomIntegrationSettings

Name	Type	Description
name	string
connectionId	string

MailjetSettingsAccount

Name	Type	Description
key	string
password	string

MailjetSettings

Name	Type	Description
accounts	array[MailjetSettingsAccount]

ExpertSenderSettings

Name	Type	Description
keys	array

SmartTagSettings

Name	Type	Description
predefinedTagName	string

UniversalAnalyticsSettings

Name	Type	Description
trackingId	string
dimensionTracking	boolean
eventTracking	boolean
pageViewTracking	boolean
eventCallDelayed	boolean
premium	boolean

GoogleAnalyticsSettings

Name	Type	Description
tracker	string
forbiddenCustomVariables	array
premium	boolean
allowAnchor	boolean
customVariableTracking	boolean
eventTracking	boolean
pageViewTracking	boolean
eventCallDelayed	boolean
token	string
secret	string

MailPerformanceSettings

Name	Type	Description
keys	array

ComScoreSettings

Name	Type	Description
customerId	string
domain	string

ContentSquareSettings

Name	Type	Description
dimensionTracking	boolean

HeatmapSettings

Name	Type	Description
pageWidth	integer

EmarsysSettings

Name	Type	Description
keys	array

MailupSettingsAccount

Name	Type	Description
key	string
secret	string
username	string
password	string

MandrillSettings

Name	Type	Description
keys	array

TealiumSettings

Name	Type	Description
account	string
profile	string

CustomIntegrationSettings

Name	Type	Description
tools	array[ToolCustomIntegrationSettings]

Update selected integration tool

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/sites/{siteId}/integration-tools"
{
  "enabled" : "false",
  "type" : "GOOGLE_ANALYTICS",
  "settings" : { }
}

PUT /sites/{siteId}/integration-tools

Update integration tools on site with given id

Request arguments

Name	Place	Type	Description
siteId	path	long	siteId

Request body

IntegrationTool

Name	Type	Description
enabled `*required`	boolean	This field indicates where integration tool is enabled
type `*required`	enum	Integration type that is selected from a list of available integrations. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
settings	IntegrationSettings	Different settings stored for a given integration. Type of settings depends on 'type' field. 'ADOBE_OMNITURE' - AdobeOmnitureSettings. 'GOOGLE_ANALYTICS' - GoogleAnalyticsSettings. 'UNIVERSAL_ANALYTICS' - UniversalAnalyticsSettings. 'AT_INTERNET' - ATInternetSettings. 'SMART_TAG' - SmartTagSettings. 'HEATMAP' - HeatmapSettings. 'COM_SCORE' - ComScoreSettings. 'TEALIUM' - TealiumSettings. 'YSANCE' - YsanceSettings. 'MANDRILL' - MandrillSettings. 'SMARTFOCUS' - SmartFocusSettings. 'MAILJET' - MailjetSettings. 'MAILUP' - MailupSettings. 'EMARSYS' - EmarsysSettings. 'EXPERT_SENDER' - ExpertSenderSettings. 'CONTENT_SQUARE' - ContentSquareSettings. 'CUSTOM_INTEGRATION' - CustomIntegrationSettings. 'HEAP' - HeapSettings. 'SEGMENT' - SegmentSettings. 'MIXPANEL' - MixpanelSettings. 'IABTCF' - IabtcfSettings. For others types params aren't needed.

SmartFocusSettings

Name	Type	Description
keys	array

YsanceSettings

Name	Type	Description
id	string
tracking	boolean
customVariable	integer

AdobeOmnitureSettings

Name	Type	Description
object	string
anchorReferrer	boolean
objectDetectionScript	string
forbiddenEVars	array
eventCallDelayed	boolean
willIncludeTracksentMarker	boolean

MailupSettings

Name	Type	Description
accounts	array[MailupSettingsAccount]

ATInternetSettings

Name	Type	Description
forceXtCoreMissing	boolean
xtCoreMissingScript	string
predefinedTagName	string

ToolCustomIntegrationSettings

Name	Type	Description
name	string
connectionId	string

MailjetSettingsAccount

Name	Type	Description
key	string
password	string

MailjetSettings

Name	Type	Description
accounts	array[MailjetSettingsAccount]

ExpertSenderSettings

Name	Type	Description
keys	array

SmartTagSettings

Name	Type	Description
predefinedTagName	string

UniversalAnalyticsSettings

Name	Type	Description
trackingId	string
dimensionTracking	boolean
eventTracking	boolean
pageViewTracking	boolean
eventCallDelayed	boolean
premium	boolean

GoogleAnalyticsSettings

Name	Type	Description
tracker	string
forbiddenCustomVariables	array
premium	boolean
allowAnchor	boolean
customVariableTracking	boolean
eventTracking	boolean
pageViewTracking	boolean
eventCallDelayed	boolean
token	string
secret	string

MailPerformanceSettings

Name	Type	Description
keys	array

ComScoreSettings

Name	Type	Description
customerId	string
domain	string

ContentSquareSettings

Name	Type	Description
dimensionTracking	boolean

HeatmapSettings

Name	Type	Description
pageWidth	integer

EmarsysSettings

Name	Type	Description
keys	array

MailupSettingsAccount

Name	Type	Description
key	string
secret	string
username	string
password	string

MandrillSettings

Name	Type	Description
keys	array

TealiumSettings

Name	Type	Description
account	string
profile	string

CustomIntegrationSettings

Name	Type	Description
tools	array[ToolCustomIntegrationSettings]

{
  "enabled" : "false",
  "type" : "GOOGLE_ANALYTICS",
  "settings" : { }
}

Response body

IntegrationTool

Name	Type	Description
enabled	boolean	This field indicates where integration tool is enabled
type	enum	Integration type that is selected from a list of available integrations. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
settings	IntegrationSettings	Different settings stored for a given integration. Type of settings depends on 'type' field. 'ADOBE_OMNITURE' - AdobeOmnitureSettings. 'GOOGLE_ANALYTICS' - GoogleAnalyticsSettings. 'UNIVERSAL_ANALYTICS' - UniversalAnalyticsSettings. 'AT_INTERNET' - ATInternetSettings. 'SMART_TAG' - SmartTagSettings. 'HEATMAP' - HeatmapSettings. 'COM_SCORE' - ComScoreSettings. 'TEALIUM' - TealiumSettings. 'YSANCE' - YsanceSettings. 'MANDRILL' - MandrillSettings. 'SMARTFOCUS' - SmartFocusSettings. 'MAILJET' - MailjetSettings. 'MAILUP' - MailupSettings. 'EMARSYS' - EmarsysSettings. 'EXPERT_SENDER' - ExpertSenderSettings. 'CONTENT_SQUARE' - ContentSquareSettings. 'CUSTOM_INTEGRATION' - CustomIntegrationSettings. 'HEAP' - HeapSettings. 'SEGMENT' - SegmentSettings. 'MIXPANEL' - MixpanelSettings. 'IABTCF' - IabtcfSettings. For others types params aren't needed.

SmartFocusSettings

Name	Type	Description
keys	array

YsanceSettings

Name	Type	Description
id	string
tracking	boolean
customVariable	integer

AdobeOmnitureSettings

Name	Type	Description
object	string
anchorReferrer	boolean
objectDetectionScript	string
forbiddenEVars	array
eventCallDelayed	boolean
willIncludeTracksentMarker	boolean

MailupSettings

Name	Type	Description
accounts	array[MailupSettingsAccount]

ATInternetSettings

Name	Type	Description
forceXtCoreMissing	boolean
xtCoreMissingScript	string
predefinedTagName	string

ToolCustomIntegrationSettings

Name	Type	Description
name	string
connectionId	string

MailjetSettingsAccount

Name	Type	Description
key	string
password	string

MailjetSettings

Name	Type	Description
accounts	array[MailjetSettingsAccount]

ExpertSenderSettings

Name	Type	Description
keys	array

SmartTagSettings

Name	Type	Description
predefinedTagName	string

UniversalAnalyticsSettings

Name	Type	Description
trackingId	string
dimensionTracking	boolean
eventTracking	boolean
pageViewTracking	boolean
eventCallDelayed	boolean
premium	boolean

GoogleAnalyticsSettings

Name	Type	Description
tracker	string
forbiddenCustomVariables	array
premium	boolean
allowAnchor	boolean
customVariableTracking	boolean
eventTracking	boolean
pageViewTracking	boolean
eventCallDelayed	boolean
token	string
secret	string

MailPerformanceSettings

Name	Type	Description
keys	array

ComScoreSettings

Name	Type	Description
customerId	string
domain	string

ContentSquareSettings

Name	Type	Description
dimensionTracking	boolean

HeatmapSettings

Name	Type	Description
pageWidth	integer

EmarsysSettings

Name	Type	Description
keys	array

MailupSettingsAccount

Name	Type	Description
key	string
secret	string
username	string
password	string

MandrillSettings

Name	Type	Description
keys	array

TealiumSettings

Name	Type	Description
account	string
profile	string

CustomIntegrationSettings

Name	Type	Description
tools	array[ToolCustomIntegrationSettings]

Create new site

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/sites"
{
  "id" : "123456789",
  "url" : "string",
  "description" : "string",
  "code" : "string",
  "behaviorWhenTimeout" : "RUN",
  "dataStorage" : "STANDARD_COOKIE",
  "trackingScript" : "string",
  "domainNames" : [ "[]" ],
  "indicators" : [ "RETENTION_RATE" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "isScriptActive" : "false",
  "captureEventMethod" : "CLICK",
  "isAudienceUsed" : "false",
  "isKameleoonEnabled" : "false",
  "experimentConfig" : {
    "isEditorLaunchedByShortcut" : "false",
    "isKameleoonReportingEnabled" : "false",
    "customVariationSelectionScript" : "string",
    "minWiningReliability" : "1234",
    "abtestConsent" : "OFF",
    "abtestConsentOptout" : "RUN",
    "beforeAbtestConsent" : "NONE"
  },
  "personalizationConfig" : {
    "personalizationsDeviation" : "132.987",
    "isSameTypePersonalizationEnabled" : "false",
    "isSameJqueryInjectionAllowed" : "false",
    "personalizationConsent" : "OFF",
    "personalizationConsentOptout" : "RUN",
    "beforePersonalizationConsent" : "NONE"
  },
  "audienceConfig" : {
    "mainGoal" : "123456789",
    "includedTargetingTypeList" : [ "PAGE_URL" ],
    "excludedTargetingTypeList" : [ "PAGE_URL" ],
    "includedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "excludedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "includedCustomData" : [ "[]" ],
    "excludedCustomData" : [ "[]" ],
    "includedTargetingSegmentList" : [ "[]" ],
    "excludedTargetingSegmentList" : [ "[]" ],
    "siteType" : "ECOMMERCE",
    "ignoreURLSettings" : "false",
    "predictiveTargeting" : "false",
    "excludedGoalList" : [ "[]" ],
    "includedExperimentList" : [ "[]" ],
    "excludedExperimentList" : [ "[]" ],
    "includedPersonalizationList" : [ "[]" ],
    "excludedPersonalizationList" : [ "[]" ],
    "cartAmountGoal" : "123456789",
    "cartAmountValue" : "123456789"
  }
}

POST /sites

Create new site with given parameters

Request body

Site

Name	Type	Description
id `*read only`	long	The unique identifier for the website
url `*required`	string	URL of the website
description	string	Website description
code `*read only`	string	System generated code to uniquely identify a website.
behaviorWhenTimeout	enum	Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch with a flicker effect.. Can be [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]
dataStorage	enum	This option allows you to choose source where to store the data of your A/B tests on the the visitor's device. Can be [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]
trackingScript	string	Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.
domainNames	array
indicators	array	List of indicators such as: Retention rate, number of pages seen and dwell time. Can be [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]
dateCreated `*read only`	datetime	Date when the site was created.
isScriptActive	boolean	Identifies if the script is installed successfully and is active on the website
captureEventMethod	enum	. Can be [CLICK, MOUSEDOWN, MOUSEUP]
isAudienceUsed	boolean	Identifies where audience feature is enabled and used for the website
isKameleoonEnabled	boolean	This field represents if Kameleoon application is enbabled for the website
experimentConfig	ExperimentConfig	Configuration of an experiment
personalizationConfig	PersonalizationConfig	Configuration of a personalization
audienceConfig	AudienceConfig	Audience configuration

AudienceConfigUrl

Name	Type	Description
url	string
matchType	enum	. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

PersonalizationConfig

Name	Type	Description
personalizationsDeviation	double	Include visitors. Percentage of your visitors included to personalizations. You can define a visitor rate who will never be exposed to your personalizations. We advise youto keep a sample population, not exposed, in order to determine the efficiency of your personalizations.
isSameTypePersonalizationEnabled	boolean	Advanced options. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
isSameJqueryInjectionAllowed	boolean	Allow the injection of jQuery. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
personalizationConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
personalizationConsentOptout	enum	. Can be [RUN, BLOCK]
beforePersonalizationConsent	enum	. Can be [NONE, PARTIALLY, ALL]

ExperimentConfig

Name	Type	Description
isEditorLaunchedByShortcut	boolean	Editor launching. Enable launching the editor via Shift + F2
isKameleoonReportingEnabled	boolean	Result reporting. Activate Kameleoon’s reporting to view test results
customVariationSelectionScript	string	Variation selection script. By default, the assignation of an experiment's variation to a visitor is done via a random mechanism. You can write a JavaScript code here to customize this behavior. The code must return the id of the assigned variation (consult the documentation for details).
minWiningReliability	integer	Necessary reliability for the determination of a winning variation. The reliability of the variations is inferior to the rate determined in set-up. The variations cannot be considered as winning in your test results, whatever the number of conversions of these variations. Please be parcimonious about changing this parameter, as this has an impact on the results Kameleoon delivers.
abtestConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
abtestConsentOptout	enum	. Can be [RUN, BLOCK]
beforeAbtestConsent	enum	. Can be [NONE, PARTIALLY, ALL]

AudienceConfig

Name	Type	Description
mainGoal `*required`	long	Primary goal, it must correspond to the main conversion action of the site
includedTargetingTypeList	array	The 3 targeting criteria to be treated primarily in your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
excludedTargetingTypeList	array	Targeting criteria to be excluded from your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
includedConfigurationUrlList	array[AudienceConfigUrl]	URLs you want to optimize primarily
excludedConfigurationUrlList	array[AudienceConfigUrl]	URLS to be excluded from your recommendations
includedCustomData	array	Personalized data to be treated primarily in your recommendations
excludedCustomData	array	Personalized data to be excluded from your recommendations
includedTargetingSegmentList	array	Additional segments to track. Predictive segments are tracked by default
excludedTargetingSegmentList	array	Segments to be excluded from your recommendations
siteType	enum	Typology of the website. Can be [ECOMMERCE, MEDIA, OTHER]
ignoreURLSettings	boolean	Ignore the settings in the URL of your pages
predictiveTargeting	boolean	Activate predictive targeting option
excludedGoalList	array	Goals to be excluded from your recommendations
includedExperimentList	array	A/B tests to be privileged in your recommendations
excludedExperimentList	array	A/B tests to be excluded from your recommendations
includedPersonalizationList	array	Personalizations to be privileged in your recommendations
excludedPersonalizationList	array	Personalizations to be excluded from your recommendations
cartAmountGoal	long	Goal to which the value of customer's basket is linked
cartAmountValue	long	Conversion value linked to the primary goal

{
  "id" : "123456789",
  "url" : "string",
  "description" : "string",
  "code" : "string",
  "behaviorWhenTimeout" : "RUN",
  "dataStorage" : "STANDARD_COOKIE",
  "trackingScript" : "string",
  "domainNames" : [ "[]" ],
  "indicators" : [ "RETENTION_RATE" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "isScriptActive" : "false",
  "captureEventMethod" : "CLICK",
  "isAudienceUsed" : "false",
  "isKameleoonEnabled" : "false",
  "experimentConfig" : {
    "isEditorLaunchedByShortcut" : "false",
    "isKameleoonReportingEnabled" : "false",
    "customVariationSelectionScript" : "string",
    "minWiningReliability" : "1234",
    "abtestConsent" : "OFF",
    "abtestConsentOptout" : "RUN",
    "beforeAbtestConsent" : "NONE"
  },
  "personalizationConfig" : {
    "personalizationsDeviation" : "132.987",
    "isSameTypePersonalizationEnabled" : "false",
    "isSameJqueryInjectionAllowed" : "false",
    "personalizationConsent" : "OFF",
    "personalizationConsentOptout" : "RUN",
    "beforePersonalizationConsent" : "NONE"
  },
  "audienceConfig" : {
    "mainGoal" : "123456789",
    "includedTargetingTypeList" : [ "PAGE_URL" ],
    "excludedTargetingTypeList" : [ "PAGE_URL" ],
    "includedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "excludedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "includedCustomData" : [ "[]" ],
    "excludedCustomData" : [ "[]" ],
    "includedTargetingSegmentList" : [ "[]" ],
    "excludedTargetingSegmentList" : [ "[]" ],
    "siteType" : "ECOMMERCE",
    "ignoreURLSettings" : "false",
    "predictiveTargeting" : "false",
    "excludedGoalList" : [ "[]" ],
    "includedExperimentList" : [ "[]" ],
    "excludedExperimentList" : [ "[]" ],
    "includedPersonalizationList" : [ "[]" ],
    "excludedPersonalizationList" : [ "[]" ],
    "cartAmountGoal" : "123456789",
    "cartAmountValue" : "123456789"
  }
}

Response body

Site

Name	Type	Description
id	long	The unique identifier for the website
url	string	URL of the website
description	string	Website description
code	string	System generated code to uniquely identify a website.
behaviorWhenTimeout	enum	Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch with a flicker effect.. Can be [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]
dataStorage	enum	This option allows you to choose source where to store the data of your A/B tests on the the visitor's device. Can be [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]
trackingScript	string	Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.
domainNames	array
indicators	array	List of indicators such as: Retention rate, number of pages seen and dwell time. Can be [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]
dateCreated	datetime	Date when the site was created.
isScriptActive	boolean	Identifies if the script is installed successfully and is active on the website
captureEventMethod	enum	. Can be [CLICK, MOUSEDOWN, MOUSEUP]
isAudienceUsed	boolean	Identifies where audience feature is enabled and used for the website
isKameleoonEnabled	boolean	This field represents if Kameleoon application is enbabled for the website
experimentConfig	ExperimentConfig	Configuration of an experiment
personalizationConfig	PersonalizationConfig	Configuration of a personalization
audienceConfig	AudienceConfig	Audience configuration

AudienceConfigUrl

Name	Type	Description
url	string
matchType	enum	. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

PersonalizationConfig

Name	Type	Description
personalizationsDeviation	double	Include visitors. Percentage of your visitors included to personalizations. You can define a visitor rate who will never be exposed to your personalizations. We advise youto keep a sample population, not exposed, in order to determine the efficiency of your personalizations.
isSameTypePersonalizationEnabled	boolean	Advanced options. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
isSameJqueryInjectionAllowed	boolean	Allow the injection of jQuery. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
personalizationConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
personalizationConsentOptout	enum	. Can be [RUN, BLOCK]
beforePersonalizationConsent	enum	. Can be [NONE, PARTIALLY, ALL]

ExperimentConfig

Name	Type	Description
isEditorLaunchedByShortcut	boolean	Editor launching. Enable launching the editor via Shift + F2
isKameleoonReportingEnabled	boolean	Result reporting. Activate Kameleoon’s reporting to view test results
customVariationSelectionScript	string	Variation selection script. By default, the assignation of an experiment's variation to a visitor is done via a random mechanism. You can write a JavaScript code here to customize this behavior. The code must return the id of the assigned variation (consult the documentation for details).
minWiningReliability	integer	Necessary reliability for the determination of a winning variation. The reliability of the variations is inferior to the rate determined in set-up. The variations cannot be considered as winning in your test results, whatever the number of conversions of these variations. Please be parcimonious about changing this parameter, as this has an impact on the results Kameleoon delivers.
abtestConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
abtestConsentOptout	enum	. Can be [RUN, BLOCK]
beforeAbtestConsent	enum	. Can be [NONE, PARTIALLY, ALL]

AudienceConfig

Name	Type	Description
mainGoal	long	Primary goal, it must correspond to the main conversion action of the site
includedTargetingTypeList	array	The 3 targeting criteria to be treated primarily in your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
excludedTargetingTypeList	array	Targeting criteria to be excluded from your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
includedConfigurationUrlList	array[AudienceConfigUrl]	URLs you want to optimize primarily
excludedConfigurationUrlList	array[AudienceConfigUrl]	URLS to be excluded from your recommendations
includedCustomData	array	Personalized data to be treated primarily in your recommendations
excludedCustomData	array	Personalized data to be excluded from your recommendations
includedTargetingSegmentList	array	Additional segments to track. Predictive segments are tracked by default
excludedTargetingSegmentList	array	Segments to be excluded from your recommendations
siteType	enum	Typology of the website. Can be [ECOMMERCE, MEDIA, OTHER]
ignoreURLSettings	boolean	Ignore the settings in the URL of your pages
predictiveTargeting	boolean	Activate predictive targeting option
excludedGoalList	array	Goals to be excluded from your recommendations
includedExperimentList	array	A/B tests to be privileged in your recommendations
excludedExperimentList	array	A/B tests to be excluded from your recommendations
includedPersonalizationList	array	Personalizations to be privileged in your recommendations
excludedPersonalizationList	array	Personalizations to be excluded from your recommendations
cartAmountGoal	long	Goal to which the value of customer's basket is linked
cartAmountValue	long	Conversion value linked to the primary goal

Get all sites

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/sites"

GET /sites

Get list of all sites of the customer

Request arguments

Name	Place	Type	Description
optionalFields	query	array	optionalFields

[ {
  "id" : "123456789",
  "url" : "string",
  "description" : "string",
  "code" : "string",
  "behaviorWhenTimeout" : "RUN",
  "dataStorage" : "STANDARD_COOKIE",
  "trackingScript" : "string",
  "domainNames" : [ "[]" ],
  "indicators" : [ "RETENTION_RATE" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "isScriptActive" : "false",
  "captureEventMethod" : "CLICK",
  "isAudienceUsed" : "false",
  "isKameleoonEnabled" : "false",
  "experimentConfig" : {
    "isEditorLaunchedByShortcut" : "false",
    "isKameleoonReportingEnabled" : "false",
    "customVariationSelectionScript" : "string",
    "minWiningReliability" : "1234",
    "abtestConsent" : "OFF",
    "abtestConsentOptout" : "RUN",
    "beforeAbtestConsent" : "NONE"
  },
  "personalizationConfig" : {
    "personalizationsDeviation" : "132.987",
    "isSameTypePersonalizationEnabled" : "false",
    "isSameJqueryInjectionAllowed" : "false",
    "personalizationConsent" : "OFF",
    "personalizationConsentOptout" : "RUN",
    "beforePersonalizationConsent" : "NONE"
  },
  "audienceConfig" : {
    "mainGoal" : "123456789",
    "includedTargetingTypeList" : [ "PAGE_URL" ],
    "excludedTargetingTypeList" : [ "PAGE_URL" ],
    "includedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "excludedConfigurationUrlList" : [ {
      "url" : "string",
      "matchType" : "EXACT"
    } ],
    "includedCustomData" : [ "[]" ],
    "excludedCustomData" : [ "[]" ],
    "includedTargetingSegmentList" : [ "[]" ],
    "excludedTargetingSegmentList" : [ "[]" ],
    "siteType" : "ECOMMERCE",
    "ignoreURLSettings" : "false",
    "predictiveTargeting" : "false",
    "excludedGoalList" : [ "[]" ],
    "includedExperimentList" : [ "[]" ],
    "excludedExperimentList" : [ "[]" ],
    "includedPersonalizationList" : [ "[]" ],
    "excludedPersonalizationList" : [ "[]" ],
    "cartAmountGoal" : "123456789",
    "cartAmountValue" : "123456789"
  }
} ]

Response body

Site

Name	Type	Description
id	long	The unique identifier for the website
url	string	URL of the website
description	string	Website description
code	string	System generated code to uniquely identify a website.
behaviorWhenTimeout	enum	Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch with a flicker effect.. Can be [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]
dataStorage	enum	This option allows you to choose source where to store the data of your A/B tests on the the visitor's device. Can be [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]
trackingScript	string	Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.
domainNames	array
indicators	array	List of indicators such as: Retention rate, number of pages seen and dwell time. Can be [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]
dateCreated	datetime	Date when the site was created.
isScriptActive	boolean	Identifies if the script is installed successfully and is active on the website
captureEventMethod	enum	. Can be [CLICK, MOUSEDOWN, MOUSEUP]
isAudienceUsed	boolean	Identifies where audience feature is enabled and used for the website
isKameleoonEnabled	boolean	This field represents if Kameleoon application is enbabled for the website
experimentConfig	ExperimentConfig	Configuration of an experiment
personalizationConfig	PersonalizationConfig	Configuration of a personalization
audienceConfig	AudienceConfig	Audience configuration

AudienceConfigUrl

Name	Type	Description
url	string
matchType	enum	. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

PersonalizationConfig

Name	Type	Description
personalizationsDeviation	double	Include visitors. Percentage of your visitors included to personalizations. You can define a visitor rate who will never be exposed to your personalizations. We advise youto keep a sample population, not exposed, in order to determine the efficiency of your personalizations.
isSameTypePersonalizationEnabled	boolean	Advanced options. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
isSameJqueryInjectionAllowed	boolean	Allow the injection of jQuery. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
personalizationConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
personalizationConsentOptout	enum	. Can be [RUN, BLOCK]
beforePersonalizationConsent	enum	. Can be [NONE, PARTIALLY, ALL]

ExperimentConfig

Name	Type	Description
isEditorLaunchedByShortcut	boolean	Editor launching. Enable launching the editor via Shift + F2
isKameleoonReportingEnabled	boolean	Result reporting. Activate Kameleoon’s reporting to view test results
customVariationSelectionScript	string	Variation selection script. By default, the assignation of an experiment's variation to a visitor is done via a random mechanism. You can write a JavaScript code here to customize this behavior. The code must return the id of the assigned variation (consult the documentation for details).
minWiningReliability	integer	Necessary reliability for the determination of a winning variation. The reliability of the variations is inferior to the rate determined in set-up. The variations cannot be considered as winning in your test results, whatever the number of conversions of these variations. Please be parcimonious about changing this parameter, as this has an impact on the results Kameleoon delivers.
abtestConsent	enum	. Can be [OFF, REQUIRED, INTERACTIVE, IABTCF]
abtestConsentOptout	enum	. Can be [RUN, BLOCK]
beforeAbtestConsent	enum	. Can be [NONE, PARTIALLY, ALL]

AudienceConfig

Name	Type	Description
mainGoal	long	Primary goal, it must correspond to the main conversion action of the site
includedTargetingTypeList	array	The 3 targeting criteria to be treated primarily in your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
excludedTargetingTypeList	array	Targeting criteria to be excluded from your recommendations. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, 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, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, MEAN_PAGE_DURATION, TIME_SINCE_PREVIOUS_VISIT]
includedConfigurationUrlList	array[AudienceConfigUrl]	URLs you want to optimize primarily
excludedConfigurationUrlList	array[AudienceConfigUrl]	URLS to be excluded from your recommendations
includedCustomData	array	Personalized data to be treated primarily in your recommendations
excludedCustomData	array	Personalized data to be excluded from your recommendations
includedTargetingSegmentList	array	Additional segments to track. Predictive segments are tracked by default
excludedTargetingSegmentList	array	Segments to be excluded from your recommendations
siteType	enum	Typology of the website. Can be [ECOMMERCE, MEDIA, OTHER]
ignoreURLSettings	boolean	Ignore the settings in the URL of your pages
predictiveTargeting	boolean	Activate predictive targeting option
excludedGoalList	array	Goals to be excluded from your recommendations
includedExperimentList	array	A/B tests to be privileged in your recommendations
excludedExperimentList	array	A/B tests to be excluded from your recommendations
includedPersonalizationList	array	Personalizations to be privileged in your recommendations
excludedPersonalizationList	array	Personalizations to be excluded from your recommendations
cartAmountGoal	long	Goal to which the value of customer's basket is linked
cartAmountValue	long	Conversion value linked to the primary goal

Start the export of raw data

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/sites/{siteId}/dataExport"
{
  "siteId" : "123456789",
  "dateStart" : "2021-04-07",
  "dateEnd" : "2021-04-07",
  "type" : "EXTRACT",
  "fileName" : "string",
  "status" : "FINISHED",
  "comment" : "string"
}

POST /sites/{siteId}/dataExport

Start a raw data exportation for given site

Request arguments

Name	Place	Type	Description
siteId	path	long	siteId

Request body

DataExport

Name	Type	Description
siteId `*read only`	long	The unique identifier for the website.
dateStart `*required`	date	The date when the extraction of data begins.
dateEnd `*required`	date	The date when the extraction of data stops.
type `*required`	enum	The type of extraction. Can be [EXTRACT, REPORTING]
fileName `*read only`	string
status `*read only`	enum	. Can be [FINISHED, FAILED, RUNNING, QUEUED]
comment `*read only`	string

{
  "siteId" : "123456789",
  "dateStart" : "2021-04-07",
  "dateEnd" : "2021-04-07",
  "type" : "EXTRACT",
  "fileName" : "string",
  "status" : "FINISHED",
  "comment" : "string"
}

Response body

DataExport

Name	Type	Description
siteId	long	The unique identifier for the website.
dateStart	date	The date when the extraction of data begins.
dateEnd	date	The date when the extraction of data stops.
type	enum	The type of extraction. Can be [EXTRACT, REPORTING]
fileName	string
status	enum	. Can be [FINISHED, FAILED, RUNNING, QUEUED]
comment	string

Get all raw data exports

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/sites/{siteId}/dataExport"

GET /sites/{siteId}/dataExport

Get information about all raw data exports triggered

Request arguments

Name	Place	Type	Description
siteId	path	long	siteId

[ {
  "siteId" : "123456789",
  "dateStart" : "2021-04-07",
  "dateEnd" : "2021-04-07",
  "type" : "EXTRACT",
  "fileName" : "string",
  "status" : "FINISHED",
  "comment" : "string"
} ]

Response body

DataExport

Name	Type	Description
siteId	long	The unique identifier for the website.
dateStart	date	The date when the extraction of data begins.
dateEnd	date	The date when the extraction of data stops.
type	enum	The type of extraction. Can be [EXTRACT, REPORTING]
fileName	string
status	enum	. Can be [FINISHED, FAILED, RUNNING, QUEUED]
comment	string

Get a hash code of the contents of the original application file

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/sites/{siteCode}/hash"
{
  "hashType" : "SHA256"
}

PATCH /sites/{siteCode}/hash

Get the hashCode generated from the content of the original application file

Request arguments

Name	Place	Type	Description
siteCode	path	string	siteCode

Request body

HashTypeInput

Name	Type	Description
hashType	enum	The type of hash function. Default value: 'SHA256'. Can be [SHA256, MD5, SHA1]

Templates

Partial update template

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/templates/{templateId}"
{
  "name" : "string",
  "isConstant" : "false",
  "customEvalCode" : "string",
  "isFiltrableVentilable" : "false",
  "gtmVariableName" : "string",
  "learnable" : "false",
  "isLocalOnly" : "false",
  "method" : "string",
  "tcVariableName" : "string",
  "tealiumVariableName" : "string",
  "type" : "string",
  "tags" : "string"
}

PATCH /templates/{templateId}

Update several fields of template

Request arguments

Name	Place	Type	Description
templateId	path	long	The ID of the template object

Request body

WidgetUpdate

Name	Type	Description
name	string	The name for the given custom data
isConstant	boolean	Indicates whether custom data is a constant
customEvalCode	string	Custom code that will be executed
isFiltrableVentilable	boolean	Indicates whether custom data should be filtered and marked available for a breakdown
gtmVariableName	string	Variable name of the Google Tag Manager
learnable	boolean	Indicates whether this data should be included in Kameleoon machine learning
isLocalOnly	boolean	Indicates whether this data is stored on a user's device only
method	string	A method through which a custom data will be transmitted
tcVariableName	string	Variable name for the tag commander data layer, if it is selected as a transmission method
tealiumVariableName	string	Variable name for the Tealium, if it is selected as a transmission method
type	string	Format of data to be retrieved
tags	string	This fields stores tags that are associated with this record

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "templateJavaScriptCode" : "string",
  "templateCssCode" : "string",
  "templateHtmlCode" : "string",
  "uiHtmlCode" : "string",
  "uiCssCode" : "string",
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateActivated" : "2021-04-07T10:13:22.814277",
  "status" : "DRAFT"
}

Response body

Template

Name	Type	Description
id	long	The unique identifier of the given template
name	string	The name for the given template
siteId	long	The website id that an template belongs to
description	string	Description of template
templateJavaScriptCode	string	templateJavaScriptCode that is associated with this template
templateCssCode	string	templateCssCode that is associated with this template
templateHtmlCode	string	templateHtmlCode that is associated with this template
uiHtmlCode	string	UiHtmlCode that is associated with this template
uiCssCode	string	UiCssCode that is associated with this template
tags	array	This fields stores tags that are associated with this template
dateCreated	datetime	Date and time a record is created
dateModified	datetime	Date and time a record is modified
dateActivated	datetime	Date and time a record is activated
status	enum	Template status. Can be [DRAFT, ACTIVE, PAUSED]

Remove template

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/templates/{templateId}"

DELETE /templates/{templateId}

Remove template with given id

Request arguments

Name	Place	Type	Description
templateId	path	long	The ID of the template object

Get one template

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/templates/{templateId}"

GET /templates/{templateId}

Get one template with the given id

Request arguments

Name	Place	Type	Description
templateId	path	long	The ID of the template object

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "templateJavaScriptCode" : "string",
  "templateCssCode" : "string",
  "templateHtmlCode" : "string",
  "uiHtmlCode" : "string",
  "uiCssCode" : "string",
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateActivated" : "2021-04-07T10:13:22.814277",
  "status" : "DRAFT"
}

Response body

Template

Name	Type	Description
id	long	The unique identifier of the given template
name	string	The name for the given template
siteId	long	The website id that an template belongs to
description	string	Description of template
templateJavaScriptCode	string	templateJavaScriptCode that is associated with this template
templateCssCode	string	templateCssCode that is associated with this template
templateHtmlCode	string	templateHtmlCode that is associated with this template
uiHtmlCode	string	UiHtmlCode that is associated with this template
uiCssCode	string	UiCssCode that is associated with this template
tags	array	This fields stores tags that are associated with this template
dateCreated	datetime	Date and time a record is created
dateModified	datetime	Date and time a record is modified
dateActivated	datetime	Date and time a record is activated
status	enum	Template status. Can be [DRAFT, ACTIVE, PAUSED]

Update template

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/templates/{templateId}"
{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "templateJavaScriptCode" : "string",
  "templateCssCode" : "string",
  "templateHtmlCode" : "string",
  "uiHtmlCode" : "string",
  "uiCssCode" : "string",
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateActivated" : "2021-04-07T10:13:22.814277",
  "status" : "DRAFT"
}

PUT /templates/{templateId}

Update template with given id

Request arguments

Name	Place	Type	Description
templateId	path	long	The ID of the template object

Request body

Template

Name	Type	Description
id `*read only`	long	The unique identifier of the given template
name	string	The name for the given template
siteId `*required`	long	The website id that an template belongs to
description	string	Description of template
templateJavaScriptCode	string	templateJavaScriptCode that is associated with this template
templateCssCode	string	templateCssCode that is associated with this template
templateHtmlCode	string	templateHtmlCode that is associated with this template
uiHtmlCode	string	UiHtmlCode that is associated with this template
uiCssCode	string	UiCssCode that is associated with this template
tags	array	This fields stores tags that are associated with this template
dateCreated `*read only`	datetime	Date and time a record is created
dateModified `*read only`	datetime	Date and time a record is modified
dateActivated `*read only`	datetime	Date and time a record is activated
status	enum	Template status. Can be [DRAFT, ACTIVE, PAUSED]

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "templateJavaScriptCode" : "string",
  "templateCssCode" : "string",
  "templateHtmlCode" : "string",
  "uiHtmlCode" : "string",
  "uiCssCode" : "string",
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateActivated" : "2021-04-07T10:13:22.814277",
  "status" : "DRAFT"
}

Response body

Template

Name	Type	Description
id	long	The unique identifier of the given template
name	string	The name for the given template
siteId	long	The website id that an template belongs to
description	string	Description of template
templateJavaScriptCode	string	templateJavaScriptCode that is associated with this template
templateCssCode	string	templateCssCode that is associated with this template
templateHtmlCode	string	templateHtmlCode that is associated with this template
uiHtmlCode	string	UiHtmlCode that is associated with this template
uiCssCode	string	UiCssCode that is associated with this template
tags	array	This fields stores tags that are associated with this template
dateCreated	datetime	Date and time a record is created
dateModified	datetime	Date and time a record is modified
dateActivated	datetime	Date and time a record is activated
status	enum	Template status. Can be [DRAFT, ACTIVE, PAUSED]

Create a new template

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/templates"
{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "templateJavaScriptCode" : "string",
  "templateCssCode" : "string",
  "templateHtmlCode" : "string",
  "uiHtmlCode" : "string",
  "uiCssCode" : "string",
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateActivated" : "2021-04-07T10:13:22.814277",
  "status" : "DRAFT"
}

POST /templates

Create new template with given parameters

Request body

Template

Name	Type	Description
id `*read only`	long	The unique identifier of the given template
name	string	The name for the given template
siteId `*required`	long	The website id that an template belongs to
description	string	Description of template
templateJavaScriptCode	string	templateJavaScriptCode that is associated with this template
templateCssCode	string	templateCssCode that is associated with this template
templateHtmlCode	string	templateHtmlCode that is associated with this template
uiHtmlCode	string	UiHtmlCode that is associated with this template
uiCssCode	string	UiCssCode that is associated with this template
tags	array	This fields stores tags that are associated with this template
dateCreated `*read only`	datetime	Date and time a record is created
dateModified `*read only`	datetime	Date and time a record is modified
dateActivated `*read only`	datetime	Date and time a record is activated
status	enum	Template status. Can be [DRAFT, ACTIVE, PAUSED]

{
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "templateJavaScriptCode" : "string",
  "templateCssCode" : "string",
  "templateHtmlCode" : "string",
  "uiHtmlCode" : "string",
  "uiCssCode" : "string",
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateActivated" : "2021-04-07T10:13:22.814277",
  "status" : "DRAFT"
}

Response body

Template

Name	Type	Description
id	long	The unique identifier of the given template
name	string	The name for the given template
siteId	long	The website id that an template belongs to
description	string	Description of template
templateJavaScriptCode	string	templateJavaScriptCode that is associated with this template
templateCssCode	string	templateCssCode that is associated with this template
templateHtmlCode	string	templateHtmlCode that is associated with this template
uiHtmlCode	string	UiHtmlCode that is associated with this template
uiCssCode	string	UiCssCode that is associated with this template
tags	array	This fields stores tags that are associated with this template
dateCreated	datetime	Date and time a record is created
dateModified	datetime	Date and time a record is modified
dateActivated	datetime	Date and time a record is activated
status	enum	Template status. Can be [DRAFT, ACTIVE, PAUSED]

List templates

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/templates"

GET /templates

Get list of all templates

[ {
  "id" : "123456789",
  "name" : "string",
  "siteId" : "123456789",
  "description" : "string",
  "templateJavaScriptCode" : "string",
  "templateCssCode" : "string",
  "templateHtmlCode" : "string",
  "uiHtmlCode" : "string",
  "uiCssCode" : "string",
  "tags" : [ "[]" ],
  "dateCreated" : "2021-04-07T10:13:22.814277",
  "dateModified" : "2021-04-07T10:13:22.814277",
  "dateActivated" : "2021-04-07T10:13:22.814277",
  "status" : "DRAFT"
} ]

Response body

Template

Name	Type	Description
id	long	The unique identifier of the given template
name	string	The name for the given template
siteId	long	The website id that an template belongs to
description	string	Description of template
templateJavaScriptCode	string	templateJavaScriptCode that is associated with this template
templateCssCode	string	templateCssCode that is associated with this template
templateHtmlCode	string	templateHtmlCode that is associated with this template
uiHtmlCode	string	UiHtmlCode that is associated with this template
uiCssCode	string	UiCssCode that is associated with this template
tags	array	This fields stores tags that are associated with this template
dateCreated	datetime	Date and time a record is created
dateModified	datetime	Date and time a record is modified
dateActivated	datetime	Date and time a record is activated
status	enum	Template status. Can be [DRAFT, ACTIVE, PAUSED]

Timeline

The timeline lists all user actions performed in the back office.

Export timeline

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/timeline/export"

GET /timeline/export

Export timeline depending on specified format

Request arguments

Name	Place	Type	Description
fileName	query	string	fileName
format	query	string	format

Variations

A variation is a copy of your webpage, which can be edited in order to prepare an experiment or personalization. When you add a new variation, Kameleoon makes a copy of the original page (the one from which you started Kameleoon). Every change will be saved in the variation. When the test is launched, the variation contains all your edits.

Partial update variation

curl -X PATCH \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/variations/{variationId}"
{
  "name" : "string",
  "jsCode" : "string",
  "cssCode" : "string",
  "isJsCodeAfterDomReady" : "false",
  "experimentId" : "123456789"
}

PATCH /variations/{variationId}

Update several fields of a variation

Request arguments

Name	Place	Type	Description
variationId	path	long	variationId

Request body

VariationUpdate

Name	Type	Description
name	string	Name of given variation
jsCode	string	New javascript code for variation
cssCode	string	New css style for variation
isJsCodeAfterDomReady	boolean	Set true if code applied after DOM ready. Default value: true
experimentId	long	Experiment id for this variation

{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "jsCode" : "string",
  "cssCode" : "string",
  "isJsCodeAfterDomReady" : "false",
  "widgetTemplateInput" : "string",
  "redirectionStrings" : "string",
  "redirection" : {
    "type" : "GLOBAL_REDIRECTION",
    "url" : "string",
    "parameters" : "string",
    "includeQueryParameters" : "false"
  },
  "experimentId" : "123456789",
  "customJson" : "string"
}

Response body

Variation

Name	Type	Description
id	long	The unique identifier of the given variation
siteId	long	The unique identifier of the site linked to given variation
name	string	Name of given variation
jsCode	string	New javascript code for variation
cssCode	string	New css style for variation
isJsCodeAfterDomReady	boolean	Set true if code applied after DOM ready. Default value: true
widgetTemplateInput	string	Widget template input data in JSON format.
redirectionStrings	string	Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead
redirection	VariationRedirection	Redirection parameters of a variation
experimentId	long	Experiment id for this variation
customJson	string	Custom JSON for this variation

VariationRedirection

Name	Type	Description
type	enum	Type of the redirection. Can be [GLOBAL_REDIRECTION, PARAMETER_REDIRECTION]
url	string	URL used for the redirection, in case of global redirection
parameters	string	Parameters used for the redirection, in case of parameter redirection
includeQueryParameters	boolean	In case of global redirection, option to include query parameters from the original url

Remove variation

curl -X DELETE \
  -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/variations/{variationId}"

DELETE /variations/{variationId}

Remove the variation with given id

Request arguments

Name	Place	Type	Description
variationId	path	long	variationId

Get one variation

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/variations/{variationId}"

GET /variations/{variationId}

Get one variation with given id

Request arguments

Name	Place	Type	Description
variationId	path	long	variationId

{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "jsCode" : "string",
  "cssCode" : "string",
  "isJsCodeAfterDomReady" : "false",
  "widgetTemplateInput" : "string",
  "redirectionStrings" : "string",
  "redirection" : {
    "type" : "GLOBAL_REDIRECTION",
    "url" : "string",
    "parameters" : "string",
    "includeQueryParameters" : "false"
  },
  "experimentId" : "123456789",
  "customJson" : "string"
}

Response body

Variation

Name	Type	Description
id	long	The unique identifier of the given variation
siteId	long	The unique identifier of the site linked to given variation
name	string	Name of given variation
jsCode	string	New javascript code for variation
cssCode	string	New css style for variation
isJsCodeAfterDomReady	boolean	Set true if code applied after DOM ready. Default value: true
widgetTemplateInput	string	Widget template input data in JSON format.
redirectionStrings	string	Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead
redirection	VariationRedirection	Redirection parameters of a variation
experimentId	long	Experiment id for this variation
customJson	string	Custom JSON for this variation

VariationRedirection

Name	Type	Description
type	enum	Type of the redirection. Can be [GLOBAL_REDIRECTION, PARAMETER_REDIRECTION]
url	string	URL used for the redirection, in case of global redirection
parameters	string	Parameters used for the redirection, in case of parameter redirection
includeQueryParameters	boolean	In case of global redirection, option to include query parameters from the original url

Update variation

curl -X PUT \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/variations/{variationId}"
{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "jsCode" : "string",
  "cssCode" : "string",
  "isJsCodeAfterDomReady" : "false",
  "widgetTemplateInput" : "string",
  "redirectionStrings" : "string",
  "redirection" : {
    "type" : "GLOBAL_REDIRECTION",
    "url" : "string",
    "parameters" : "string",
    "includeQueryParameters" : "false"
  },
  "experimentId" : "123456789",
  "customJson" : "string"
}

PUT /variations/{variationId}

Update the variation with given id

Request arguments

Name	Place	Type	Description
variationId	path	long	variationId

Request body

Variation

Name	Type	Description
id	long	The unique identifier of the given variation
siteId `*required`	long	The unique identifier of the site linked to given variation
name	string	Name of given variation
jsCode	string	New javascript code for variation
cssCode	string	New css style for variation
isJsCodeAfterDomReady	boolean	Set true if code applied after DOM ready. Default value: true
widgetTemplateInput	string	Widget template input data in JSON format.
redirectionStrings	string	Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead
redirection	VariationRedirection	Redirection parameters of a variation
experimentId	long	Experiment id for this variation
customJson	string	Custom JSON for this variation

VariationRedirection

Name	Type	Description
type	enum	Type of the redirection. Can be [GLOBAL_REDIRECTION, PARAMETER_REDIRECTION]
url	string	URL used for the redirection, in case of global redirection
parameters	string	Parameters used for the redirection, in case of parameter redirection
includeQueryParameters	boolean	In case of global redirection, option to include query parameters from the original url

{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "jsCode" : "string",
  "cssCode" : "string",
  "isJsCodeAfterDomReady" : "false",
  "widgetTemplateInput" : "string",
  "redirectionStrings" : "string",
  "redirection" : {
    "type" : "GLOBAL_REDIRECTION",
    "url" : "string",
    "parameters" : "string",
    "includeQueryParameters" : "false"
  },
  "experimentId" : "123456789",
  "customJson" : "string"
}

Response body

Variation

Name	Type	Description
id	long	The unique identifier of the given variation
siteId	long	The unique identifier of the site linked to given variation
name	string	Name of given variation
jsCode	string	New javascript code for variation
cssCode	string	New css style for variation
isJsCodeAfterDomReady	boolean	Set true if code applied after DOM ready. Default value: true
widgetTemplateInput	string	Widget template input data in JSON format.
redirectionStrings	string	Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead
redirection	VariationRedirection	Redirection parameters of a variation
experimentId	long	Experiment id for this variation
customJson	string	Custom JSON for this variation

VariationRedirection

Name	Type	Description
type	enum	Type of the redirection. Can be [GLOBAL_REDIRECTION, PARAMETER_REDIRECTION]
url	string	URL used for the redirection, in case of global redirection
parameters	string	Parameters used for the redirection, in case of parameter redirection
includeQueryParameters	boolean	In case of global redirection, option to include query parameters from the original url

Create new variation

curl -X POST \
  -H "Authorization: Bearer qwerty123456789" \
  -H "Content-Type: application/json" -d @- \
  "https://api.kameleoon.com/variations"
{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "jsCode" : "string",
  "cssCode" : "string",
  "isJsCodeAfterDomReady" : "false",
  "widgetTemplateInput" : "string",
  "redirectionStrings" : "string",
  "redirection" : {
    "type" : "GLOBAL_REDIRECTION",
    "url" : "string",
    "parameters" : "string",
    "includeQueryParameters" : "false"
  },
  "experimentId" : "123456789",
  "customJson" : "string"
}

POST /variations

Create new variation with given parameters

Request body

Variation

Name	Type	Description
id	long	The unique identifier of the given variation
siteId `*required`	long	The unique identifier of the site linked to given variation
name	string	Name of given variation
jsCode	string	New javascript code for variation
cssCode	string	New css style for variation
isJsCodeAfterDomReady	boolean	Set true if code applied after DOM ready. Default value: true
widgetTemplateInput	string	Widget template input data in JSON format.
redirectionStrings	string	Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead
redirection	VariationRedirection	Redirection parameters of a variation
experimentId	long	Experiment id for this variation
customJson	string	Custom JSON for this variation

VariationRedirection

Name	Type	Description
type	enum	Type of the redirection. Can be [GLOBAL_REDIRECTION, PARAMETER_REDIRECTION]
url	string	URL used for the redirection, in case of global redirection
parameters	string	Parameters used for the redirection, in case of parameter redirection
includeQueryParameters	boolean	In case of global redirection, option to include query parameters from the original url

{
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "jsCode" : "string",
  "cssCode" : "string",
  "isJsCodeAfterDomReady" : "false",
  "widgetTemplateInput" : "string",
  "redirectionStrings" : "string",
  "redirection" : {
    "type" : "GLOBAL_REDIRECTION",
    "url" : "string",
    "parameters" : "string",
    "includeQueryParameters" : "false"
  },
  "experimentId" : "123456789",
  "customJson" : "string"
}

Response body

Variation

Name	Type	Description
id	long	The unique identifier of the given variation
siteId	long	The unique identifier of the site linked to given variation
name	string	Name of given variation
jsCode	string	New javascript code for variation
cssCode	string	New css style for variation
isJsCodeAfterDomReady	boolean	Set true if code applied after DOM ready. Default value: true
widgetTemplateInput	string	Widget template input data in JSON format.
redirectionStrings	string	Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead
redirection	VariationRedirection	Redirection parameters of a variation
experimentId	long	Experiment id for this variation
customJson	string	Custom JSON for this variation

VariationRedirection

Name	Type	Description
type	enum	Type of the redirection. Can be [GLOBAL_REDIRECTION, PARAMETER_REDIRECTION]
url	string	URL used for the redirection, in case of global redirection
parameters	string	Parameters used for the redirection, in case of parameter redirection
includeQueryParameters	boolean	In case of global redirection, option to include query parameters from the original url

List variations

curl -H "Authorization: Bearer qwerty123456789" \
  "https://api.kameleoon.com/variations"

GET /variations

Get list of all variations of the customer

[ {
  "id" : "123456789",
  "siteId" : "123456789",
  "name" : "string",
  "jsCode" : "string",
  "cssCode" : "string",
  "isJsCodeAfterDomReady" : "false",
  "widgetTemplateInput" : "string",
  "redirectionStrings" : "string",
  "redirection" : {
    "type" : "GLOBAL_REDIRECTION",
    "url" : "string",
    "parameters" : "string",
    "includeQueryParameters" : "false"
  },
  "experimentId" : "123456789",
  "customJson" : "string"
} ]

Response body

Variation

Name	Type	Description
id	long	The unique identifier of the given variation
siteId	long	The unique identifier of the site linked to given variation
name	string	Name of given variation
jsCode	string	New javascript code for variation
cssCode	string	New css style for variation
isJsCodeAfterDomReady	boolean	Set true if code applied after DOM ready. Default value: true
widgetTemplateInput	string	Widget template input data in JSON format.
redirectionStrings	string	Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead
redirection	VariationRedirection	Redirection parameters of a variation
experimentId	long	Experiment id for this variation
customJson	string	Custom JSON for this variation

VariationRedirection

Name	Type	Description
type	enum	Type of the redirection. Can be [GLOBAL_REDIRECTION, PARAMETER_REDIRECTION]
url	string	URL used for the redirection, in case of global redirection
parameters	string	Parameters used for the redirection, in case of parameter redirection
includeQueryParameters	boolean	In case of global redirection, option to include query parameters from the original url