Documentation
NAV Navbar
  • Automation API Reference
  • 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:

    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

    Authorization request

    
    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"
    
    

    Authorization response

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

    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. The authorization server then replies with a JSON object, containing an access_token.

    Using the access_token to access the API

    REST API example request

    
    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

    This flow / use case will be available soon (September 2020).

    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

    IntervalHTTP MethodNumber of requests
    5 minuteGET1000
    1 dayGET100000
    1 dayPOST100000

    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

    CodeStatusDescription
    200OKYour request was correctly formatted and the resource you requested is returned
    201CreatedReturned when a POST request was successful
    400BadRequestCan 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
    401UnauthorizedYour API token was missing or not in the correct format
    403ForbiddenYou 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
    5xxServer ErrorSomething 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.

    Get the current user

    Example request

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

    GET /accounts/me

    Returns the user associated with the passed access_token.

    This method returns a user.

    Example response

    {
      "id" : "123456789",
      "username" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "email" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "preferredLocale" : "ENGLISH",
      "isPasswordExpired" : "false"
    }
    
    Response body

    Account
    NameTypeDescription
    idlongThe unique identifier of the given account
    usernamestringThe user name of the given account
    firstNamestringThe first name of the user of the given account
    lastNamestringThe last name of the user of the given account
    emailstringThe email of the given account
    dateCreateddatetimeDate when the account was created
    preferredLocaleenumThe used locale of the given account. Can be [ENGLISH, FRENCH, GERMAN]
    isPasswordExpiredbooleanPassword regeneration required

    Get one account

    Example request

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

    GET /accounts/{accountId}

    Get one account with given id

    Request arguments
    NamePlaceTypeDescription
    accountIdpathlongaccountId

    Example response

    {
      "id" : "123456789",
      "username" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "email" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "preferredLocale" : "ENGLISH",
      "isPasswordExpired" : "false"
    }
    
    Response body

    Account
    NameTypeDescription
    idlongThe unique identifier of the given account
    usernamestringThe user name of the given account
    firstNamestringThe first name of the user of the given account
    lastNamestringThe last name of the user of the given account
    emailstringThe email of the given account
    dateCreateddatetimeDate when the account was created
    preferredLocaleenumThe used locale of the given account. Can be [ENGLISH, FRENCH, GERMAN]
    isPasswordExpiredbooleanPassword regeneration required

    Custom Data

    List custom data

    Example request

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

    GET /custom-datas

    Get the list of all custom data

    Example response

    [ {
      "id" : "123456789",
      "isConstant" : "false",
      "customEvalCode" : "string",
      "isFilterable" : "false",
      "gtmVariableName" : "string",
      "isLearnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "siteId" : "123456789",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855"
    } ]
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a isConstant
    customEvalCodestringCustom code that will be executed
    isFilterablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    isLearnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    namestringThe name for the given custom data
    methodstringA method through which a custom data will be transmitted
    siteIdlongUnique site identifier assigned with the record
    tcVariableNamestringVariable name for the tag commander data layer, if it is selected as a transmission method
    tealiumVariableNamestringVariable name for the Tealium, if it is selected as a transmission method
    typestringFormat of data to be retrieved
    tagsstringThis fields stores tags that are associated with this record
    creationDatedatetimeDate and time a record is created
    modificationDatedatetimeDate and time a record is modified

    Create a new custom data

    Example request

    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",
      "isFilterable" : "false",
      "gtmVariableName" : "string",
      "isLearnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "siteId" : "123456789",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855"
    }
    

    POST /custom-datas

    Create new custom data with given parameters

    Request body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a isConstant
    customEvalCodestringCustom code that will be executed
    isFilterablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    isLearnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    namestringThe name for the given custom data
    methodstringA method through which a custom data will be transmitted
    siteIdlongUnique site identifier assigned with the record
    tcVariableNamestringVariable name for the tag commander data layer, if it is selected as a transmission method
    tealiumVariableNamestringVariable name for the Tealium, if it is selected as a transmission method
    typestringFormat of data to be retrieved
    tagsstringThis fields stores tags that are associated with this record
    creationDatedatetimeDate and time a record is created
    modificationDatedatetimeDate and time a record is modified

    Example response

    {
      "id" : "123456789",
      "isConstant" : "false",
      "customEvalCode" : "string",
      "isFilterable" : "false",
      "gtmVariableName" : "string",
      "isLearnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "siteId" : "123456789",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a isConstant
    customEvalCodestringCustom code that will be executed
    isFilterablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    isLearnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    namestringThe name for the given custom data
    methodstringA method through which a custom data will be transmitted
    siteIdlongUnique site identifier assigned with the record
    tcVariableNamestringVariable name for the tag commander data layer, if it is selected as a transmission method
    tealiumVariableNamestringVariable name for the Tealium, if it is selected as a transmission method
    typestringFormat of data to be retrieved
    tagsstringThis fields stores tags that are associated with this record
    creationDatedatetimeDate and time a record is created
    modificationDatedatetimeDate and time a record is modified

    Get one custom data

    Example request

    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
    NamePlaceTypeDescription
    customDataIdpathlongThe ID of the custom data object

    Example response

    {
      "id" : "123456789",
      "isConstant" : "false",
      "customEvalCode" : "string",
      "isFilterable" : "false",
      "gtmVariableName" : "string",
      "isLearnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "siteId" : "123456789",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a isConstant
    customEvalCodestringCustom code that will be executed
    isFilterablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    isLearnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    namestringThe name for the given custom data
    methodstringA method through which a custom data will be transmitted
    siteIdlongUnique site identifier assigned with the record
    tcVariableNamestringVariable name for the tag commander data layer, if it is selected as a transmission method
    tealiumVariableNamestringVariable name for the Tealium, if it is selected as a transmission method
    typestringFormat of data to be retrieved
    tagsstringThis fields stores tags that are associated with this record
    creationDatedatetimeDate and time a record is created
    modificationDatedatetimeDate and time a record is modified

    Update custom data

    Example request

    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",
      "isFilterable" : "false",
      "gtmVariableName" : "string",
      "isLearnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "siteId" : "123456789",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855"
    }
    

    PUT /custom-datas/{customDataId}

    Update custom data with given id

    Request arguments
    NamePlaceTypeDescription
    customDataIdpathlongThe ID of the custom data object
    Request body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a isConstant
    customEvalCodestringCustom code that will be executed
    isFilterablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    isLearnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    namestringThe name for the given custom data
    methodstringA method through which a custom data will be transmitted
    siteIdlongUnique site identifier assigned with the record
    tcVariableNamestringVariable name for the tag commander data layer, if it is selected as a transmission method
    tealiumVariableNamestringVariable name for the Tealium, if it is selected as a transmission method
    typestringFormat of data to be retrieved
    tagsstringThis fields stores tags that are associated with this record
    creationDatedatetimeDate and time a record is created
    modificationDatedatetimeDate and time a record is modified

    Example response

    {
      "id" : "123456789",
      "isConstant" : "false",
      "customEvalCode" : "string",
      "isFilterable" : "false",
      "gtmVariableName" : "string",
      "isLearnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "siteId" : "123456789",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a isConstant
    customEvalCodestringCustom code that will be executed
    isFilterablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    isLearnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    namestringThe name for the given custom data
    methodstringA method through which a custom data will be transmitted
    siteIdlongUnique site identifier assigned with the record
    tcVariableNamestringVariable name for the tag commander data layer, if it is selected as a transmission method
    tealiumVariableNamestringVariable name for the Tealium, if it is selected as a transmission method
    typestringFormat of data to be retrieved
    tagsstringThis fields stores tags that are associated with this record
    creationDatedatetimeDate and time a record is created
    modificationDatedatetimeDate and time a record is modified

    Remove custom data

    Example request

    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
    NamePlaceTypeDescription
    customDataIdpathlongThe ID of the custom data object

    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 personal customer data

    Example request

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

    GET /customers/me

    Get personal customer data

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "status" : "ACTIVE",
      "level" : "FREE",
      "country" : "FRANCE",
      "timeZone" : "string",
      "products" : [ "ABTESTING" ],
      "passwordExpirationPolicy" : "2020-07-14T17:06:58.440855",
      "paranoid" : "false",
      "dateCreated" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    Customer
    NameTypeDescription
    idlongThe unique identifier of the given customer
    namestringThe name of the given customer
    statusenumThe current status of the given customer. Can be [ACTIVE, SUBSCRIBED_AUDIENCE_EXCEEDED, QUOTA_RESET, UNSUBSCRIBED_ENTREPRISE_PLAN]
    levelenumThe plan of the given customer. Can be [FREE, PREMIUM, FREEMIUM, BRONZE, SILVER, GOLD, PLATINUM, ENTERPRISE, CUSTOM]
    countryenumThe country of the given customer. Can be [FRANCE, RUSSIA, GERMANY, UNITED_KINGDOM, UNITED_STATES, OTHER]
    timeZonestringThe default time zone of the given customer
    productsarrayThe available modules of the given customer. Can be [ABTESTING, PERSONALIZATION, PREDICTIVE, AUDIENCE_DISCOVERY, INTERESTS, PRODUCT, WIDGET_TEMPLATE]
    passwordExpirationPolicydatetimeThe number of days before password expires
    paranoidbooleanThe additional password policy
    dateCreateddatetimeDate when the customer was created

    Get one customer

    Example request

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

    GET /customers/{customerId}

    Get one customer with given id

    Request arguments
    NamePlaceTypeDescription
    customerIdpathlongThe unique identifier of the given customer

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "status" : "ACTIVE",
      "level" : "FREE",
      "country" : "FRANCE",
      "timeZone" : "string",
      "products" : [ "ABTESTING" ],
      "passwordExpirationPolicy" : "2020-07-14T17:06:58.440855",
      "paranoid" : "false",
      "dateCreated" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    Customer
    NameTypeDescription
    idlongThe unique identifier of the given customer
    namestringThe name of the given customer
    statusenumThe current status of the given customer. Can be [ACTIVE, SUBSCRIBED_AUDIENCE_EXCEEDED, QUOTA_RESET, UNSUBSCRIBED_ENTREPRISE_PLAN]
    levelenumThe plan of the given customer. Can be [FREE, PREMIUM, FREEMIUM, BRONZE, SILVER, GOLD, PLATINUM, ENTERPRISE, CUSTOM]
    countryenumThe country of the given customer. Can be [FRANCE, RUSSIA, GERMANY, UNITED_KINGDOM, UNITED_STATES, OTHER]
    timeZonestringThe default time zone of the given customer
    productsarrayThe available modules of the given customer. Can be [ABTESTING, PERSONALIZATION, PREDICTIVE, AUDIENCE_DISCOVERY, INTERESTS, PRODUCT, WIDGET_TEMPLATE]
    passwordExpirationPolicydatetimeThe number of days before password expires
    paranoidbooleanThe additional password policy
    dateCreateddatetimeDate 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.

    List experiments

    Example request

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

    GET /experiments

    Get the list of all experiments

    Example response

    [ {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "adobeOmnitureObject" : "string",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "customVariable" : "1234",
        "eulerianUserCentricParameter" : "string",
        "googleAnalyticsTracker" : "string",
        "heatMapPageWidth" : "1234",
        "reportingScript" : "string",
        "type" : "GOOGLE_ANALYTICS",
        "universalAnalyticsDimension" : "1234"
      } ],
      "status" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoal" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "targetingConfiguration" : "SITE",
      "dateModified" : "2020-07-14T17:06:58.440855"
    } ]
    
    Response body

    Experiment
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify an experiment
    namestringThe name of the experiment
    siteIdlongThe website id that an experiment belongs to
    baseURLstring
    typeenumCan be [CLASSIC, SERVER_SIDE, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    statusstringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoallong
    autoOptimizedboolean
    deviationsmapTraffic 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%).
    targetingConfigurationenumCan be [SITE, PAGE, URL, SAVED_TEMPLATE]
    dateModifieddatetime

    TrackingTool
    NameTypeDescription
    adobeOmnitureObjectstring
    comScoreCustomerIdstring
    comScoreDomainstring
    customVariableinteger
    eulerianUserCentricParameterstring
    googleAnalyticsTrackerstring
    heatMapPageWidthinteger
    reportingScriptstring
    typeenumCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    universalAnalyticsDimensioninteger

    Create a new experiment

    Example request

    curl -X POST \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/experiments"
    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "adobeOmnitureObject" : "string",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "customVariable" : "1234",
        "eulerianUserCentricParameter" : "string",
        "googleAnalyticsTracker" : "string",
        "heatMapPageWidth" : "1234",
        "reportingScript" : "string",
        "type" : "GOOGLE_ANALYTICS",
        "universalAnalyticsDimension" : "1234"
      } ],
      "status" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoal" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "targetingConfiguration" : "SITE",
      "dateModified" : "2020-07-14T17:06:58.440855"
    }
    

    POST /experiments

    Create a new experiment with the given parameters

    Request body

    Experiment
    NameTypeDescription
    id
    *read only
    longThis field is generated by the system to uniquely identify an experiment
    name
    *required
    stringThe name of the experiment
    siteId
    *required
    longThe website id that an experiment belongs to
    baseURLstring
    typeenumCan be [CLASSIC, SERVER_SIDE, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    status
    *read only
    stringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoallong
    autoOptimizedboolean
    deviationsmapTraffic 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%).
    targetingConfigurationenumCan be [SITE, PAGE, URL, SAVED_TEMPLATE]
    dateModified
    *read only
    datetime

    TrackingTool
    NameTypeDescription
    adobeOmnitureObjectstring
    comScoreCustomerIdstring
    comScoreDomainstring
    customVariableinteger
    eulerianUserCentricParameterstring
    googleAnalyticsTrackerstring
    heatMapPageWidthinteger
    reportingScriptstring
    typeenumCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    universalAnalyticsDimensioninteger

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "adobeOmnitureObject" : "string",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "customVariable" : "1234",
        "eulerianUserCentricParameter" : "string",
        "googleAnalyticsTracker" : "string",
        "heatMapPageWidth" : "1234",
        "reportingScript" : "string",
        "type" : "GOOGLE_ANALYTICS",
        "universalAnalyticsDimension" : "1234"
      } ],
      "status" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoal" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "targetingConfiguration" : "SITE",
      "dateModified" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    Experiment
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify an experiment
    namestringThe name of the experiment
    siteIdlongThe website id that an experiment belongs to
    baseURLstring
    typeenumCan be [CLASSIC, SERVER_SIDE, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    statusstringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoallong
    autoOptimizedboolean
    deviationsmapTraffic 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%).
    targetingConfigurationenumCan be [SITE, PAGE, URL, SAVED_TEMPLATE]
    dateModifieddatetime

    TrackingTool
    NameTypeDescription
    adobeOmnitureObjectstring
    comScoreCustomerIdstring
    comScoreDomainstring
    customVariableinteger
    eulerianUserCentricParameterstring
    googleAnalyticsTrackerstring
    heatMapPageWidthinteger
    reportingScriptstring
    typeenumCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    universalAnalyticsDimensioninteger

    Get one experiment

    Example request

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

    GET /experiments/{experimentId}

    Get one experiment with given id

    Request arguments
    NamePlaceTypeDescription
    experimentIdpathlongexperimentId

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "adobeOmnitureObject" : "string",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "customVariable" : "1234",
        "eulerianUserCentricParameter" : "string",
        "googleAnalyticsTracker" : "string",
        "heatMapPageWidth" : "1234",
        "reportingScript" : "string",
        "type" : "GOOGLE_ANALYTICS",
        "universalAnalyticsDimension" : "1234"
      } ],
      "status" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoal" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "targetingConfiguration" : "SITE",
      "dateModified" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    Experiment
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify an experiment
    namestringThe name of the experiment
    siteIdlongThe website id that an experiment belongs to
    baseURLstring
    typeenumCan be [CLASSIC, SERVER_SIDE, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    statusstringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoallong
    autoOptimizedboolean
    deviationsmapTraffic 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%).
    targetingConfigurationenumCan be [SITE, PAGE, URL, SAVED_TEMPLATE]
    dateModifieddatetime

    TrackingTool
    NameTypeDescription
    adobeOmnitureObjectstring
    comScoreCustomerIdstring
    comScoreDomainstring
    customVariableinteger
    eulerianUserCentricParameterstring
    googleAnalyticsTrackerstring
    heatMapPageWidthinteger
    reportingScriptstring
    typeenumCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    universalAnalyticsDimensioninteger

    Remove an experiment

    Example request

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

    DELETE /experiments/{experimentId}

    Remove an experiment with given id

    Request arguments
    NamePlaceTypeDescription
    experimentIdpathlongexperimentId

    Request experiment's results

    Example request

    curl -X POST \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/experiments/{experimentId}/results"
    {
      "allVariationsData" : "false",
      "breakdown" : {
        "type" : "BROWSER"
      },
      "callbackUrl" : "string",
      "dateIntervals" : [ {
        "end" : "2020-07-14T17:06:58.440855",
        "start" : "2020-07-14T17:06:58.440855"
      } ],
      "filters" : [ { } ],
      "interval" : "HOUR",
      "stringForHash" : "string",
      "visitorData" : "false"
    }
    

    POST /experiments/{experimentId}/results

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

    Request arguments
    NamePlaceTypeDescription
    experimentIdpathlongexperimentId
    Request body

    DataRequestParams
    NameTypeDescription
    allVariationsDataboolean
    breakdownBreakdown
    callbackUrlstring
    dateIntervalsarray[DateInterval]
    filtersarray[Filter]
    intervalenumCan be [HOUR, DAY, WEEK, MONTH, YEAR]
    stringForHashstring
    visitorDataboolean

    Breakdown
    NameTypeDescription
    typeenumCan be [BROWSER, CUSTOM_DATA, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OPERATING_SYSTEM, PAGE_TITLE, PAGES_VIEWED, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, WORKWEEK_OR_WEEKEND, VISIT_DURATION, BROWSER_LANGUAGE, SKY_CONDITION, DAY_OR_NIGHT, WEATHER_TEMPERATURES, NUMBER_OF_VISITS, REFERRING_WEBSITE_URL, TABS_NUMBER]

    CustomDataBreakdown
    NameTypeDescription
    indexinteger
    typeenumCan be [BROWSER, CUSTOM_DATA, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OPERATING_SYSTEM, PAGE_TITLE, PAGES_VIEWED, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, WORKWEEK_OR_WEEKEND, VISIT_DURATION, BROWSER_LANGUAGE, SKY_CONDITION, DAY_OR_NIGHT, WEATHER_TEMPERATURES, NUMBER_OF_VISITS, REFERRING_WEBSITE_URL, TABS_NUMBER]

    DateInterval
    NameTypeDescription
    enddatetime
    startdatetime

    DeviceTypeFilter
    NameTypeDescription
    includeboolean
    valuesarrayCan be [DESKTOP, TABLET, PHONE]

    NewVisitorFilter
    NameTypeDescription
    visitorsTypeenumCan be [NEW_VISITORS, RETURNING_VISITORS]

    BrowserFilter
    NameTypeDescription
    includeboolean
    valuesarrayCan be [CHROME, EXPLORER, FIREFOX, SAFARI, OPERA]

    CustomDataFilter
    NameTypeDescription
    customDataIdlong
    includeboolean
    valuestring

    OperatingSystemFilter
    NameTypeDescription
    includeboolean
    valuesarrayCan be [WINDOWS, MAC_OS, LINUX, I_OS]

    Example response

    {
      "dataCode" : "string"
    }
    
    Response body

    The response from the server will be a data code which will be needed to get the actual results whenever they will be ready.

    Response
    NameTypeDescription
    dataCodestring

    Get the experiment's results

    Example request

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

    GET /experiments/{experimentId}/results

    This method is used to poll the results when they are ready.

    Request arguments
    NamePlaceTypeDescription
    dataCodequerystringdataCode

    Example response

    {
      "data" : {
        "dataCode" : "string",
        "variationData" : ""
      },
      "status" : "ERROR"
    }
    
    Response body

    Data Response
    NameTypeDescription
    dataDataResult
    statusenumCan be [ERROR, READY, WAITING]

    DataResult
    NameTypeDescription
    dataCodestring
    variationDatamap

    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.

    List feature flags

    Example request

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

    GET /feature-flags

    Get the list of all feature flags

    Example response

    [ {
      "id" : "123456789",
      "name" : "string",
      "identificationKey" : "string",
      "description" : "string",
      "tags" : [ "[]" ],
      "siteId" : "123456789",
      "expositionRate" : "132.987",
      "targetingSegmentId" : "123456789",
      "goals" : [ "[]" ],
      "sdkLanguageType" : "ANDROID",
      "status" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "dateModified" : "2020-07-14T17:06:58.440855"
    } ]
    
    Response body

    FeatureFlag
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify a feature flag
    namestringThe name of the feature flag
    identificationKeystring
    descriptionstring
    tagsarray
    siteIdlongThe website id that a feature flag belongs to
    expositionRatedouble
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenumCan be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    statusstringThe status of the given feature flag
    dateCreateddatetime
    dateModifieddatetime

    Create new feature flag

    Example request

    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" : "2020-07-14T17:06:58.440855",
      "dateModified" : "2020-07-14T17:06:58.440855"
    }
    

    POST /feature-flags

    Create new feature flag with given parameters

    Request body

    FeatureFlag
    NameTypeDescription
    id
    *read only
    longThis field is generated by the system to uniquely identify a feature flag
    name
    *required
    stringThe name of the feature flag
    identificationKeystring
    descriptionstring
    tagsarray
    siteId
    *required
    longThe website id that a feature flag belongs to
    expositionRatedouble
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenumCan be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    status
    *read only
    stringThe status of the given feature flag
    dateCreated
    *read only
    datetime
    dateModified
    *read only
    datetime

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "identificationKey" : "string",
      "description" : "string",
      "tags" : [ "[]" ],
      "siteId" : "123456789",
      "expositionRate" : "132.987",
      "targetingSegmentId" : "123456789",
      "goals" : [ "[]" ],
      "sdkLanguageType" : "ANDROID",
      "status" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "dateModified" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    FeatureFlag
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify a feature flag
    namestringThe name of the feature flag
    identificationKeystring
    descriptionstring
    tagsarray
    siteIdlongThe website id that a feature flag belongs to
    expositionRatedouble
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenumCan be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    statusstringThe status of the given feature flag
    dateCreateddatetime
    dateModifieddatetime

    Get one feature flag

    Example request

    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
    NamePlaceTypeDescription
    featureFlagIdpathlongfeatureFlagId

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "identificationKey" : "string",
      "description" : "string",
      "tags" : [ "[]" ],
      "siteId" : "123456789",
      "expositionRate" : "132.987",
      "targetingSegmentId" : "123456789",
      "goals" : [ "[]" ],
      "sdkLanguageType" : "ANDROID",
      "status" : "string",
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "dateModified" : "2020-07-14T17:06:58.440855"
    }
    
    Response body

    FeatureFlag
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify a feature flag
    namestringThe name of the feature flag
    identificationKeystring
    descriptionstring
    tagsarray
    siteIdlongThe website id that a feature flag belongs to
    expositionRatedouble
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenumCan be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    statusstringThe status of the given feature flag
    dateCreateddatetime
    dateModifieddatetime

    Remove feature flag

    Example request

    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
    NamePlaceTypeDescription
    featureFlagIdpathlongfeatureFlagId

    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.

    List goals

    Example request

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

    GET /goals

    Get list of goals

    Example response

    [ {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "isMainGoal" : "false",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ]
    } ]
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    isMainGoalboolean
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenumCan be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
    paramsGoalParamsType 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.
    dateCreateddatetime
    trackingToolsarrayCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]

    ClickTrackingGoalParams
    NameTypeDescription
    customCssSelectorsarraySelection with a CSS selector. CSS selector to track the corresponding element
    urlstringURL of the page on which you want to create your click tracker. Example: www.mozilla.org

    AccessToPageGoalParams
    NameTypeDescription
    matchStringstring
    matchTypeenumCan be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    timeSecondsinteger

    ScrollTrackingGoalParams
    NameTypeDescription
    typeenumWhen the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
    valuedoubleScroll tracking value.

    PageViewsGoalParams
    NameTypeDescription
    numberMatchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Create new goal

    Example request

    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",
      "isMainGoal" : "false",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ]
    }
    

    POST /goals

    Create new goal with given parameters

    Request body

    Goal
    NameTypeDescription
    id
    *read only
    longUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    isMainGoalboolean
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenumCan be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
    paramsGoalParamsType 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.
    dateCreateddatetime
    trackingToolsarrayCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]

    ClickTrackingGoalParams
    NameTypeDescription
    customCssSelectorsarraySelection with a CSS selector. CSS selector to track the corresponding element
    urlstringURL of the page on which you want to create your click tracker. Example: www.mozilla.org

    AccessToPageGoalParams
    NameTypeDescription
    matchStringstring
    matchTypeenumCan be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    timeSecondsinteger

    ScrollTrackingGoalParams
    NameTypeDescription
    typeenumWhen the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
    valuedoubleScroll tracking value.

    PageViewsGoalParams
    NameTypeDescription
    numberMatchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "isMainGoal" : "false",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ]
    }
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    isMainGoalboolean
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenumCan be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
    paramsGoalParamsType 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.
    dateCreateddatetime
    trackingToolsarrayCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]

    ClickTrackingGoalParams
    NameTypeDescription
    customCssSelectorsarraySelection with a CSS selector. CSS selector to track the corresponding element
    urlstringURL of the page on which you want to create your click tracker. Example: www.mozilla.org

    AccessToPageGoalParams
    NameTypeDescription
    matchStringstring
    matchTypeenumCan be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    timeSecondsinteger

    ScrollTrackingGoalParams
    NameTypeDescription
    typeenumWhen the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
    valuedoubleScroll tracking value.

    PageViewsGoalParams
    NameTypeDescription
    numberMatchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Get one goal

    Example request

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

    GET /goals/{goalId}

    Get one goal with given id

    Request arguments
    NamePlaceTypeDescription
    goalIdpathlonggoalId

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "isMainGoal" : "false",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ]
    }
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    isMainGoalboolean
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenumCan be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
    paramsGoalParamsType 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.
    dateCreateddatetime
    trackingToolsarrayCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]

    ClickTrackingGoalParams
    NameTypeDescription
    customCssSelectorsarraySelection with a CSS selector. CSS selector to track the corresponding element
    urlstringURL of the page on which you want to create your click tracker. Example: www.mozilla.org

    AccessToPageGoalParams
    NameTypeDescription
    matchStringstring
    matchTypeenumCan be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    timeSecondsinteger

    ScrollTrackingGoalParams
    NameTypeDescription
    typeenumWhen the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
    valuedoubleScroll tracking value.

    PageViewsGoalParams
    NameTypeDescription
    numberMatchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Update goal

    Example request

    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",
      "isMainGoal" : "false",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ]
    }
    

    PUT /goals/{goalId}

    Update goal with given id

    Request arguments
    NamePlaceTypeDescription
    goalIdpathlonggoalId
    Request body

    Goal
    NameTypeDescription
    id
    *read only
    longUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    isMainGoalboolean
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenumCan be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
    paramsGoalParamsType 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.
    dateCreateddatetime
    trackingToolsarrayCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]

    ClickTrackingGoalParams
    NameTypeDescription
    customCssSelectorsarraySelection with a CSS selector. CSS selector to track the corresponding element
    urlstringURL of the page on which you want to create your click tracker. Example: www.mozilla.org

    AccessToPageGoalParams
    NameTypeDescription
    matchStringstring
    matchTypeenumCan be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    timeSecondsinteger

    ScrollTrackingGoalParams
    NameTypeDescription
    typeenumWhen the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
    valuedoubleScroll tracking value.

    PageViewsGoalParams
    NameTypeDescription
    numberMatchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "isMainGoal" : "false",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2020-07-14T17:06:58.440855",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ]
    }
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    isMainGoalboolean
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenumCan be [CLICK, SCROLL, URL, CUSTOM, TIME_SPENT, PAGE_VIEWS, RETENTION_RATE]
    paramsGoalParamsType 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.
    dateCreateddatetime
    trackingToolsarrayCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]

    ClickTrackingGoalParams
    NameTypeDescription
    customCssSelectorsarraySelection with a CSS selector. CSS selector to track the corresponding element
    urlstringURL of the page on which you want to create your click tracker. Example: www.mozilla.org

    AccessToPageGoalParams
    NameTypeDescription
    matchStringstring
    matchTypeenumCan be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    timeSecondsinteger

    ScrollTrackingGoalParams
    NameTypeDescription
    typeenumWhen the user scrolls down to. Can be [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]
    valuedoubleScroll tracking value.

    PageViewsGoalParams
    NameTypeDescription
    numberMatchTypeenumCan be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Remove goal

    Example request

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

    DELETE /goals/{goalId}

    Remove goal with given id

    Request arguments
    NamePlaceTypeDescription
    goalIdpathlonggoalId

    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.

    List interests

    Example request

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

    GET /interests

    Get list of all interests

    Example response

    [ {
      "id" : "123456789",
      "interestIndex" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    } ]
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    interestIndexintegerThe index for the given interest
    lastTimeCrawledlongDate and time the interest was crawled by a bot
    namestringThe name of the interest
    creationDatedatetimeDate and time an interest is created
    modificationDatedatetimeDate and time an interest is modified
    specificationsarray[InterestSpecification]
    siteIdlongUnique site identifier assigned with current interest

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Create a new interest

    Example request

    curl -X POST \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/interests"
    {
      "id" : "123456789",
      "interestIndex" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    

    POST /interests

    Create new interest with given parameters

    Request body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    interestIndexintegerThe index for the given interest
    lastTimeCrawledlongDate and time the interest was crawled by a bot
    namestringThe name of the interest
    creationDatedatetimeDate and time an interest is created
    modificationDatedatetimeDate and time an interest is modified
    specificationsarray[InterestSpecification]
    siteIdlongUnique site identifier assigned with current interest

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Example response

    {
      "id" : "123456789",
      "interestIndex" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    interestIndexintegerThe index for the given interest
    lastTimeCrawledlongDate and time the interest was crawled by a bot
    namestringThe name of the interest
    creationDatedatetimeDate and time an interest is created
    modificationDatedatetimeDate and time an interest is modified
    specificationsarray[InterestSpecification]
    siteIdlongUnique site identifier assigned with current interest

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Get one interest

    Example request

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

    GET /interests/{interestId}

    Get one interest with the given id

    Request arguments
    NamePlaceTypeDescription
    interestIdpathlonginterestId

    Example response

    {
      "id" : "123456789",
      "interestIndex" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    interestIndexintegerThe index for the given interest
    lastTimeCrawledlongDate and time the interest was crawled by a bot
    namestringThe name of the interest
    creationDatedatetimeDate and time an interest is created
    modificationDatedatetimeDate and time an interest is modified
    specificationsarray[InterestSpecification]
    siteIdlongUnique site identifier assigned with current interest

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Update an interest

    Example request

    curl -X PUT \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/interests/{interestId}"
    {
      "id" : "123456789",
      "interestIndex" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    

    PUT /interests/{interestId}

    Update interest with given id

    Request arguments
    NamePlaceTypeDescription
    interestIdpathlonginterestId
    Request body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    interestIndexintegerThe index for the given interest
    lastTimeCrawledlongDate and time the interest was crawled by a bot
    namestringThe name of the interest
    creationDatedatetimeDate and time an interest is created
    modificationDatedatetimeDate and time an interest is modified
    specificationsarray[InterestSpecification]
    siteIdlongUnique site identifier assigned with current interest

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Example response

    {
      "id" : "123456789",
      "interestIndex" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    interestIndexintegerThe index for the given interest
    lastTimeCrawledlongDate and time the interest was crawled by a bot
    namestringThe name of the interest
    creationDatedatetimeDate and time an interest is created
    modificationDatedatetimeDate and time an interest is modified
    specificationsarray[InterestSpecification]
    siteIdlongUnique site identifier assigned with current interest

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Remove an interest

    Example request

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

    DELETE /interests/{interestId}

    Remove interest with given id

    Request arguments
    NamePlaceTypeDescription
    interestIdpathlonginterestId

    Key pages

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

    List of key pages

    Example request

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

    GET /key-pages

    Get list of all the key pages

    Example response

    [ {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    } ]
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given key page
    indexintegerThe index of the key page
    namestringThe name of the key page
    relativeUrlRegExpstringRegular expression for the relative URL
    matchTypestringType of matching for the given key page
    totalCountintegerNumber of impressions for the key page
    secondMatchTypestringSecond type of matching for the given key page if needed
    creationDatedatetimeDate and time a key page is created
    modificationDatedatetimeDate and time a key page is modified
    siteIdlongUnique site identifier assigned with the key page

    Create a new key page

    Example request

    curl -X POST \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/key-pages"
    {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    

    POST /key-pages

    Create a new key page with the given parameters

    Request body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given key page
    indexintegerThe index of the key page
    namestringThe name of the key page
    relativeUrlRegExpstringRegular expression for the relative URL
    matchTypestringType of matching for the given key page
    totalCountintegerNumber of impressions for the key page
    secondMatchTypestringSecond type of matching for the given key page if needed
    creationDatedatetimeDate and time a key page is created
    modificationDatedatetimeDate and time a key page is modified
    siteIdlongUnique site identifier assigned with the key page

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given key page
    indexintegerThe index of the key page
    namestringThe name of the key page
    relativeUrlRegExpstringRegular expression for the relative URL
    matchTypestringType of matching for the given key page
    totalCountintegerNumber of impressions for the key page
    secondMatchTypestringSecond type of matching for the given key page if needed
    creationDatedatetimeDate and time a key page is created
    modificationDatedatetimeDate and time a key page is modified
    siteIdlongUnique site identifier assigned with the key page

    Get one key page

    Example request

    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
    NamePlaceTypeDescription
    keyPageIdpathlongkeyPageId

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given key page
    indexintegerThe index of the key page
    namestringThe name of the key page
    relativeUrlRegExpstringRegular expression for the relative URL
    matchTypestringType of matching for the given key page
    totalCountintegerNumber of impressions for the key page
    secondMatchTypestringSecond type of matching for the given key page if needed
    creationDatedatetimeDate and time a key page is created
    modificationDatedatetimeDate and time a key page is modified
    siteIdlongUnique site identifier assigned with the key page

    Update key page

    Example request

    curl -X PUT \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/key-pages/{keyPageId}"
    {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    

    PUT /key-pages/{keyPageId}

    Update a key page with the given id

    Request arguments
    NamePlaceTypeDescription
    keyPageIdpathlongkeyPageId
    Request body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given key page
    indexintegerThe index of the key page
    namestringThe name of the key page
    relativeUrlRegExpstringRegular expression for the relative URL
    matchTypestringType of matching for the given key page
    totalCountintegerNumber of impressions for the key page
    secondMatchTypestringSecond type of matching for the given key page if needed
    creationDatedatetimeDate and time a key page is created
    modificationDatedatetimeDate and time a key page is modified
    siteIdlongUnique site identifier assigned with the key page

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given key page
    indexintegerThe index of the key page
    namestringThe name of the key page
    relativeUrlRegExpstringRegular expression for the relative URL
    matchTypestringType of matching for the given key page
    totalCountintegerNumber of impressions for the key page
    secondMatchTypestringSecond type of matching for the given key page if needed
    creationDatedatetimeDate and time a key page is created
    modificationDatedatetimeDate and time a key page is modified
    siteIdlongUnique site identifier assigned with the key page

    Remove key page

    Example request

    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
    NamePlaceTypeDescription
    keyPageIdpathlongkeyPageId

    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.

    List personalizations

    Example request

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

    GET /personalizations

    Get list of all personalizations

    Example response

    [ {
      "iadvize" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "iAdvizeIdentifier" : "string",
        "iadvizeIdentifier" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "platformType" : "STANDARD",
        "position" : "TOP",
        "width" : "string"
      },
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "variationId" : "123456789",
      "status" : "string",
      "dateStatusModified" : "2020-07-14T17:06:58.440855",
      "targetingSegmentId" : "123456789",
      "goalId" : "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" : {
        "animationDirection" : "TOP",
        "animationTrigger" : "ON_OPEN",
        "animationType" : "NONE",
        "backgroundColor" : "string",
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
        "fontSize" : "string",
        "height" : "string",
        "heightImageDesktop" : "string",
        "heightImageMobile" : "string",
        "heightImageTablet" : "string",
        "htmlContent" : "string",
        "idTarget2Sell" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageDesktop" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageMobile" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageTablet" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "name" : "string",
        "position" : "TOP",
        "redirectURL" : "string",
        "targetBlank" : "false",
        "template" : "false",
        "textColor" : "string",
        "textContent" : "string",
        "type" : "SINGLE_IMAGE",
        "width" : "string",
        "widthImageDesktop" : "string",
        "widthImageMobile" : "string",
        "widthImageTablet" : "string",
        "withOverlay" : "false"
      },
      "stickyBlock" : {
        "animationDirection" : "TOP",
        "animationTrigger" : "ON_OPEN",
        "animationType" : "NONE",
        "backgroundColor" : "string",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
        "fontSize" : "string",
        "height" : "string",
        "heightImageDesktop" : "string",
        "heightImageMobile" : "string",
        "heightImageTablet" : "string",
        "htmlContent" : "string",
        "idTarget2Sell" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageDesktop" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageMobile" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageTablet" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "name" : "string",
        "position" : "TOP",
        "redirectURL" : "string",
        "shiftContent" : "false",
        "shouldScrollTo" : "false",
        "targetBlank" : "false",
        "template" : "false",
        "textColor" : "string",
        "textContent" : "string",
        "type" : "SINGLE_IMAGE",
        "width" : "string",
        "widthImageDesktop" : "string",
        "widthImageMobile" : "string",
        "widthImageTablet" : "string"
      },
      "imageInPage" : {
        "domElementSelector" : "string",
        "height" : "string",
        "htmlContent" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "mainPageUrl" : "string",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "width" : "string"
      },
      "emailAction" : {
        "customDataIndex" : "1234",
        "customSolutionName" : "string",
        "emailContentSolution" : "CUSTOM_TEMPLATE",
        "emailSolution" : "CUSTOM",
        "emailTags" : "string",
        "emailTemplateId" : "string",
        "fetchingMethod" : "CUSTOM_DATA",
        "fetchingScript" : "string",
        "goalCancellingId" : "123456789",
        "headerEmailSubject" : "string",
        "headerReplyEmail" : "string",
        "headerSenderEmail" : "string",
        "headerSenderName" : "string",
        "htmlContent" : "string",
        "neverCancelSending" : "false",
        "randomTagId" : "string",
        "secondsDelayToSend" : "123456789",
        "sendAtOnce" : "false",
        "solutionKey" : "string",
        "solutionSecret" : "string",
        "solutionUrl" : "string"
      },
      "countDownBanner" : {
        "backgroundColor" : "string",
        "contentType" : "TEXT",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "dayOfMonth" : "1234",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "height" : "string",
        "horizontalAlignmentType" : "LEFT",
        "hourOfDay" : "1234",
        "htmlContent" : "string",
        "mainPageUrl" : "string",
        "minute" : "1234",
        "month" : "1234",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "second" : "1234",
        "textColor" : "string",
        "textContent" : "string",
        "verticalAlignmentType" : "TOP",
        "width" : "string",
        "year" : "1234"
      },
      "googleForm" : {
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "googleFormURL" : "string",
        "height" : "string",
        "mainPageUrl" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "width" : "string",
        "withOverlay" : "false"
      },
      "cookieInfoBanner" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "message" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "redirectText" : "string",
        "redirectURL" : "string",
        "width" : "string"
      },
      "iAdvize" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "iAdvizeIdentifier" : "string",
        "iadvizeIdentifier" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "platformType" : "STANDARD",
        "position" : "TOP",
        "width" : "string"
      },
      "socialBar" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "height" : "string",
        "mainPageUrl" : "string",
        "marginBottom" : "string",
        "marginLeft" : "string",
        "marginRight" : "string",
        "marginTop" : "string",
        "orientation" : "HORIZONTAL",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "urlToShare" : "string",
        "urlType" : "CURRENT",
        "width" : "string"
      },
      "popInVideo" : {
        "addBackground" : "false",
        "autoPlay" : "false",
        "autoSize" : "false",
        "closePopin" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "url" : "string",
        "width" : "string"
      },
      "adBlock" : {
        "actionType" : "SHOW_MESSAGE",
        "backgroundColor" : "string",
        "blockNavigationType" : "ALL",
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "fontSize" : "string",
        "goalName" : "string",
        "height" : "string",
        "horizontalAlignmentType" : "LEFT",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageType" : "NONE",
        "mainPageUrl" : "string",
        "messageContent" : "string",
        "messageTitle" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "shiftContent" : "false",
        "shouldScrollTo" : "false",
        "showMessage" : "false",
        "textColor" : "string",
        "trackAction" : "false",
        "type" : "POPIN",
        "verticalAlignmentType" : "TOP",
        "width" : "string",
        "withOverlay" : "false"
      },
      "visitsCounter" : {
        "counterFormat" : "FRENCH",
        "counterFromDate" : "2020-07-14T17:06:58.440855",
        "counterFromType" : "DAY",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "descriptionText" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "minimumVisits" : "123456789",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "width" : "string"
      },
      "newsLetter" : {
        "backgroundColor" : "string",
        "backgroundImage" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "confirmationText" : "string",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "emailKey" : "string",
        "height" : "string",
        "legalNoticeUrl" : "string",
        "outsideClose" : "false",
        "overlayEnabled" : "false",
        "pageUrl" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "requestType" : "GET",
        "timerClose" : "1234",
        "titleEnabled" : "false",
        "type" : "FORM",
        "url" : "string",
        "width" : "string"
      },
      "trackingTools" : [ {
        "adobeOmnitureObject" : "string",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "customVariable" : "1234",
        "eulerianUserCentricParameter" : "string",
        "googleAnalyticsTracker" : "string",
        "heatMapPageWidth" : "1234",
        "reportingScript" : "string",
        "type" : "GOOGLE_ANALYTICS",
        "universalAnalyticsDimension" : "1234"
      } ]
    } ]
    
    Response body

    Personalization
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify a personalization
    iadvizeIAdvize
    namestringThe name of the personalization
    siteIdlongThe website id that a personalization belongs to
    variationIdlongThe variation id of the given personalization
    statusstringThe status of the given personalization
    dateStatusModifieddatetimeLast moment when status was updated
    targetingSegmentIdlongSelected targeting segment
    goalIdlongMain goal
    goalsarraySelected goals
    customExpositionRatedoubleThe segment percentage exposed to personalization
    globalCappingNumberVisitorsbooleanThis option allows you to set the capping configuration
    globalCappingVisitorsConfigenumThe visitors configuration for threshold of total number of exposed visitors. Can be [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]
    globalCappingGoalIdlongThe goal for threshold of total number of exposed visitors
    visitExpositionFrequencyintegerExposition frequency during a unique visit
    visitorExpositionFrequencyintegerExposition frequency during a unique visitor
    expositionFrequencyDelaylongPeriod of time of exposition frequency during different visitors
    multiExpositionFrequencyDelaylongMinimum delay between each exposition
    cappingPerVisitorExpositionsbooleanIf true stop exposing a same visitor when the total number of expositions exceeds this threshold
    visitorExpositionFrequencyMaxintegerStop exposing a same visitor when the total number of expositions exceeds this threshold
    cappingPerVisitorExposedVisitsbooleanIf true stop exposing a same visitor when the number of visits exceeds this threshold
    exposedVisitsSameVisitorMaxintegerStop exposing a same visitor when the number of visits exceeds this threshold
    cappingPerVisitorConvertGoalbooleanIf true stop exposing a same visitor when the goal is completed
    cappingPerVisitorGoalIdlongStop exposing a same visitor when the goal with given id is completed
    maxNumberVisitorsExposedlongThreshold of the total number of exposed visitors
    checkConditionsRuleenumThe behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
    priorityintegerThe priority of the personalization
    popInPopInPop-In settings
    stickyBlockStickyBlockSticky block settings
    imageInPageImageInPageSettings of an image in page
    emailActionEmailActionSettings of an email
    countDownBannerCountDownBannerSettings of a countdown banner widget
    googleFormGoogleFormSettings of a Google form widget
    cookieInfoBannerCookieInfoBannerSettings of a cookie banner widget
    iAdvizeIAdvizeSettings of an iAdvize chat widget
    socialBarSocialBarSettings of a social sharing bar widget
    popInVideoPopInVideoSettings of a video pop-in widget
    adBlockAdBlockSettings of an Adblocker widget
    visitsCounterVisitsCounterSettings of a visits counter widget
    newsLetterNewsLetterSettings of a newsletter subscription form widget
    trackingToolsarray[TrackingTool]

    IAdvize
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    iAdvizeIdentifierstring
    iadvizeIdentifierstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    platformTypeenumCan be [STANDARD, HIGH_AVAILABILITY]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring

    PopIn
    NameTypeDescription
    animationDirectionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    animationTriggerenumCan be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
    animationTypeenumCan be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
    backgroundColorstring
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayImageConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    fontSizestring
    heightstring
    heightImageDesktopstring
    heightImageMobilestring
    heightImageTabletstring
    htmlContentstring
    idTarget2Sellstring
    imageImage
    imageDesktopImage
    imageMobileImage
    imageTabletImage
    namestring
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectURLstring
    targetBlankboolean
    templateboolean
    textColorstring
    textContentstring
    typeenumCan be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
    widthstring
    widthImageDesktopstring
    widthImageMobilestring
    widthImageTabletstring
    withOverlayboolean

    Image
    NameTypeDescription
    baseColorinteger
    colorDepthinteger
    datedatetime
    fileNamestring
    fileWeightlong
    formatenumCan be [PNG, JPEG, GIF]
    heightinteger
    keywordsarray
    namestring
    sharedboolean
    siteIdlong
    sourcestring
    widthinteger

    StickyBlock
    NameTypeDescription
    animationDirectionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    animationTriggerenumCan be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
    animationTypeenumCan be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
    backgroundColorstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayImageConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    fontSizestring
    heightstring
    heightImageDesktopstring
    heightImageMobilestring
    heightImageTabletstring
    htmlContentstring
    idTarget2Sellstring
    imageImage
    imageDesktopImage
    imageMobileImage
    imageTabletImage
    namestring
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectURLstring
    shiftContentboolean
    shouldScrollToboolean
    targetBlankboolean
    templateboolean
    textColorstring
    textContentstring
    typeenumCan be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
    widthstring
    widthImageDesktopstring
    widthImageMobilestring
    widthImageTabletstring

    ImageInPage
    NameTypeDescription
    domElementSelectorstring
    heightstring
    htmlContentstring
    imageImage
    mainPageUrlstring
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    widthstring

    EmailAction
    NameTypeDescription
    customDataIndexinteger
    customSolutionNamestring
    emailContentSolutionenumCan be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
    emailSolutionenumCan be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
    emailTagsstring
    emailTemplateIdstring
    fetchingMethodenumCan be [CUSTOM_DATA, SCRIPT, NONE]
    fetchingScriptstring
    goalCancellingIdlong
    headerEmailSubjectstring
    headerReplyEmailstring
    headerSenderEmailstring
    headerSenderNamestring
    htmlContentstring
    neverCancelSendingboolean
    randomTagIdstring
    secondsDelayToSendlong
    sendAtOnceboolean
    solutionKeystring
    solutionSecretstring
    solutionUrlstring

    CountDownBanner
    NameTypeDescription
    backgroundColorstring
    contentTypeenumCan be [TEXT, HTML]
    customPositionAxisXstring
    customPositionAxisYstring
    dayOfMonthinteger
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    heightstring
    horizontalAlignmentTypeenumCan be [LEFT, CENTER, RIGHT]
    hourOfDayinteger
    htmlContentstring
    mainPageUrlstring
    minuteinteger
    monthinteger
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    secondinteger
    textColorstring
    textContentstring
    verticalAlignmentTypeenumCan be [TOP, CENTER, BOTTOM]
    widthstring
    yearinteger

    GoogleForm
    NameTypeDescription
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    googleFormURLstring
    heightstring
    mainPageUrlstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    widthstring
    withOverlayboolean

    CookieInfoBanner
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    messagestring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectTextstring
    redirectURLstring
    widthstring

    SocialBar
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    heightstring
    mainPageUrlstring
    marginBottomstring
    marginLeftstring
    marginRightstring
    marginTopstring
    orientationenumCan be [HORIZONTAL, VERTICAL]
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    urlToSharestring
    urlTypeenumCan be [CURRENT, FIXED]
    widthstring

    PopInVideo
    NameTypeDescription
    addBackgroundboolean
    autoPlayboolean
    autoSizeboolean
    closePopinboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    urlstring
    widthstring

    AdBlock
    NameTypeDescription
    actionTypeenumCan be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
    backgroundColorstring
    blockNavigationTypeenumCan be [ALL, OPAQUE, REDIRECT]
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    fontSizestring
    goalNamestring
    heightstring
    horizontalAlignmentTypeenumCan be [LEFT, CENTER, RIGHT]
    imageImage
    imageTypeenumCan be [NONE, DEFAULT, CUSTOM]
    mainPageUrlstring
    messageContentstring
    messageTitlestring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    shiftContentboolean
    shouldScrollToboolean
    showMessageboolean
    textColorstring
    trackActionboolean
    typeenumCan be [POPIN, STICKY_BLOCK]
    verticalAlignmentTypeenumCan be [TOP, CENTER, BOTTOM]
    widthstring
    withOverlayboolean

    VisitsCounter
    NameTypeDescription
    counterFormatenumCan be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
    counterFromDatedatetime
    counterFromTypeenumCan be [DAY, WEEK, DAYS_15, PRECISE_DATE]
    customPositionAxisXstring
    customPositionAxisYstring
    descriptionTextstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    minimumVisitslong
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring

    NewsLetter
    NameTypeDescription
    backgroundColorstring
    backgroundImageImage
    confirmationTextstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    emailKeystring
    heightstring
    legalNoticeUrlstring
    outsideCloseboolean
    overlayEnabledboolean
    pageUrlstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    requestTypeenumCan be [GET, POST]
    timerCloseinteger
    titleEnabledboolean
    typeenumCan be [FORM, SERVICE]
    urlstring
    widthstring

    TrackingTool
    NameTypeDescription
    adobeOmnitureObjectstring
    comScoreCustomerIdstring
    comScoreDomainstring
    customVariableinteger
    eulerianUserCentricParameterstring
    googleAnalyticsTrackerstring
    heatMapPageWidthinteger
    reportingScriptstring
    typeenumCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    universalAnalyticsDimensioninteger

    Create new personalization

    Example request

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

    POST /personalizations

    Create new personalization with given parameters

    Request body

    Personalization
    NameTypeDescription
    iadvizeIAdvize
    id
    *read only
    longThis field is generated by the system to uniquely identify a personalization
    name
    *required
    stringThe name of the personalization
    siteId
    *required
    longThe website id that a personalization belongs to
    variationIdlongThe variation id of the given personalization
    status
    *read only
    stringThe status of the given personalization
    dateStatusModified
    *read only
    datetimeLast moment when status was updated
    targetingSegmentId
    *read only
    longSelected targeting segment
    goalId
    *read only
    longMain goal
    goals
    *read only
    arraySelected goals
    customExpositionRate
    *read only
    doubleThe segment percentage exposed to personalization
    globalCappingNumberVisitors
    *read only
    booleanThis option allows you to set the capping configuration
    globalCappingVisitorsConfig
    *read only
    enumThe 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
    longThe goal for threshold of total number of exposed visitors
    visitExpositionFrequency
    *read only
    integerExposition frequency during a unique visit
    visitorExpositionFrequency
    *read only
    integerExposition frequency during a unique visitor
    expositionFrequencyDelay
    *read only
    longPeriod of time of exposition frequency during different visitors
    multiExpositionFrequencyDelay
    *read only
    longMinimum delay between each exposition
    cappingPerVisitorExpositions
    *read only
    booleanIf true stop exposing a same visitor when the total number of expositions exceeds this threshold
    visitorExpositionFrequencyMax
    *read only
    integerStop exposing a same visitor when the total number of expositions exceeds this threshold
    cappingPerVisitorExposedVisits
    *read only
    booleanIf true stop exposing a same visitor when the number of visits exceeds this threshold
    exposedVisitsSameVisitorMax
    *read only
    integerStop exposing a same visitor when the number of visits exceeds this threshold
    cappingPerVisitorConvertGoal
    *read only
    booleanIf true stop exposing a same visitor when the goal is completed
    cappingPerVisitorGoalId
    *read only
    longStop exposing a same visitor when the goal with given id is completed
    maxNumberVisitorsExposed
    *read only
    longThreshold of the total number of exposed visitors
    checkConditionsRule
    *read only
    enumThe behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
    priority
    *read only
    integerThe priority of the personalization
    popIn
    *read only
    PopInPop-In settings
    stickyBlock
    *read only
    StickyBlockSticky block settings
    imageInPage
    *read only
    ImageInPageSettings of an image in page
    emailAction
    *read only
    EmailActionSettings of an email
    countDownBanner
    *read only
    CountDownBannerSettings of a countdown banner widget
    googleForm
    *read only
    GoogleFormSettings of a Google form widget
    cookieInfoBanner
    *read only
    CookieInfoBannerSettings of a cookie banner widget
    iAdvize
    *read only
    IAdvizeSettings of an iAdvize chat widget
    socialBar
    *read only
    SocialBarSettings of a social sharing bar widget
    popInVideo
    *read only
    PopInVideoSettings of a video pop-in widget
    adBlock
    *read only
    AdBlockSettings of an Adblocker widget
    visitsCounter
    *read only
    VisitsCounterSettings of a visits counter widget
    newsLetter
    *read only
    NewsLetterSettings of a newsletter subscription form widget
    trackingToolsarray[TrackingTool]

    IAdvize
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    iAdvizeIdentifierstring
    iadvizeIdentifierstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    platformTypeenumCan be [STANDARD, HIGH_AVAILABILITY]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring

    PopIn
    NameTypeDescription
    animationDirectionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    animationTriggerenumCan be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
    animationTypeenumCan be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
    backgroundColorstring
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayImageConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    fontSizestring
    heightstring
    heightImageDesktopstring
    heightImageMobilestring
    heightImageTabletstring
    htmlContentstring
    idTarget2Sellstring
    imageImage
    imageDesktopImage
    imageMobileImage
    imageTabletImage
    namestring
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectURLstring
    targetBlankboolean
    templateboolean
    textColorstring
    textContentstring
    typeenumCan be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
    widthstring
    widthImageDesktopstring
    widthImageMobilestring
    widthImageTabletstring
    withOverlayboolean

    Image
    NameTypeDescription
    baseColorinteger
    colorDepthinteger
    datedatetime
    fileNamestring
    fileWeightlong
    formatenumCan be [PNG, JPEG, GIF]
    heightinteger
    keywordsarray
    namestring
    sharedboolean
    siteIdlong
    sourcestring
    widthinteger

    StickyBlock
    NameTypeDescription
    animationDirectionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    animationTriggerenumCan be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
    animationTypeenumCan be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
    backgroundColorstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayImageConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    fontSizestring
    heightstring
    heightImageDesktopstring
    heightImageMobilestring
    heightImageTabletstring
    htmlContentstring
    idTarget2Sellstring
    imageImage
    imageDesktopImage
    imageMobileImage
    imageTabletImage
    namestring
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectURLstring
    shiftContentboolean
    shouldScrollToboolean
    targetBlankboolean
    templateboolean
    textColorstring
    textContentstring
    typeenumCan be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
    widthstring
    widthImageDesktopstring
    widthImageMobilestring
    widthImageTabletstring

    ImageInPage
    NameTypeDescription
    domElementSelectorstring
    heightstring
    htmlContentstring
    imageImage
    mainPageUrlstring
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    widthstring

    EmailAction
    NameTypeDescription
    customDataIndexinteger
    customSolutionNamestring
    emailContentSolutionenumCan be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
    emailSolutionenumCan be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
    emailTagsstring
    emailTemplateIdstring
    fetchingMethodenumCan be [CUSTOM_DATA, SCRIPT, NONE]
    fetchingScriptstring
    goalCancellingIdlong
    headerEmailSubjectstring
    headerReplyEmailstring
    headerSenderEmailstring
    headerSenderNamestring
    htmlContentstring
    neverCancelSendingboolean
    randomTagIdstring
    secondsDelayToSendlong
    sendAtOnceboolean
    solutionKeystring
    solutionSecretstring
    solutionUrlstring

    CountDownBanner
    NameTypeDescription
    backgroundColorstring
    contentTypeenumCan be [TEXT, HTML]
    customPositionAxisXstring
    customPositionAxisYstring
    dayOfMonthinteger
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    heightstring
    horizontalAlignmentTypeenumCan be [LEFT, CENTER, RIGHT]
    hourOfDayinteger
    htmlContentstring
    mainPageUrlstring
    minuteinteger
    monthinteger
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    secondinteger
    textColorstring
    textContentstring
    verticalAlignmentTypeenumCan be [TOP, CENTER, BOTTOM]
    widthstring
    yearinteger

    GoogleForm
    NameTypeDescription
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    googleFormURLstring
    heightstring
    mainPageUrlstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    widthstring
    withOverlayboolean

    CookieInfoBanner
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    messagestring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectTextstring
    redirectURLstring
    widthstring

    SocialBar
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    heightstring
    mainPageUrlstring
    marginBottomstring
    marginLeftstring
    marginRightstring
    marginTopstring
    orientationenumCan be [HORIZONTAL, VERTICAL]
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    urlToSharestring
    urlTypeenumCan be [CURRENT, FIXED]
    widthstring

    PopInVideo
    NameTypeDescription
    addBackgroundboolean
    autoPlayboolean
    autoSizeboolean
    closePopinboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    urlstring
    widthstring

    AdBlock
    NameTypeDescription
    actionTypeenumCan be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
    backgroundColorstring
    blockNavigationTypeenumCan be [ALL, OPAQUE, REDIRECT]
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    fontSizestring
    goalNamestring
    heightstring
    horizontalAlignmentTypeenumCan be [LEFT, CENTER, RIGHT]
    imageImage
    imageTypeenumCan be [NONE, DEFAULT, CUSTOM]
    mainPageUrlstring
    messageContentstring
    messageTitlestring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    shiftContentboolean
    shouldScrollToboolean
    showMessageboolean
    textColorstring
    trackActionboolean
    typeenumCan be [POPIN, STICKY_BLOCK]
    verticalAlignmentTypeenumCan be [TOP, CENTER, BOTTOM]
    widthstring
    withOverlayboolean

    VisitsCounter
    NameTypeDescription
    counterFormatenumCan be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
    counterFromDatedatetime
    counterFromTypeenumCan be [DAY, WEEK, DAYS_15, PRECISE_DATE]
    customPositionAxisXstring
    customPositionAxisYstring
    descriptionTextstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    minimumVisitslong
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring

    NewsLetter
    NameTypeDescription
    backgroundColorstring
    backgroundImageImage
    confirmationTextstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    emailKeystring
    heightstring
    legalNoticeUrlstring
    outsideCloseboolean
    overlayEnabledboolean
    pageUrlstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    requestTypeenumCan be [GET, POST]
    timerCloseinteger
    titleEnabledboolean
    typeenumCan be [FORM, SERVICE]
    urlstring
    widthstring

    TrackingTool
    NameTypeDescription
    adobeOmnitureObjectstring
    comScoreCustomerIdstring
    comScoreDomainstring
    customVariableinteger
    eulerianUserCentricParameterstring
    googleAnalyticsTrackerstring
    heatMapPageWidthinteger
    reportingScriptstring
    typeenumCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    universalAnalyticsDimensioninteger

    Example response

    {
      "iadvize" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "iAdvizeIdentifier" : "string",
        "iadvizeIdentifier" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "platformType" : "STANDARD",
        "position" : "TOP",
        "width" : "string"
      },
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "variationId" : "123456789",
      "status" : "string",
      "dateStatusModified" : "2020-07-14T17:06:58.440855",
      "targetingSegmentId" : "123456789",
      "goalId" : "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" : {
        "animationDirection" : "TOP",
        "animationTrigger" : "ON_OPEN",
        "animationType" : "NONE",
        "backgroundColor" : "string",
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
        "fontSize" : "string",
        "height" : "string",
        "heightImageDesktop" : "string",
        "heightImageMobile" : "string",
        "heightImageTablet" : "string",
        "htmlContent" : "string",
        "idTarget2Sell" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageDesktop" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageMobile" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageTablet" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "name" : "string",
        "position" : "TOP",
        "redirectURL" : "string",
        "targetBlank" : "false",
        "template" : "false",
        "textColor" : "string",
        "textContent" : "string",
        "type" : "SINGLE_IMAGE",
        "width" : "string",
        "widthImageDesktop" : "string",
        "widthImageMobile" : "string",
        "widthImageTablet" : "string",
        "withOverlay" : "false"
      },
      "stickyBlock" : {
        "animationDirection" : "TOP",
        "animationTrigger" : "ON_OPEN",
        "animationType" : "NONE",
        "backgroundColor" : "string",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
        "fontSize" : "string",
        "height" : "string",
        "heightImageDesktop" : "string",
        "heightImageMobile" : "string",
        "heightImageTablet" : "string",
        "htmlContent" : "string",
        "idTarget2Sell" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageDesktop" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageMobile" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageTablet" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "name" : "string",
        "position" : "TOP",
        "redirectURL" : "string",
        "shiftContent" : "false",
        "shouldScrollTo" : "false",
        "targetBlank" : "false",
        "template" : "false",
        "textColor" : "string",
        "textContent" : "string",
        "type" : "SINGLE_IMAGE",
        "width" : "string",
        "widthImageDesktop" : "string",
        "widthImageMobile" : "string",
        "widthImageTablet" : "string"
      },
      "imageInPage" : {
        "domElementSelector" : "string",
        "height" : "string",
        "htmlContent" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "mainPageUrl" : "string",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "width" : "string"
      },
      "emailAction" : {
        "customDataIndex" : "1234",
        "customSolutionName" : "string",
        "emailContentSolution" : "CUSTOM_TEMPLATE",
        "emailSolution" : "CUSTOM",
        "emailTags" : "string",
        "emailTemplateId" : "string",
        "fetchingMethod" : "CUSTOM_DATA",
        "fetchingScript" : "string",
        "goalCancellingId" : "123456789",
        "headerEmailSubject" : "string",
        "headerReplyEmail" : "string",
        "headerSenderEmail" : "string",
        "headerSenderName" : "string",
        "htmlContent" : "string",
        "neverCancelSending" : "false",
        "randomTagId" : "string",
        "secondsDelayToSend" : "123456789",
        "sendAtOnce" : "false",
        "solutionKey" : "string",
        "solutionSecret" : "string",
        "solutionUrl" : "string"
      },
      "countDownBanner" : {
        "backgroundColor" : "string",
        "contentType" : "TEXT",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "dayOfMonth" : "1234",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "height" : "string",
        "horizontalAlignmentType" : "LEFT",
        "hourOfDay" : "1234",
        "htmlContent" : "string",
        "mainPageUrl" : "string",
        "minute" : "1234",
        "month" : "1234",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "second" : "1234",
        "textColor" : "string",
        "textContent" : "string",
        "verticalAlignmentType" : "TOP",
        "width" : "string",
        "year" : "1234"
      },
      "googleForm" : {
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "googleFormURL" : "string",
        "height" : "string",
        "mainPageUrl" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "width" : "string",
        "withOverlay" : "false"
      },
      "cookieInfoBanner" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "message" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "redirectText" : "string",
        "redirectURL" : "string",
        "width" : "string"
      },
      "iAdvize" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "iAdvizeIdentifier" : "string",
        "iadvizeIdentifier" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "platformType" : "STANDARD",
        "position" : "TOP",
        "width" : "string"
      },
      "socialBar" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "height" : "string",
        "mainPageUrl" : "string",
        "marginBottom" : "string",
        "marginLeft" : "string",
        "marginRight" : "string",
        "marginTop" : "string",
        "orientation" : "HORIZONTAL",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "urlToShare" : "string",
        "urlType" : "CURRENT",
        "width" : "string"
      },
      "popInVideo" : {
        "addBackground" : "false",
        "autoPlay" : "false",
        "autoSize" : "false",
        "closePopin" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "url" : "string",
        "width" : "string"
      },
      "adBlock" : {
        "actionType" : "SHOW_MESSAGE",
        "backgroundColor" : "string",
        "blockNavigationType" : "ALL",
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "fontSize" : "string",
        "goalName" : "string",
        "height" : "string",
        "horizontalAlignmentType" : "LEFT",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageType" : "NONE",
        "mainPageUrl" : "string",
        "messageContent" : "string",
        "messageTitle" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "shiftContent" : "false",
        "shouldScrollTo" : "false",
        "showMessage" : "false",
        "textColor" : "string",
        "trackAction" : "false",
        "type" : "POPIN",
        "verticalAlignmentType" : "TOP",
        "width" : "string",
        "withOverlay" : "false"
      },
      "visitsCounter" : {
        "counterFormat" : "FRENCH",
        "counterFromDate" : "2020-07-14T17:06:58.440855",
        "counterFromType" : "DAY",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "descriptionText" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "minimumVisits" : "123456789",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "width" : "string"
      },
      "newsLetter" : {
        "backgroundColor" : "string",
        "backgroundImage" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "confirmationText" : "string",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "emailKey" : "string",
        "height" : "string",
        "legalNoticeUrl" : "string",
        "outsideClose" : "false",
        "overlayEnabled" : "false",
        "pageUrl" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "requestType" : "GET",
        "timerClose" : "1234",
        "titleEnabled" : "false",
        "type" : "FORM",
        "url" : "string",
        "width" : "string"
      },
      "trackingTools" : [ {
        "adobeOmnitureObject" : "string",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "customVariable" : "1234",
        "eulerianUserCentricParameter" : "string",
        "googleAnalyticsTracker" : "string",
        "heatMapPageWidth" : "1234",
        "reportingScript" : "string",
        "type" : "GOOGLE_ANALYTICS",
        "universalAnalyticsDimension" : "1234"
      } ]
    }
    
    Response body

    Personalization
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify a personalization
    iadvizeIAdvize
    namestringThe name of the personalization
    siteIdlongThe website id that a personalization belongs to
    variationIdlongThe variation id of the given personalization
    statusstringThe status of the given personalization
    dateStatusModifieddatetimeLast moment when status was updated
    targetingSegmentIdlongSelected targeting segment
    goalIdlongMain goal
    goalsarraySelected goals
    customExpositionRatedoubleThe segment percentage exposed to personalization
    globalCappingNumberVisitorsbooleanThis option allows you to set the capping configuration
    globalCappingVisitorsConfigenumThe visitors configuration for threshold of total number of exposed visitors. Can be [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]
    globalCappingGoalIdlongThe goal for threshold of total number of exposed visitors
    visitExpositionFrequencyintegerExposition frequency during a unique visit
    visitorExpositionFrequencyintegerExposition frequency during a unique visitor
    expositionFrequencyDelaylongPeriod of time of exposition frequency during different visitors
    multiExpositionFrequencyDelaylongMinimum delay between each exposition
    cappingPerVisitorExpositionsbooleanIf true stop exposing a same visitor when the total number of expositions exceeds this threshold
    visitorExpositionFrequencyMaxintegerStop exposing a same visitor when the total number of expositions exceeds this threshold
    cappingPerVisitorExposedVisitsbooleanIf true stop exposing a same visitor when the number of visits exceeds this threshold
    exposedVisitsSameVisitorMaxintegerStop exposing a same visitor when the number of visits exceeds this threshold
    cappingPerVisitorConvertGoalbooleanIf true stop exposing a same visitor when the goal is completed
    cappingPerVisitorGoalIdlongStop exposing a same visitor when the goal with given id is completed
    maxNumberVisitorsExposedlongThreshold of the total number of exposed visitors
    checkConditionsRuleenumThe behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
    priorityintegerThe priority of the personalization
    popInPopInPop-In settings
    stickyBlockStickyBlockSticky block settings
    imageInPageImageInPageSettings of an image in page
    emailActionEmailActionSettings of an email
    countDownBannerCountDownBannerSettings of a countdown banner widget
    googleFormGoogleFormSettings of a Google form widget
    cookieInfoBannerCookieInfoBannerSettings of a cookie banner widget
    iAdvizeIAdvizeSettings of an iAdvize chat widget
    socialBarSocialBarSettings of a social sharing bar widget
    popInVideoPopInVideoSettings of a video pop-in widget
    adBlockAdBlockSettings of an Adblocker widget
    visitsCounterVisitsCounterSettings of a visits counter widget
    newsLetterNewsLetterSettings of a newsletter subscription form widget
    trackingToolsarray[TrackingTool]

    IAdvize
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    iAdvizeIdentifierstring
    iadvizeIdentifierstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    platformTypeenumCan be [STANDARD, HIGH_AVAILABILITY]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring

    PopIn
    NameTypeDescription
    animationDirectionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    animationTriggerenumCan be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
    animationTypeenumCan be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
    backgroundColorstring
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayImageConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    fontSizestring
    heightstring
    heightImageDesktopstring
    heightImageMobilestring
    heightImageTabletstring
    htmlContentstring
    idTarget2Sellstring
    imageImage
    imageDesktopImage
    imageMobileImage
    imageTabletImage
    namestring
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectURLstring
    targetBlankboolean
    templateboolean
    textColorstring
    textContentstring
    typeenumCan be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
    widthstring
    widthImageDesktopstring
    widthImageMobilestring
    widthImageTabletstring
    withOverlayboolean

    Image
    NameTypeDescription
    baseColorinteger
    colorDepthinteger
    datedatetime
    fileNamestring
    fileWeightlong
    formatenumCan be [PNG, JPEG, GIF]
    heightinteger
    keywordsarray
    namestring
    sharedboolean
    siteIdlong
    sourcestring
    widthinteger

    StickyBlock
    NameTypeDescription
    animationDirectionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    animationTriggerenumCan be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
    animationTypeenumCan be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
    backgroundColorstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayImageConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    fontSizestring
    heightstring
    heightImageDesktopstring
    heightImageMobilestring
    heightImageTabletstring
    htmlContentstring
    idTarget2Sellstring
    imageImage
    imageDesktopImage
    imageMobileImage
    imageTabletImage
    namestring
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectURLstring
    shiftContentboolean
    shouldScrollToboolean
    targetBlankboolean
    templateboolean
    textColorstring
    textContentstring
    typeenumCan be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
    widthstring
    widthImageDesktopstring
    widthImageMobilestring
    widthImageTabletstring

    ImageInPage
    NameTypeDescription
    domElementSelectorstring
    heightstring
    htmlContentstring
    imageImage
    mainPageUrlstring
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    widthstring

    EmailAction
    NameTypeDescription
    customDataIndexinteger
    customSolutionNamestring
    emailContentSolutionenumCan be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
    emailSolutionenumCan be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
    emailTagsstring
    emailTemplateIdstring
    fetchingMethodenumCan be [CUSTOM_DATA, SCRIPT, NONE]
    fetchingScriptstring
    goalCancellingIdlong
    headerEmailSubjectstring
    headerReplyEmailstring
    headerSenderEmailstring
    headerSenderNamestring
    htmlContentstring
    neverCancelSendingboolean
    randomTagIdstring
    secondsDelayToSendlong
    sendAtOnceboolean
    solutionKeystring
    solutionSecretstring
    solutionUrlstring

    CountDownBanner
    NameTypeDescription
    backgroundColorstring
    contentTypeenumCan be [TEXT, HTML]
    customPositionAxisXstring
    customPositionAxisYstring
    dayOfMonthinteger
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    heightstring
    horizontalAlignmentTypeenumCan be [LEFT, CENTER, RIGHT]
    hourOfDayinteger
    htmlContentstring
    mainPageUrlstring
    minuteinteger
    monthinteger
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    secondinteger
    textColorstring
    textContentstring
    verticalAlignmentTypeenumCan be [TOP, CENTER, BOTTOM]
    widthstring
    yearinteger

    GoogleForm
    NameTypeDescription
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    googleFormURLstring
    heightstring
    mainPageUrlstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    widthstring
    withOverlayboolean

    CookieInfoBanner
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    messagestring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectTextstring
    redirectURLstring
    widthstring

    SocialBar
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    heightstring
    mainPageUrlstring
    marginBottomstring
    marginLeftstring
    marginRightstring
    marginTopstring
    orientationenumCan be [HORIZONTAL, VERTICAL]
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    urlToSharestring
    urlTypeenumCan be [CURRENT, FIXED]
    widthstring

    PopInVideo
    NameTypeDescription
    addBackgroundboolean
    autoPlayboolean
    autoSizeboolean
    closePopinboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    urlstring
    widthstring

    AdBlock
    NameTypeDescription
    actionTypeenumCan be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
    backgroundColorstring
    blockNavigationTypeenumCan be [ALL, OPAQUE, REDIRECT]
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    fontSizestring
    goalNamestring
    heightstring
    horizontalAlignmentTypeenumCan be [LEFT, CENTER, RIGHT]
    imageImage
    imageTypeenumCan be [NONE, DEFAULT, CUSTOM]
    mainPageUrlstring
    messageContentstring
    messageTitlestring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    shiftContentboolean
    shouldScrollToboolean
    showMessageboolean
    textColorstring
    trackActionboolean
    typeenumCan be [POPIN, STICKY_BLOCK]
    verticalAlignmentTypeenumCan be [TOP, CENTER, BOTTOM]
    widthstring
    withOverlayboolean

    VisitsCounter
    NameTypeDescription
    counterFormatenumCan be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
    counterFromDatedatetime
    counterFromTypeenumCan be [DAY, WEEK, DAYS_15, PRECISE_DATE]
    customPositionAxisXstring
    customPositionAxisYstring
    descriptionTextstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    minimumVisitslong
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring

    NewsLetter
    NameTypeDescription
    backgroundColorstring
    backgroundImageImage
    confirmationTextstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    emailKeystring
    heightstring
    legalNoticeUrlstring
    outsideCloseboolean
    overlayEnabledboolean
    pageUrlstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    requestTypeenumCan be [GET, POST]
    timerCloseinteger
    titleEnabledboolean
    typeenumCan be [FORM, SERVICE]
    urlstring
    widthstring

    TrackingTool
    NameTypeDescription
    adobeOmnitureObjectstring
    comScoreCustomerIdstring
    comScoreDomainstring
    customVariableinteger
    eulerianUserCentricParameterstring
    googleAnalyticsTrackerstring
    heatMapPageWidthinteger
    reportingScriptstring
    typeenumCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    universalAnalyticsDimensioninteger

    Get one personalization

    Example request

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

    GET /personalizations/{personalizationId}

    Get one personalization with given id

    Request arguments
    NamePlaceTypeDescription
    personalizationIdpathlongpersonalizationId

    Example response

    {
      "iadvize" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "iAdvizeIdentifier" : "string",
        "iadvizeIdentifier" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "platformType" : "STANDARD",
        "position" : "TOP",
        "width" : "string"
      },
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "variationId" : "123456789",
      "status" : "string",
      "dateStatusModified" : "2020-07-14T17:06:58.440855",
      "targetingSegmentId" : "123456789",
      "goalId" : "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" : {
        "animationDirection" : "TOP",
        "animationTrigger" : "ON_OPEN",
        "animationType" : "NONE",
        "backgroundColor" : "string",
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
        "fontSize" : "string",
        "height" : "string",
        "heightImageDesktop" : "string",
        "heightImageMobile" : "string",
        "heightImageTablet" : "string",
        "htmlContent" : "string",
        "idTarget2Sell" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageDesktop" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageMobile" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageTablet" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "name" : "string",
        "position" : "TOP",
        "redirectURL" : "string",
        "targetBlank" : "false",
        "template" : "false",
        "textColor" : "string",
        "textContent" : "string",
        "type" : "SINGLE_IMAGE",
        "width" : "string",
        "widthImageDesktop" : "string",
        "widthImageMobile" : "string",
        "widthImageTablet" : "string",
        "withOverlay" : "false"
      },
      "stickyBlock" : {
        "animationDirection" : "TOP",
        "animationTrigger" : "ON_OPEN",
        "animationType" : "NONE",
        "backgroundColor" : "string",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayImageConfiguration" : "DISPLAY_ALL_DEVICES",
        "fontSize" : "string",
        "height" : "string",
        "heightImageDesktop" : "string",
        "heightImageMobile" : "string",
        "heightImageTablet" : "string",
        "htmlContent" : "string",
        "idTarget2Sell" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageDesktop" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageMobile" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageTablet" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "name" : "string",
        "position" : "TOP",
        "redirectURL" : "string",
        "shiftContent" : "false",
        "shouldScrollTo" : "false",
        "targetBlank" : "false",
        "template" : "false",
        "textColor" : "string",
        "textContent" : "string",
        "type" : "SINGLE_IMAGE",
        "width" : "string",
        "widthImageDesktop" : "string",
        "widthImageMobile" : "string",
        "widthImageTablet" : "string"
      },
      "imageInPage" : {
        "domElementSelector" : "string",
        "height" : "string",
        "htmlContent" : "string",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "mainPageUrl" : "string",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "width" : "string"
      },
      "emailAction" : {
        "customDataIndex" : "1234",
        "customSolutionName" : "string",
        "emailContentSolution" : "CUSTOM_TEMPLATE",
        "emailSolution" : "CUSTOM",
        "emailTags" : "string",
        "emailTemplateId" : "string",
        "fetchingMethod" : "CUSTOM_DATA",
        "fetchingScript" : "string",
        "goalCancellingId" : "123456789",
        "headerEmailSubject" : "string",
        "headerReplyEmail" : "string",
        "headerSenderEmail" : "string",
        "headerSenderName" : "string",
        "htmlContent" : "string",
        "neverCancelSending" : "false",
        "randomTagId" : "string",
        "secondsDelayToSend" : "123456789",
        "sendAtOnce" : "false",
        "solutionKey" : "string",
        "solutionSecret" : "string",
        "solutionUrl" : "string"
      },
      "countDownBanner" : {
        "backgroundColor" : "string",
        "contentType" : "TEXT",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "dayOfMonth" : "1234",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "height" : "string",
        "horizontalAlignmentType" : "LEFT",
        "hourOfDay" : "1234",
        "htmlContent" : "string",
        "mainPageUrl" : "string",
        "minute" : "1234",
        "month" : "1234",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "second" : "1234",
        "textColor" : "string",
        "textContent" : "string",
        "verticalAlignmentType" : "TOP",
        "width" : "string",
        "year" : "1234"
      },
      "googleForm" : {
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "googleFormURL" : "string",
        "height" : "string",
        "mainPageUrl" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "width" : "string",
        "withOverlay" : "false"
      },
      "cookieInfoBanner" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "message" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "redirectText" : "string",
        "redirectURL" : "string",
        "width" : "string"
      },
      "iAdvize" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "iAdvizeIdentifier" : "string",
        "iadvizeIdentifier" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "platformType" : "STANDARD",
        "position" : "TOP",
        "width" : "string"
      },
      "socialBar" : {
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "height" : "string",
        "mainPageUrl" : "string",
        "marginBottom" : "string",
        "marginLeft" : "string",
        "marginRight" : "string",
        "marginTop" : "string",
        "orientation" : "HORIZONTAL",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "urlToShare" : "string",
        "urlType" : "CURRENT",
        "width" : "string"
      },
      "popInVideo" : {
        "addBackground" : "false",
        "autoPlay" : "false",
        "autoSize" : "false",
        "closePopin" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "url" : "string",
        "width" : "string"
      },
      "adBlock" : {
        "actionType" : "SHOW_MESSAGE",
        "backgroundColor" : "string",
        "blockNavigationType" : "ALL",
        "closeWithClickOnOverlay" : "false",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "domElementSelector" : "string",
        "fontSize" : "string",
        "goalName" : "string",
        "height" : "string",
        "horizontalAlignmentType" : "LEFT",
        "image" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "imageType" : "NONE",
        "mainPageUrl" : "string",
        "messageContent" : "string",
        "messageTitle" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "positionDefinition" : "EDITOR",
        "positionSelectorRelative" : "REPLACE",
        "redirectURL" : "string",
        "shiftContent" : "false",
        "shouldScrollTo" : "false",
        "showMessage" : "false",
        "textColor" : "string",
        "trackAction" : "false",
        "type" : "POPIN",
        "verticalAlignmentType" : "TOP",
        "width" : "string",
        "withOverlay" : "false"
      },
      "visitsCounter" : {
        "counterFormat" : "FRENCH",
        "counterFromDate" : "2020-07-14T17:06:58.440855",
        "counterFromType" : "DAY",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "descriptionText" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "height" : "string",
        "minimumVisits" : "123456789",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "width" : "string"
      },
      "newsLetter" : {
        "backgroundColor" : "string",
        "backgroundImage" : {
          "baseColor" : "1234",
          "colorDepth" : "1234",
          "date" : "2020-07-14T17:06:58.440855",
          "fileName" : "string",
          "fileWeight" : "123456789",
          "format" : "PNG",
          "height" : "1234",
          "keywords" : [ "[]" ],
          "name" : "string",
          "shared" : "false",
          "siteId" : "123456789",
          "source" : "string",
          "width" : "1234"
        },
        "confirmationText" : "string",
        "customPositionAxisX" : "string",
        "customPositionAxisY" : "string",
        "displayPluginConfiguration" : "DISPLAY_ALL_DEVICES",
        "emailKey" : "string",
        "height" : "string",
        "legalNoticeUrl" : "string",
        "outsideClose" : "false",
        "overlayEnabled" : "false",
        "pageUrl" : "string",
        "personalizationPluginLocation" : "INSIDE_PAGES",
        "position" : "TOP",
        "requestType" : "GET",
        "timerClose" : "1234",
        "titleEnabled" : "false",
        "type" : "FORM",
        "url" : "string",
        "width" : "string"
      },
      "trackingTools" : [ {
        "adobeOmnitureObject" : "string",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "customVariable" : "1234",
        "eulerianUserCentricParameter" : "string",
        "googleAnalyticsTracker" : "string",
        "heatMapPageWidth" : "1234",
        "reportingScript" : "string",
        "type" : "GOOGLE_ANALYTICS",
        "universalAnalyticsDimension" : "1234"
      } ]
    }
    
    Response body

    Personalization
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify a personalization
    iadvizeIAdvize
    namestringThe name of the personalization
    siteIdlongThe website id that a personalization belongs to
    variationIdlongThe variation id of the given personalization
    statusstringThe status of the given personalization
    dateStatusModifieddatetimeLast moment when status was updated
    targetingSegmentIdlongSelected targeting segment
    goalIdlongMain goal
    goalsarraySelected goals
    customExpositionRatedoubleThe segment percentage exposed to personalization
    globalCappingNumberVisitorsbooleanThis option allows you to set the capping configuration
    globalCappingVisitorsConfigenumThe visitors configuration for threshold of total number of exposed visitors. Can be [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]
    globalCappingGoalIdlongThe goal for threshold of total number of exposed visitors
    visitExpositionFrequencyintegerExposition frequency during a unique visit
    visitorExpositionFrequencyintegerExposition frequency during a unique visitor
    expositionFrequencyDelaylongPeriod of time of exposition frequency during different visitors
    multiExpositionFrequencyDelaylongMinimum delay between each exposition
    cappingPerVisitorExpositionsbooleanIf true stop exposing a same visitor when the total number of expositions exceeds this threshold
    visitorExpositionFrequencyMaxintegerStop exposing a same visitor when the total number of expositions exceeds this threshold
    cappingPerVisitorExposedVisitsbooleanIf true stop exposing a same visitor when the number of visits exceeds this threshold
    exposedVisitsSameVisitorMaxintegerStop exposing a same visitor when the number of visits exceeds this threshold
    cappingPerVisitorConvertGoalbooleanIf true stop exposing a same visitor when the goal is completed
    cappingPerVisitorGoalIdlongStop exposing a same visitor when the goal with given id is completed
    maxNumberVisitorsExposedlongThreshold of the total number of exposed visitors
    checkConditionsRuleenumThe behavior of Kameleoon to determine if a visitor is targeted or not. Can be [ALL_CONDITIONS, CUMULATIVE_WEIGHT]
    priorityintegerThe priority of the personalization
    popInPopInPop-In settings
    stickyBlockStickyBlockSticky block settings
    imageInPageImageInPageSettings of an image in page
    emailActionEmailActionSettings of an email
    countDownBannerCountDownBannerSettings of a countdown banner widget
    googleFormGoogleFormSettings of a Google form widget
    cookieInfoBannerCookieInfoBannerSettings of a cookie banner widget
    iAdvizeIAdvizeSettings of an iAdvize chat widget
    socialBarSocialBarSettings of a social sharing bar widget
    popInVideoPopInVideoSettings of a video pop-in widget
    adBlockAdBlockSettings of an Adblocker widget
    visitsCounterVisitsCounterSettings of a visits counter widget
    newsLetterNewsLetterSettings of a newsletter subscription form widget
    trackingToolsarray[TrackingTool]

    IAdvize
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    iAdvizeIdentifierstring
    iadvizeIdentifierstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    platformTypeenumCan be [STANDARD, HIGH_AVAILABILITY]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring

    PopIn
    NameTypeDescription
    animationDirectionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    animationTriggerenumCan be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
    animationTypeenumCan be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
    backgroundColorstring
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayImageConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    fontSizestring
    heightstring
    heightImageDesktopstring
    heightImageMobilestring
    heightImageTabletstring
    htmlContentstring
    idTarget2Sellstring
    imageImage
    imageDesktopImage
    imageMobileImage
    imageTabletImage
    namestring
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectURLstring
    targetBlankboolean
    templateboolean
    textColorstring
    textContentstring
    typeenumCan be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
    widthstring
    widthImageDesktopstring
    widthImageMobilestring
    widthImageTabletstring
    withOverlayboolean

    Image
    NameTypeDescription
    baseColorinteger
    colorDepthinteger
    datedatetime
    fileNamestring
    fileWeightlong
    formatenumCan be [PNG, JPEG, GIF]
    heightinteger
    keywordsarray
    namestring
    sharedboolean
    siteIdlong
    sourcestring
    widthinteger

    StickyBlock
    NameTypeDescription
    animationDirectionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    animationTriggerenumCan be [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]
    animationTypeenumCan be [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]
    backgroundColorstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayImageConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    fontSizestring
    heightstring
    heightImageDesktopstring
    heightImageMobilestring
    heightImageTabletstring
    htmlContentstring
    idTarget2Sellstring
    imageImage
    imageDesktopImage
    imageMobileImage
    imageTabletImage
    namestring
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectURLstring
    shiftContentboolean
    shouldScrollToboolean
    targetBlankboolean
    templateboolean
    textColorstring
    textContentstring
    typeenumCan be [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]
    widthstring
    widthImageDesktopstring
    widthImageMobilestring
    widthImageTabletstring

    ImageInPage
    NameTypeDescription
    domElementSelectorstring
    heightstring
    htmlContentstring
    imageImage
    mainPageUrlstring
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    widthstring

    EmailAction
    NameTypeDescription
    customDataIndexinteger
    customSolutionNamestring
    emailContentSolutionenumCan be [CUSTOM_TEMPLATE, HTML_CODE, NONE]
    emailSolutionenumCan be [CUSTOM, MANDRILL, MAILJET, MAILUP, SMARTFOCUS, MAILPERFORMANCE, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]
    emailTagsstring
    emailTemplateIdstring
    fetchingMethodenumCan be [CUSTOM_DATA, SCRIPT, NONE]
    fetchingScriptstring
    goalCancellingIdlong
    headerEmailSubjectstring
    headerReplyEmailstring
    headerSenderEmailstring
    headerSenderNamestring
    htmlContentstring
    neverCancelSendingboolean
    randomTagIdstring
    secondsDelayToSendlong
    sendAtOnceboolean
    solutionKeystring
    solutionSecretstring
    solutionUrlstring

    CountDownBanner
    NameTypeDescription
    backgroundColorstring
    contentTypeenumCan be [TEXT, HTML]
    customPositionAxisXstring
    customPositionAxisYstring
    dayOfMonthinteger
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    heightstring
    horizontalAlignmentTypeenumCan be [LEFT, CENTER, RIGHT]
    hourOfDayinteger
    htmlContentstring
    mainPageUrlstring
    minuteinteger
    monthinteger
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    secondinteger
    textColorstring
    textContentstring
    verticalAlignmentTypeenumCan be [TOP, CENTER, BOTTOM]
    widthstring
    yearinteger

    GoogleForm
    NameTypeDescription
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    googleFormURLstring
    heightstring
    mainPageUrlstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    widthstring
    withOverlayboolean

    CookieInfoBanner
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    messagestring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    redirectTextstring
    redirectURLstring
    widthstring

    SocialBar
    NameTypeDescription
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    heightstring
    mainPageUrlstring
    marginBottomstring
    marginLeftstring
    marginRightstring
    marginTopstring
    orientationenumCan be [HORIZONTAL, VERTICAL]
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    urlToSharestring
    urlTypeenumCan be [CURRENT, FIXED]
    widthstring

    PopInVideo
    NameTypeDescription
    addBackgroundboolean
    autoPlayboolean
    autoSizeboolean
    closePopinboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    urlstring
    widthstring

    AdBlock
    NameTypeDescription
    actionTypeenumCan be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
    backgroundColorstring
    blockNavigationTypeenumCan be [ALL, OPAQUE, REDIRECT]
    closeWithClickOnOverlayboolean
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    domElementSelectorstring
    fontSizestring
    goalNamestring
    heightstring
    horizontalAlignmentTypeenumCan be [LEFT, CENTER, RIGHT]
    imageImage
    imageTypeenumCan be [NONE, DEFAULT, CUSTOM]
    mainPageUrlstring
    messageContentstring
    messageTitlestring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    positionDefinitionenumCan be [EDITOR, SELECTOR]
    positionSelectorRelativeenumCan be [REPLACE, BEFORE, AFTER]
    redirectURLstring
    shiftContentboolean
    shouldScrollToboolean
    showMessageboolean
    textColorstring
    trackActionboolean
    typeenumCan be [POPIN, STICKY_BLOCK]
    verticalAlignmentTypeenumCan be [TOP, CENTER, BOTTOM]
    widthstring
    withOverlayboolean

    VisitsCounter
    NameTypeDescription
    counterFormatenumCan be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
    counterFromDatedatetime
    counterFromTypeenumCan be [DAY, WEEK, DAYS_15, PRECISE_DATE]
    customPositionAxisXstring
    customPositionAxisYstring
    descriptionTextstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    heightstring
    minimumVisitslong
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring

    NewsLetter
    NameTypeDescription
    backgroundColorstring
    backgroundImageImage
    confirmationTextstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenumCan be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    emailKeystring
    heightstring
    legalNoticeUrlstring
    outsideCloseboolean
    overlayEnabledboolean
    pageUrlstring
    personalizationPluginLocationenumCan be [INSIDE_PAGES, ABOVE_PAGES]
    positionenumCan be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    requestTypeenumCan be [GET, POST]
    timerCloseinteger
    titleEnabledboolean
    typeenumCan be [FORM, SERVICE]
    urlstring
    widthstring

    TrackingTool
    NameTypeDescription
    adobeOmnitureObjectstring
    comScoreCustomerIdstring
    comScoreDomainstring
    customVariableinteger
    eulerianUserCentricParameterstring
    googleAnalyticsTrackerstring
    heatMapPageWidthinteger
    reportingScriptstring
    typeenumCan 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, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    universalAnalyticsDimensioninteger

    Remove personalization

    Example request

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

    DELETE /personalizations/{personalizationId}

    Remove personalization with given id

    Request arguments
    NamePlaceTypeDescription
    personalizationIdpathlongpersonalizationId

    Request personalization's results

    Example request

    curl -X POST \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/personalizations/{personalizationId}/results"
    {
      "allVariationsData" : "false",
      "breakdown" : {
        "type" : "BROWSER"
      },
      "callbackUrl" : "string",
      "dateIntervals" : [ {
        "end" : "2020-07-14T17:06:58.440855",
        "start" : "2020-07-14T17:06:58.440855"
      } ],
      "filters" : [ { } ],
      "interval" : "HOUR",
      "stringForHash" : "string",
      "visitorData" : "false"
    }
    

    POST /personalizations/{personalizationId}/results

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

    Request arguments
    NamePlaceTypeDescription
    personalizationIdpathlongpersonalizationId
    Request body

    DataRequestParams
    NameTypeDescription
    allVariationsDataboolean
    breakdownBreakdown
    callbackUrlstring
    dateIntervalsarray[DateInterval]
    filtersarray[Filter]
    intervalenumCan be [HOUR, DAY, WEEK, MONTH, YEAR]
    stringForHashstring
    visitorDataboolean

    Breakdown
    NameTypeDescription
    typeenumCan be [BROWSER, CUSTOM_DATA, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OPERATING_SYSTEM, PAGE_TITLE, PAGES_VIEWED, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, WORKWEEK_OR_WEEKEND, VISIT_DURATION, BROWSER_LANGUAGE, SKY_CONDITION, DAY_OR_NIGHT, WEATHER_TEMPERATURES, NUMBER_OF_VISITS, REFERRING_WEBSITE_URL, TABS_NUMBER]

    CustomDataBreakdown
    NameTypeDescription
    indexinteger
    typeenumCan be [BROWSER, CUSTOM_DATA, DEVICE_TYPE, NEW_VISITOR, GOAL_REACHED, PAGE_URL, FIRST_REFERRER, ORIGIN_TYPE, OPERATING_SYSTEM, PAGE_TITLE, PAGES_VIEWED, LANDING_PAGE_URL, AD_BLOCKER, DAY_OF_WEEK, WORKWEEK_OR_WEEKEND, VISIT_DURATION, BROWSER_LANGUAGE, SKY_CONDITION, DAY_OR_NIGHT, WEATHER_TEMPERATURES, NUMBER_OF_VISITS, REFERRING_WEBSITE_URL, TABS_NUMBER]

    DateInterval
    NameTypeDescription
    enddatetime
    startdatetime

    DeviceTypeFilter
    NameTypeDescription
    includeboolean
    valuesarrayCan be [DESKTOP, TABLET, PHONE]

    NewVisitorFilter
    NameTypeDescription
    visitorsTypeenumCan be [NEW_VISITORS, RETURNING_VISITORS]

    BrowserFilter
    NameTypeDescription
    includeboolean
    valuesarrayCan be [CHROME, EXPLORER, FIREFOX, SAFARI, OPERA]

    CustomDataFilter
    NameTypeDescription
    customDataIdlong
    includeboolean
    valuestring

    OperatingSystemFilter
    NameTypeDescription
    includeboolean
    valuesarrayCan be [WINDOWS, MAC_OS, LINUX, I_OS]

    Example response

    {
      "dataCode" : "string"
    }
    
    Response body

    The response from the server will be a data code which will be needed to get the actual results whenever they will be ready.

    Response
    NameTypeDescription
    dataCodestring

    Get the personalization's results

    Example request

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

    GET /personalizations/{personalizationId}/results

    This method is used to poll the results when they are ready.

    Request arguments
    NamePlaceTypeDescription
    dataCodequerystringdataCode

    Example response

    {
      "data" : {
        "dataCode" : "string",
        "variationData" : ""
      },
      "status" : "ERROR"
    }
    
    Response body

    Data Response
    NameTypeDescription
    dataDataResult
    statusenumCan be [ERROR, READY, WAITING]

    DataResult
    NameTypeDescription
    dataCodestring
    variationDatamap

    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.

    List custom referrers

    Example request

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

    GET /referrers

    Get list of all referrers

    Example response

    [ {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "priority" : "1234",
      "tags" : "string",
      "detections" : [ {
        "and" : "false",
        "andMethod" : "string",
        "andParameters" : "string",
        "method" : "string",
        "parameters" : "string"
      } ],
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    } ]
    
    Response body

    Referrer
    NameTypeDescription
    idlongThe unique identifier of the given referrer
    indexintegerThe index of the referrer
    namestringThe name of the referrer
    priorityintegerPriority for the given referrer
    tagsstringTags associated with the given referrer
    detectionsarray[ReferrerDetection]
    creationDatedatetimeDate and time referred is created
    modificationDatedatetimeDate and time referred is modified
    siteIdlongUnique site identifier assigned with the referrer

    ReferrerDetection
    NameTypeDescription
    andboolean
    andMethodstring
    andParametersstring
    methodstring
    parametersstring

    Create new referrer

    Example request

    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" : [ {
        "and" : "false",
        "andMethod" : "string",
        "andParameters" : "string",
        "method" : "string",
        "parameters" : "string"
      } ],
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    

    POST /referrers

    Create new referrer with given parameters

    Request body

    Referrer
    NameTypeDescription
    idlongThe unique identifier of the given referrer
    indexintegerThe index of the referrer
    namestringThe name of the referrer
    priorityintegerPriority for the given referrer
    tagsstringTags associated with the given referrer
    detectionsarray[ReferrerDetection]
    creationDatedatetimeDate and time referred is created
    modificationDatedatetimeDate and time referred is modified
    siteIdlongUnique site identifier assigned with the referrer

    ReferrerDetection
    NameTypeDescription
    andboolean
    andMethodstring
    andParametersstring
    methodstring
    parametersstring

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "priority" : "1234",
      "tags" : "string",
      "detections" : [ {
        "and" : "false",
        "andMethod" : "string",
        "andParameters" : "string",
        "method" : "string",
        "parameters" : "string"
      } ],
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    
    Response body

    Referrer
    NameTypeDescription
    idlongThe unique identifier of the given referrer
    indexintegerThe index of the referrer
    namestringThe name of the referrer
    priorityintegerPriority for the given referrer
    tagsstringTags associated with the given referrer
    detectionsarray[ReferrerDetection]
    creationDatedatetimeDate and time referred is created
    modificationDatedatetimeDate and time referred is modified
    siteIdlongUnique site identifier assigned with the referrer

    ReferrerDetection
    NameTypeDescription
    andboolean
    andMethodstring
    andParametersstring
    methodstring
    parametersstring

    Get one referrer

    Example request

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

    GET /referrers/{referrerId}

    Get one referrer with given id

    Request arguments
    NamePlaceTypeDescription
    referrerIdpathlongreferrerId

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "priority" : "1234",
      "tags" : "string",
      "detections" : [ {
        "and" : "false",
        "andMethod" : "string",
        "andParameters" : "string",
        "method" : "string",
        "parameters" : "string"
      } ],
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    
    Response body

    Referrer
    NameTypeDescription
    idlongThe unique identifier of the given referrer
    indexintegerThe index of the referrer
    namestringThe name of the referrer
    priorityintegerPriority for the given referrer
    tagsstringTags associated with the given referrer
    detectionsarray[ReferrerDetection]
    creationDatedatetimeDate and time referred is created
    modificationDatedatetimeDate and time referred is modified
    siteIdlongUnique site identifier assigned with the referrer

    ReferrerDetection
    NameTypeDescription
    andboolean
    andMethodstring
    andParametersstring
    methodstring
    parametersstring

    Update referrer

    Example request

    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" : [ {
        "and" : "false",
        "andMethod" : "string",
        "andParameters" : "string",
        "method" : "string",
        "parameters" : "string"
      } ],
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    

    PUT /referrers/{referrerId}

    Update referrer with given id

    Request arguments
    NamePlaceTypeDescription
    referrerIdpathlongreferrerId
    Request body

    Referrer
    NameTypeDescription
    idlongThe unique identifier of the given referrer
    indexintegerThe index of the referrer
    namestringThe name of the referrer
    priorityintegerPriority for the given referrer
    tagsstringTags associated with the given referrer
    detectionsarray[ReferrerDetection]
    creationDatedatetimeDate and time referred is created
    modificationDatedatetimeDate and time referred is modified
    siteIdlongUnique site identifier assigned with the referrer

    ReferrerDetection
    NameTypeDescription
    andboolean
    andMethodstring
    andParametersstring
    methodstring
    parametersstring

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "name" : "string",
      "priority" : "1234",
      "tags" : "string",
      "detections" : [ {
        "and" : "false",
        "andMethod" : "string",
        "andParameters" : "string",
        "method" : "string",
        "parameters" : "string"
      } ],
      "creationDate" : "2020-07-14T17:06:58.440855",
      "modificationDate" : "2020-07-14T17:06:58.440855",
      "siteId" : "123456789"
    }
    
    Response body

    Referrer
    NameTypeDescription
    idlongThe unique identifier of the given referrer
    indexintegerThe index of the referrer
    namestringThe name of the referrer
    priorityintegerPriority for the given referrer
    tagsstringTags associated with the given referrer
    detectionsarray[ReferrerDetection]
    creationDatedatetimeDate and time referred is created
    modificationDatedatetimeDate and time referred is modified
    siteIdlongUnique site identifier assigned with the referrer

    ReferrerDetection
    NameTypeDescription
    andboolean
    andMethodstring
    andParametersstring
    methodstring
    parametersstring

    Remove referrer

    Example request

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

    DELETE /referrers/{referrerId}

    Remove referrer with given id

    Request arguments
    NamePlaceTypeDescription
    referrerIdpathlongreferrerId

    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.

    List segments

    Example request

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

    GET /segments

    Get list of segments

    Example response

    [ {
      "id" : "123456789",
      "name" : "string",
      "description" : "string",
      "conditionsData" : {
        "firstLevel" : [ {
          "conditions" : [ {
            "id" : "123456789",
            "targetingType" : "PAGE_URL",
            "weight" : "1234"
          } ],
          "orOperators" : [ "[]" ]
        } ],
        "firstLevelOrOperators" : [ "[]" ]
      },
      "siteId" : "123456789",
      "audienceTracking" : "false"
    } ]
    
    Response body

    Segment
    NameTypeDescription
    idlongUnique identifier of segment
    namestringName of segment
    descriptionstringDescription of segment
    conditionsDataConditionsDataConditions by which visitors will be segmented
    siteIdlongUnique identifier of site for which the segment is going to be or was created
    audienceTrackingbooleanSegment is used in audience

    ConditionsData
    NameTypeDescription
    firstLevelarray[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)
    firstLevelOrOperatorsarrayArray of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.

    FirstLevel
    NameTypeDescription
    conditionsarray[TargetingConditionIO]Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.
    orOperatorsarrayArray of booleans ("or"=true, "and"=false) for binding conditions of second level.

    TargetingConditionIO
    NameTypeDescription
    idlongUnique identifier
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    ORIGIN_TYPE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    trafficTypeenumTraffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    DOM_ELEMENT
    NameTypeDescription
    idlongUnique identifier
    elementTypeenumType of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
    elementValuestringElement on the page (id, class, ...) if 'elementType' is SINGLE.
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    SCREEN_DIMENSION
    NameTypeDescription
    idlongUnique identifier
    heightintegerShould be specified if 'heightMatchType' is not 'INCLUDE'
    heightLowerBoundintegerShould be specified if 'heightMatchType' is 'INCLUDE'
    heightMatchTypeenumHow to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
    heightUpperBoundintegerShould be specified if 'heightMatchType' is 'INCLUDE'
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    widthintegerShould be specified if 'widthMatchType' is not 'INCLUDE'
    widthLowerBoundintegerShould be specified if 'widthMatchType' is 'INCLUDE'
    widthMatchTypeenumHow to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
    widthUpperBoundintegerShould be specified if 'widthMatchType' is 'INCLUDE'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    SKY_STATUS
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    skyStatusenumSpecific 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]
    skyStatusGroupenumGroup 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]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    SAME_DAY_VISITS
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
    visitCountintegerNumber of visits for today
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TIME_RANGE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    sincedatetimeSince date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
    todatetimeTo date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    INTERNAL_SEARCH_KEYWORDS
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    keyWordIndexstringValue can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TIME_SINCE_PAGE_LOAD
    NameTypeDescription
    idlongUnique identifier
    countintegerCount of time elapsed since session became active according to the 'unitOfTime' field
    countMatchTypeenumHow to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    unitOfTimeenumWhat unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
    urlstringURL template
    urlMatchTypeenumAccordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    EVENT
    NameTypeDescription
    idlongUnique identifier
    eventstringCustom event
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    NUMBER_OF_VISITED_PAGES
    NameTypeDescription
    idlongUnique identifier
    categorystringProduct category
    countOfPagesintegerAmount of visited pages
    countOfPagesMatchTypeenumHow to match 'countOfPages'. Can be [GREATER, EXACT, LOWER]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    priceMatchTypeenumHow 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]
    priceParamsPriceParamsType of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    HOUR_MINUTE_RANGE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    sincestringSince time. Time format: hh:MM
    tostringTo time. Time format: hh:MM
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    LANDING_PAGE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified url. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    urlstringLanding URL template
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    VISITOR_IP
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    ipstringExact visitor ip address
    ipLowerBoundstringLower 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
    ipUpperBoundstringUpper 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
    secondIpstringSecond exact visitor ip address
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    DAY_NIGHT
    NameTypeDescription
    idlongUnique identifier
    dayPeriodenumCan be [DAY, NIGHT]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    VISITED_PAGES
    NameTypeDescription
    idlongUnique identifier
    countOfPagesintegerAmount of visited pages
    countOfPagesMatchTypeenumHow to match 'countOfPages'. Can be [GREATER, EXACT, LOWER]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    productEanstringPages of which product should be visited?
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    NEW_VISITORS
    NameTypeDescription
    idlongUnique identifier
    visitorsTypeenumCan be [NEW, RETURNING]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    FORECAST_TEMPERATURE
    NameTypeDescription
    idlongUnique identifier
    daysRangeintegerRange of days during which the forecast is expected. This value can't be less than 'forecastDays'
    forecastDaysintegerAmount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
    forecastMatchTypeenumHow to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    lowerBoundValueintegerLower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
    measurementenumDefault value: 'CELSIUS'Can be [CELSIUS, FAHRENHEIT]
    temperatureMatchTypeenumHow to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
    upperBoundValueintegerUpper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
    valueintegerExact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    FORECAST_SKY_STATUS
    NameTypeDescription
    idlongUnique identifier
    daysRangeintegerRange of days during which the forecast is expected. This value can't be less than 'forecastDays'
    forecastDaysintegerAmount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
    forecastMatchTypeenumHow to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    skyStatusenumSpecific 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]
    skyStatusGroupenumGroup 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]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    DEVICE_TYPE
    NameTypeDescription
    idlongUnique identifier
    deviceenumCan be [DESKTOP, TABLET, PHONE]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TEALIUM_AUDIENCE
    NameTypeDescription
    idlongUnique identifier
    audiencesarray[TealiumAudience]List of tealium audiences
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    GEOLOCATION
    NameTypeDescription
    idlongUnique identifier
    citystringVisitor's city
    countrystringVisitor's country
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    regionstringVisitor's region
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    JS_CODE
    NameTypeDescription
    idlongUnique identifier
    appliedenumRun js code after DOM ready or immediate? Default value: DOM_READYCan be [DOM_READY, IMMEDIATE]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    jsCodestringCustom JavaScript condition
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TEALIUM_BADGE
    NameTypeDescription
    idlongUnique identifier
    badgesarray[TealiumBadge]List of tealium badges
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    YSANCE_ATTRIBUT
    NameTypeDescription
    idlongUnique identifier
    attributestringYsance attribute
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    valuestringAttribute value
    valueMatchTypeenumHow to match the specified attribute value. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    COOKIE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    namestringCookie name
    nameMatchTypeenumHow to match the specified cookie name. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
    valuestringCookie value
    valueMatchTypeenumHow to match the specified cookie value. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    YSANCE_SEGMENT
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    segmentsarrayYsance segments
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    DAY_OF_WEEK
    NameTypeDescription
    idlongUnique identifier
    dayenumCan be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    PAGE_TITLE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified title. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    titlestringTitle template
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    HEAT_SLICE
    NameTypeDescription
    idlongUnique identifier
    goalIdlongUnique identifier of a goal
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    keyMomentIdlongUnique identifier of a key moment
    lowerBoundintegerLower bound of the probability in percents. Max value: 100
    upperBoundintegerUpper bound of the probability in percents. Max value: 100
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    BROWSER
    NameTypeDescription
    idlongUnique identifier
    browserenumThe type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    versionstringBrowser version
    versionMatchTypeenumHow to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    PRICE_OF_DISPLAYED_PAGE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    priceMatchTypeenumHow 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]
    priceParamsPriceParamsType of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    PREVIOUS_PAGE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified url. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    urlstringPrevious page URL template
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    KEY_PAGES
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    indexstringValue can be the index of a specific key page. Or 'ANY' to segment visitors by presence of any key page
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    CONVERSIONS
    NameTypeDescription
    idlongUnique identifier
    goalIdlongUnique identifier of a goal. If the fields is not specified then visits during which an any goal was reached will be included or excluded
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    FIRST_VISIT
    NameTypeDescription
    idlongUnique identifier
    countintegerCount of time elapsed since the first visit according to the 'unitOfTime' field
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
    unitOfTimeenumUnit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    PAGE_VIEWS
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified amount of pages. Can be [EQUAL, LOWER, GREATER]
    pageCountintegerNumber of page views
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    ORIGIN
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified url. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    urlstringReferring website URL template
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    BROWSER_LANGUAGE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    languagestringBrowser language code in ISO 639-1
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    EXPERIMENTS
    NameTypeDescription
    idlongUnique identifier
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TEMPERATURE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    lowerBoundValueintegerLower bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
    measurementenumDefault value: 'CELSIUS'Can be [CELSIUS, FAHRENHEIT]
    temperatureMatchTypeenumHow to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
    upperBoundValueintegerUpper bound of temperature. This field must be not null if 'temperatureMatchType' is not 'EQUAL'
    valueintegerExact value of temperature. This field must be not null if 'temperatureMatchType' is 'EQUAL'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    ACTIVE_SESSION
    NameTypeDescription
    idlongUnique identifier
    countintegerCount of time elapsed since session became active according to the 'unitOfTime' field
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
    unitOfTimeenumWhat unit of measurements will be used to define if sessions are active for the required duration. Can be [SECOND, MINUTE, HOUR, DAY]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    AD_BLOCKER
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    OPERATING_SYSTEM
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    osenumCan be [WINDOWS, LINUX, MAC, WINDOWS_PHONE, ANDROID, IOS]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    VISITS_BY_PAGE
    NameTypeDescription
    idlongUnique identifier
    countintegerAmount of visits
    countMatchTypeenumHow to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    periodenumPer what period of time visits should be considered. Can be [VISIT, VISITOR, HOUR, DAY, MONTH]
    urlstringURL template
    urlMatchTypeenumAccordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    INTERESTS
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    interestIndexstringValue can be the index of specific interest. Or 'ANY' to segment visitors by presence of any interest
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    VISITS
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified amount of visits. Can be [EQUAL, LOWER, GREATER]
    visitCountintegerTotal amount of visits
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    CUSTOM_DATUM
    NameTypeDescription
    idlongUnique identifier
    customDataIndexstringValue can be the index of specific custom data. Or 'ANY' to segment visitors by presence of any custom data
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    valuestringValue which was retrieved by specified custom data
    valueMatchTypeenumHow 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]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    MOUSE_OUT
    NameTypeDescription
    idlongUnique identifier
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    CONVERSION_PROBABILITY
    NameTypeDescription
    idlongUnique identifier
    goalIdlongUnique identifier of a goal expected to be converted
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    percentsintegerShould be specified if the value of the field 'probability' is 'GREATER' or 'LOWER'
    percentsLowerBoundintegerShould be specified if the value of the field 'probability' is 'BETWEEN'
    percentsUpperBoundintegerShould be specified if the value of the field 'probability' is 'BETWEEN'
    probabilityenumApproximate 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]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    PAGE_URL
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumAccordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    urlstringURL template
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    REFERRERS
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    indexstringValue can be the index of a specific referrer. Or 'ANY' to segment visitors by presence of any referrer
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TABS_ON_SITE
    NameTypeDescription
    idlongUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified amount of tabs. Can be [EQUAL, LOWER, GREATER]
    tabCountintegerNumber of tabs opened
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    LAST_VISIT
    NameTypeDescription
    idlongUnique identifier
    countintegerCount of time elapsed since the last visit according to the 'unitOfTime' field
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
    unitOfTimeenumUnit of measurements. Can be [MINUTE, HOUR, DAY, WEEK, MONTH]
    targetingTypeenumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    BetweenPriceParams
    NameTypeDescription
    firstPriceCalculationTypeenumCan 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]
    firstValuestringDepending on 'priceCalculationType' here has to be exact price value
    secondPriceCalculationTypeenumCan 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]
    secondValuestringDepending on 'priceCalculationType' here has to be exact price value

    BelongingPriceParams
    NameTypeDescription
    areaOfPriceMatchingenumCan be [ALL_CATALOGUE, SPECIFIC_CATEGORIES, SPECIFIC_PRODUCTS]
    categorystringHas to be specified if 'areaOfPriceMatching' is 'SPECIFIC_CATEGORIES'
    priceCategoryenumCan be [EXPENSIVE, CHEAP]
    productEanstringHas to be specified if 'areaOfPriceMatching' is 'SPECIFIC_PRODUCTS'
    productWayOfCountingenumHow to count 'value'?Can be [PERCENT, COUNTS]
    valueintegerTo which fraction of products the product belongs

    ExactPriceParams
    NameTypeDescription
    priceCalculationTypeenumCan 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]
    valuestringDepending on 'priceCalculationType' here has to be exact price value

    PriceChangeParams
    NameTypeDescription
    changeDurationenumTime range when the price of the product changed. Can be [ONE_WEEK, TWO_WEEKS, ONE_MONTH, SINCE_DATE, BETWEEN_TWO_DATES, DATE_RANGE]
    changeMatchTypeenumHow to match price change. Can be [GREATER, LOWER, EQUAL, BETWEEN]
    firstChangeCurrencyenumCan be [EURO, INITIAL_PRICE, CURRENT_PRICE]
    firstChangeValuedoubleTo this value selected 'changeMatchType' will be applied
    firstDatedatetimeHas to be specified if 'changeDuration' is 'SINCE_DATE', 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
    secondChangeCurrencyenumHas to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'Can be [EURO, INITIAL_PRICE, CURRENT_PRICE]
    secondChangeValuedoubleHas to be specified if 'changeMatchType' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'
    secondDatedatetimeHas to be specified if 'changeDuration' is 'BETWEEN_TWO_DATES' or 'DATE_RANGE'

    TealiumAudience
    NameTypeDescription
    idstringAudience unique identifier
    namestringAudience name

    TealiumBadge
    NameTypeDescription
    idlongBadge unique identifier
    namestringBadge name

    Create a new segment

    Example request

    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" : {
        "firstLevel" : [ {
          "conditions" : [ {
            "id" : "123456789",
            "targetingType" : "PAGE_URL",
            "weight" : "1234"
          } ],
          "orOperators" : [ "[]" ]
        } ],
        "firstLevelOrOperators" : [ "[]" ]
      },
      "siteId" : "123456789",
      "audienceTracking" : "false"
    }
    

    POST /segments

    Create a new segment with given parameters

    Request body

    Segment
    NameTypeDescription
    id
    *read only
    longUnique identifier of segment
    name
    *required
    stringName of segment
    descriptionstringDescription of segment
    conditionsDataConditionsDataConditions by which visitors will be segmented
    siteId
    *required
    longUnique identifier of site for which the segment is going to be or was created
    audienceTrackingbooleanSegment is used in audience

    ConditionsData
    NameTypeDescription
    firstLevelarray[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)
    firstLevelOrOperatorsarrayArray of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.

    FirstLevel
    NameTypeDescription
    conditionsarray[TargetingConditionIO]Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.
    orOperatorsarrayArray of booleans ("or"=true, "and"=false) for binding conditions of second level.

    TargetingConditionIO
    NameTypeDescription
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    ORIGIN_TYPE
    NameTypeDescription
    id
    *read only
    longUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    trafficType
    *required
    enumTraffic type. Can be [SEO, SEM, AFFILIATION, EMAIL, DIRECT]
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    DOM_ELEMENT
    NameTypeDescription
    id
    *read only
    longUnique identifier
    elementType
    *required
    enumType of element on the page. If the field is 'SINGLE' the field 'elementValue' should be specified. Can be [SINGLE, ANY_MODIFIED]
    elementValuestringElement on the page (id, class, ...) if 'elementType' is SINGLE.
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    SCREEN_DIMENSION
    NameTypeDescription
    id
    *read only
    longUnique identifier
    heightintegerShould be specified if 'heightMatchType' is not 'INCLUDE'
    heightLowerBoundintegerShould be specified if 'heightMatchType' is 'INCLUDE'
    heightMatchType
    *required
    enumHow to match the specified height. Can be [INCLUDE, EQUAL, LOWER, GREATER]
    heightUpperBoundintegerShould be specified if 'heightMatchType' is 'INCLUDE'
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    widthintegerShould be specified if 'widthMatchType' is not 'INCLUDE'
    widthLowerBoundintegerShould be specified if 'widthMatchType' is 'INCLUDE'
    widthMatchType
    *required
    enumHow to match the specified width. Can be [INCLUDE, EQUAL, LOWER, GREATER]
    widthUpperBoundintegerShould be specified if 'widthMatchType' is 'INCLUDE'
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    SKY_STATUS
    NameTypeDescription
    id
    *read only
    longUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    skyStatusenumSpecific 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]
    skyStatusGroupenumGroup 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]
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    SAME_DAY_VISITS
    NameTypeDescription
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchType
    *required
    enumHow to match the specified amount of time. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
    visitCountintegerNumber of visits for today
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TIME_RANGE
    NameTypeDescription
    id
    *read only
    longUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    since
    *required
    datetimeSince date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
    to
    *required
    datetimeTo date. Date format in ISO 8601 standard: YYYY-MM-DDThh:mm:ss
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    INTERNAL_SEARCH_KEYWORDS
    NameTypeDescription
    id
    *read only
    longUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    keyWordIndexstringValue can be the index of a specific key word. Or 'ANY' to segment visitors by presence of any key word
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TIME_SINCE_PAGE_LOAD
    NameTypeDescription
    id
    *read only
    longUnique identifier
    count
    *required
    integerCount of time elapsed since session became active according to the 'unitOfTime' field
    countMatchType
    *required
    enumHow to match the specified amount of time. Can be [EQUAL, LOWER, GREATER]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    unitOfTime
    *required
    enumWhat unit of measurements will be used to define time since a page load. Can be [SECOND, MINUTE, HOUR, DAY]
    url
    *required
    stringURL template
    urlMatchTypeenumAccordance between requested URL and URL template. Default value: EXACT. Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    EVENT
    NameTypeDescription
    id
    *read only
    longUnique identifier
    event
    *required
    stringCustom event
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    NUMBER_OF_VISITED_PAGES
    NameTypeDescription
    id
    *read only
    longUnique identifier
    categorystringProduct category
    countOfPagesintegerAmount of visited pages
    countOfPagesMatchTypeenumHow to match 'countOfPages'. Can be [GREATER, EXACT, LOWER]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    priceMatchTypeenumHow 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]
    priceParamsPriceParamsType of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    HOUR_MINUTE_RANGE
    NameTypeDescription
    id
    *read only
    longUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    sincestringSince time. Time format: hh:MM
    tostringTo time. Time format: hh:MM
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    LANDING_PAGE
    NameTypeDescription
    id
    *read only
    longUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified url. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    url
    *required
    stringLanding URL template
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    VISITOR_IP
    NameTypeDescription
    id
    *read only
    longUnique identifier
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    ipstringExact visitor ip address
    ipLowerBoundstringLower 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
    ipUpperBoundstringUpper 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
    secondIpstringSecond exact visitor ip address
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    DAY_NIGHT
    NameTypeDescription
    id
    *read only
    longUnique identifier
    dayPeriod
    *required
    enumCan be [DAY, NIGHT]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    VISITED_PAGES
    NameTypeDescription
    id
    *read only
    longUnique identifier
    countOfPagesintegerAmount of visited pages
    countOfPagesMatchTypeenumHow to match 'countOfPages'. Can be [GREATER, EXACT, LOWER]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    productEanstringPages of which product should be visited?
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    NEW_VISITORS
    NameTypeDescription
    visitorsTypeenumCan be [NEW, RETURNING]
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    FORECAST_TEMPERATURE
    NameTypeDescription
    daysRange
    *required
    integerRange of days during which the forecast is expected. This value can't be less than 'forecastDays'
    forecastDays
    *required
    integerAmount of days which should meet the specified value of temperature. This value can't be more than 'daysRange'
    forecastMatchType
    *required
    enumHow to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    lowerBoundValueintegerLower bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
    measurementenumDefault value: 'CELSIUS'Can be [CELSIUS, FAHRENHEIT]
    temperatureMatchType
    *required
    enumHow to match the specified value of temperature. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL, INCLUDE]
    upperBoundValueintegerUpper bound of temperature. This field must be not null if 'temperatureMatchType' is 'INCLUDE'
    valueintegerExact value of temperature. This field must be not null if 'temperatureMatchType' is not 'INCLUDE'
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    FORECAST_SKY_STATUS
    NameTypeDescription
    daysRange
    *required
    integerRange of days during which the forecast is expected. This value can't be less than 'forecastDays'
    forecastDays
    *required
    integerAmount of days which should meet the specified 'skyStatus' or 'skyStatusGroup'. This value can't be more than 'daysRange'
    forecastMatchType
    *required
    enumHow to match the specified amount of days. Can be [EQUAL, LOWER, GREATER, LOWER_OR_EQUAL, GREATER_OR_EQUAL]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    skyStatusenumSpecific 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]
    skyStatusGroupenumGroup 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]
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    DEVICE_TYPE
    NameTypeDescription
    device
    *required
    enumCan be [DESKTOP, TABLET, PHONE]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TEALIUM_AUDIENCE
    NameTypeDescription
    audiences
    *required
    array[TealiumAudience]List of tealium audiences
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    GEOLOCATION
    NameTypeDescription
    citystringVisitor's city
    countrystringVisitor's country
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    regionstringVisitor's region
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    JS_CODE
    NameTypeDescription
    appliedenumRun js code after DOM ready or immediate? Default value: DOM_READYCan be [DOM_READY, IMMEDIATE]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    jsCode
    *required
    stringCustom JavaScript condition
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    TEALIUM_BADGE
    NameTypeDescription
    badges
    *required
    array[TealiumBadge]List of tealium badges
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    YSANCE_ATTRIBUT
    NameTypeDescription
    attribute
    *required
    stringYsance attribute
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    value
    *required
    stringAttribute value
    valueMatchTypeenumHow to match the specified attribute value. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    COOKIE
    NameTypeDescription
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    name
    *required
    stringCookie name
    nameMatchTypeenumHow to match the specified cookie name. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
    value
    *required
    stringCookie value
    valueMatchTypeenumHow to match the specified cookie value. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION, OPTIONAL]
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    YSANCE_SEGMENT
    NameTypeDescription
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    segments
    *required
    arrayYsance segments
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    DAY_OF_WEEK
    NameTypeDescription
    day
    *required
    enumCan be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    PAGE_TITLE
    NameTypeDescription
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    matchTypeenumHow to match the specified title. Default value: 'EXACT'Can be [EXACT, CONTAINS, REGULAR_EXPRESSION]
    title
    *required
    stringTitle template
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    HEAT_SLICE
    NameTypeDescription
    goalId
    *required
    longUnique identifier of a goal
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    keyMomentId
    *required
    longUnique identifier of a key moment
    lowerBound
    *required
    integerLower bound of the probability in percents. Max value: 100
    upperBound
    *required
    integerUpper bound of the probability in percents. Max value: 100
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    BROWSER
    NameTypeDescription
    browser
    *required
    enumThe type of browser visitors are using. Can be [CHROME, FIREFOX, SAFARI, IE, OPERA]
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    versionstringBrowser version
    versionMatchTypeenumHow to match the specified version of the browser. Default value: 'EQUAL'. Can be [EQUAL, LOWER, GREATER]
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    PRICE_OF_DISPLAYED_PAGE
    NameTypeDescription
    includebooleanShould visitors who match to the condition be included to or excluded from the segment. Default value: 'true'
    priceMatchTypeenumHow 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]
    priceParamsPriceParamsType of params depends on 'priceMatchType' field. 'GREATER', 'LOWER', 'EQUAL' - ExactPriceParams. 'BETWEEN' - BetweenPriceParams. 'BELONG' - BelongingPriceParams. 'INCREASED', 'DECREASED' - PriceChangeParams.
    id
    *read only
    longUnique identifier
    targetingType
    *required
    enumTargeting condition type. According to this field it's necessary to add some additional fields. Can be [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, INTERESTS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, CONVERSION_PROBABILITY, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, EXPERIMENTS, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES]
    weightintegerMore important conditions have greater values. Default value: 1

    PREVIOUS_PAGE
    NameTypeDescription
    includebooleanShould visitors who match to the condit