NAV
  • 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"
    
    

    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.

    Authorization response

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

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

    Using the access_token to access the API

    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

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

    Obtaining authorization from the user

    Initial request URL

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

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

    Redirect URL

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

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

    Obtaining an access_token

    Authorization request

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

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

    Authorization response

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

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

    Using the access_token to access the API

    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.

    Obtaining a refresh_token

    Authorization request

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

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

    Rate Limiting

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

    5 Minute Windows

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

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

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

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

    GET and POST Request Limits

    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

    Filtering, Sorting and Pagination

    There's an opportunity to filter, sort or paginate your data through query parameters

    Let's say you need to use such a filter ( filter=[{"field":"name","operator":"EQUAL","parameters":["User Right Test"]}] )

    It must be sent in the Percent-encoded format ( filter=%5B%7B%22field%22%3A%22name%22%2C%22operator%22%3A%22EQUAL%22%2C%22parameters%22%3A%5B%22User%20Right%20Test%22%5D%7D%5D ) shell curl -H "Authorization: Bearer qwerty123456789" \ "https://api.kameleoon.com//personalizations?page=1&perPage=10&filter=%5B%7B%22field%22%3A%22name%22%2C%22operator%22%3A%22EQUAL%22%2C%22parameters%22%3A%5B%22User%20Right%20Test%22%5D%7D%5D"

    Query parameters
    NameTypeDescription
    pageintegerstart page
    perPageintegernumber of pages
    filterarray[FilteringParameter]filtering parameters
    sortarray[SortingParameter]sorting parameters
    FilteringParameter
    NameTypeDescription
    fieldstringfield you need to filter
    operatorenumoperator you are filtering by. Can be [EQUAL, NOT_EQUAL, LESS, GREATER, LESS_OR_EQUAL, GREATER_OR_EQUAL, LIKE, BETWEEN, IN, NOT_IN, NOT, IS_NULL, IS_NOT_NULL, IS_TRUE, IS_FALSE]
    parametersarrayparameters you are filtering by
    SortingParameter
    NameTypeDescription
    fieldstringfield you need to sort
    directionenumdirection you are filtering by. Can be [ASC, DESC]

    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.

    Partial update a account

    Example request

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

    PATCH /accounts/{accountId}

    Update several fields of a account

    Request arguments
    NamePlaceTypeDescription
    accountIdpathlongaccountId

    Example response

    {
      "id" : "123456789",
      "username" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "email" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "preferredLocale" : "en",
      "imageURL" : "string",
      "isPasswordExpired" : "false",
      "isSuperAdmin" : "false",
      "isOnboardingSeen" : "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 [en, fr, de]
    imageURLstringThe image URL of the user
    isPasswordExpiredbooleanPassword regeneration required
    isSuperAdminboolean
    isOnboardingSeenboolean

    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
    accountIdpathlongThe ID of the account object
    optionalFieldsqueryarrayoptionalFields

    Example response

    {
      "id" : "123456789",
      "username" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "email" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "preferredLocale" : "en",
      "imageURL" : "string",
      "isPasswordExpired" : "false",
      "isSuperAdmin" : "false",
      "isOnboardingSeen" : "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 [en, fr, de]
    imageURLstringThe image URL of the user
    isPasswordExpiredbooleanPassword regeneration required
    isSuperAdminboolean
    isOnboardingSeenboolean

    List of accounts

    Example request

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

    GET /accounts

    Get list of accounts

    Example response

    [ {
      "id" : "123456789",
      "username" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "email" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "preferredLocale" : "en",
      "imageURL" : "string",
      "isPasswordExpired" : "false",
      "isSuperAdmin" : "false",
      "isOnboardingSeen" : "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 [en, fr, de]
    imageURLstringThe image URL of the user
    isPasswordExpiredbooleanPassword regeneration required
    isSuperAdminboolean
    isOnboardingSeenboolean

    Get personal account data

    Example request

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

    GET /accounts/me

    Get personal account data

    Request arguments
    NamePlaceTypeDescription
    optionalFieldsqueryarrayoptionalFields

    Example response

    {
      "id" : "123456789",
      "username" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "email" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "preferredLocale" : "en",
      "imageURL" : "string",
      "isPasswordExpired" : "false",
      "isSuperAdmin" : "false",
      "isOnboardingSeen" : "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 [en, fr, de]
    imageURLstringThe image URL of the user
    isPasswordExpiredbooleanPassword regeneration required
    isSuperAdminboolean
    isOnboardingSeenboolean

    Audiences

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

    Get global audience

    Example request

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

    GET /audiences/global

    Get global statistics for all tracked segments

    Request arguments
    NamePlaceTypeDescription
    siteIdquerylongAudience are calculated for segments configured in audience config for a site
    startDatequerydateAudience will be calculated since the date YYYY-MM-DD
    endDatequerydateAudience will be calculated till the date YYYY-MM-DD
    filtersqueryarrayList of filters to apply on audience results.

    Example response

    {
      "startDateTime" : "2021-08-31T15:14:16.915186",
      "endDateTime" : "2021-08-31T15:14:16.915186",
      "globalStats" : {
        "visits" : "123456789",
        "conversions" : "123456789",
        "convertedVisits" : "123456789",
        "conversionRate" : "132.987",
        "revenue" : "132.987",
        "averageRevenuePerVisit" : "132.987",
        "averageRevenuePerConversion" : "132.987",
        "averageConversionPerVisit" : "132.987",
        "visitsGapTotal" : "132.987",
        "conversionsGapTotal" : "132.987",
        "revenueGapTotal" : "132.987",
        "conversionRateGapTotal" : "132.987",
        "averageRevenuePerConversionGapTotal" : "132.987",
        "conversionRateEvolution" : "132.987",
        "visitsEvolution" : "132.987",
        "revenueEvolution" : "132.987",
        "averageRevenuePerVisitEvolution" : "132.987",
        "averageRevenuePerConversionEvolution" : "132.987"
      },
      "segmentStats" : [ {
        "segmentId" : "123456789",
        "visits" : "123456789",
        "conversions" : "123456789",
        "convertedVisits" : "123456789",
        "conversionRate" : "132.987",
        "revenue" : "132.987",
        "averageRevenuePerVisit" : "132.987",
        "averageRevenuePerConversion" : "132.987",
        "averageConversionPerVisit" : "132.987",
        "conversionRateEvolution" : "132.987",
        "visitsEvolution" : "132.987",
        "revenueEvolution" : "132.987",
        "averageRevenuePerVisitEvolution" : "132.987",
        "averageRevenuePerConversionEvolution" : "132.987",
        "visitsGapTotal" : "132.987",
        "conversionsGapTotal" : "132.987",
        "revenueGapTotal" : "132.987",
        "conversionRateGapTotal" : "132.987",
        "averageRevenuePerConversionGapTotal" : "132.987"
      } ]
    }
    
    Response body

    GlobalAudience
    NameTypeDescription
    startDateTimedatetimeThe inclusive start of the period for which statistics are calculated. YYYY-MM-DDThh:mm:ss
    endDateTimedatetimeThe exclusive end of the period for which statistics are calculated. YYYY-MM-DDThh:mm:ss
    globalStatsGlobalStatsSummed up calculations for all tracked segments
    segmentStatsarray[SegmentStats]Calculations per every segment

    GlobalStats
    NameTypeDescription
    visitslongAmount of tracked visits
    conversionslongAmount of tracked conversions
    convertedVisitslongAmount of tracked converted visits
    conversionRatedoubleHow often visits are being converted. It's being calculated as convertedVisits/visits
    revenuedoubleAmount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
    averageRevenuePerVisitdoublerevenue/visits
    averageRevenuePerConversiondoublerevenue/conversions
    averageConversionPerVisitdoubleconversions/visits
    visitsGapTotaldoublePercentage of the current number of visits to the total one
    conversionsGapTotaldoublePercentage of the current number of conversions to the total one
    revenueGapTotaldoublePercentage of the current revenue to the total one
    conversionRateGapTotaldoublePercentage of the current conversion rate to the total one
    averageRevenuePerConversionGapTotaldoublePercentage of the current average revenue per conversion to the total one
    conversionRateEvolutiondoubleHow much conversion rate for current period changed according to previous period in percents
    visitsEvolutiondoubleHow much amount of visits for current period changed according to previous period in percents
    revenueEvolutiondoubleHow much amount of revenue for current period changed according to previous period in percents
    averageRevenuePerVisitEvolutiondoubleHow much revenue per visit for current period changed according to previous period in percents
    averageRevenuePerConversionEvolutiondoubleHow much revenue per conversion for current period changed according to previous period in percents

    SegmentStats
    NameTypeDescription
    segmentIdlongIdentifier of the segment for which the stats was tracked
    visitslongAmount of tracked visits
    conversionslongAmount of tracked conversions
    convertedVisitslongAmount of tracked converted visits
    conversionRatedoubleHow often visits are being converted. It's being calculated as convertedVisits/visits
    revenuedoubleAmount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
    averageRevenuePerVisitdoublerevenue/visits
    averageRevenuePerConversiondoublerevenue/conversions
    averageConversionPerVisitdoubleconversions/visits
    conversionRateEvolutiondoubleHow much conversion rate for current period changed according to previous period in percents
    visitsEvolutiondoubleHow much amount of visits for current period changed according to previous period in percents
    revenueEvolutiondoubleHow much amount of revenue for current period changed according to previous period in percents
    averageRevenuePerVisitEvolutiondoubleHow much revenue per visit for current period changed according to previous period in percents
    averageRevenuePerConversionEvolutiondoubleHow much revenue per conversion for current period changed according to previous period in percents
    visitsGapTotaldoublePercentage of the current number of visits to the total one
    conversionsGapTotaldoublePercentage of the current number of conversions to the total one
    revenueGapTotaldoublePercentage of the current revenue to the total one
    conversionRateGapTotaldoublePercentage of the current conversion rate to the total one
    averageRevenuePerConversionGapTotaldoublePercentage of the current average revenue per conversion to the total one

    Get detailed audience

    Example request

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

    GET /audiences/detailed

    Get detailed statistics for one segment

    Request arguments
    NamePlaceTypeDescription
    siteIdquerylongSite on which audience is configured
    segmentIdquerylongSegment for which you wish to get statistics
    startDatequerydateAudience will be calculated since the date YYYY-MM-DD
    endDatequerydateAudience will be calculated till the date YYYY-MM-DD

    Example response

    {
      "startDateTime" : "2021-08-31T15:14:16.915186",
      "endDateTime" : "2021-08-31T15:14:16.915186",
      "globalStats" : {
        "visits" : "123456789",
        "conversions" : "123456789",
        "convertedVisits" : "123456789",
        "conversionRate" : "132.987",
        "revenue" : "132.987",
        "averageRevenuePerVisit" : "132.987",
        "averageRevenuePerConversion" : "132.987",
        "averageConversionPerVisit" : "132.987",
        "visitsGapTotal" : "132.987",
        "conversionsGapTotal" : "132.987",
        "revenueGapTotal" : "132.987",
        "conversionRateGapTotal" : "132.987",
        "averageRevenuePerConversionGapTotal" : "132.987",
        "conversionRateEvolution" : "132.987",
        "visitsEvolution" : "132.987",
        "revenueEvolution" : "132.987",
        "averageRevenuePerVisitEvolution" : "132.987",
        "averageRevenuePerConversionEvolution" : "132.987"
      },
      "segmentStats" : {
        "segmentId" : "123456789",
        "visits" : "123456789",
        "conversions" : "123456789",
        "convertedVisits" : "123456789",
        "conversionRate" : "132.987",
        "revenue" : "132.987",
        "averageRevenuePerVisit" : "132.987",
        "averageRevenuePerConversion" : "132.987",
        "averageConversionPerVisit" : "132.987",
        "conversionRateEvolution" : "132.987",
        "visitsEvolution" : "132.987",
        "revenueEvolution" : "132.987",
        "averageRevenuePerVisitEvolution" : "132.987",
        "averageRevenuePerConversionEvolution" : "132.987",
        "visitsGapTotal" : "132.987",
        "conversionsGapTotal" : "132.987",
        "revenueGapTotal" : "132.987",
        "conversionRateGapTotal" : "132.987",
        "averageRevenuePerConversionGapTotal" : "132.987"
      },
      "periodStats" : [ {
        "visits" : "123456789",
        "conversions" : "123456789",
        "convertedVisits" : "123456789",
        "conversionRate" : "132.987",
        "revenue" : "132.987",
        "averageRevenuePerVisit" : "132.987",
        "averageRevenuePerConversion" : "132.987",
        "averageConversionPerVisit" : "132.987",
        "startDateTime" : "2021-08-31T15:14:16.915186",
        "endDateTime" : "2021-08-31T15:14:16.915186"
      } ],
      "breakdownData" : {
        "usualBreakdownStats" : "",
        "customDataStats" : ""
      }
    }
    
    Response body

    DetailedAudience
    NameTypeDescription
    startDateTimedatetimeThe inclusive start of the period for which statistics are calculated. YYYY-MM-DDThh:mm:ss
    endDateTimedatetimeThe exclusive end of the period for which statistics are calculated. YYYY-MM-DDThh:mm:ss
    globalStatsGlobalStatsSummed up calculations for all tracked segments
    segmentStatsSegmentStatsCalculations for the requested segment summed up by the whole picked period
    periodStatsarray[PeriodStats]Calculations separated by day interval
    breakdownDataBreakdownDataFilter audience by segment criteria.

    GlobalStats
    NameTypeDescription
    visitslongAmount of tracked visits
    conversionslongAmount of tracked conversions
    convertedVisitslongAmount of tracked converted visits
    conversionRatedoubleHow often visits are being converted. It's being calculated as convertedVisits/visits
    revenuedoubleAmount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
    averageRevenuePerVisitdoublerevenue/visits
    averageRevenuePerConversiondoublerevenue/conversions
    averageConversionPerVisitdoubleconversions/visits
    visitsGapTotaldoublePercentage of the current number of visits to the total one
    conversionsGapTotaldoublePercentage of the current number of conversions to the total one
    revenueGapTotaldoublePercentage of the current revenue to the total one
    conversionRateGapTotaldoublePercentage of the current conversion rate to the total one
    averageRevenuePerConversionGapTotaldoublePercentage of the current average revenue per conversion to the total one
    conversionRateEvolutiondoubleHow much conversion rate for current period changed according to previous period in percents
    visitsEvolutiondoubleHow much amount of visits for current period changed according to previous period in percents
    revenueEvolutiondoubleHow much amount of revenue for current period changed according to previous period in percents
    averageRevenuePerVisitEvolutiondoubleHow much revenue per visit for current period changed according to previous period in percents
    averageRevenuePerConversionEvolutiondoubleHow much revenue per conversion for current period changed according to previous period in percents

    PeriodStats
    NameTypeDescription
    visitslongAmount of tracked visits
    conversionslongAmount of tracked conversions
    convertedVisitslongAmount of tracked converted visits
    conversionRatedoubleHow often visits are being converted. It's being calculated as convertedVisits/visits
    revenuedoubleAmount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
    averageRevenuePerVisitdoublerevenue/visits
    averageRevenuePerConversiondoublerevenue/conversions
    averageConversionPerVisitdoubleconversions/visits
    startDateTimedatetime
    endDateTimedatetime

    SegmentStats
    NameTypeDescription
    segmentIdlongIdentifier of the segment for which the stats was tracked
    visitslongAmount of tracked visits
    conversionslongAmount of tracked conversions
    convertedVisitslongAmount of tracked converted visits
    conversionRatedoubleHow often visits are being converted. It's being calculated as convertedVisits/visits
    revenuedoubleAmount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
    averageRevenuePerVisitdoublerevenue/visits
    averageRevenuePerConversiondoublerevenue/conversions
    averageConversionPerVisitdoubleconversions/visits
    conversionRateEvolutiondoubleHow much conversion rate for current period changed according to previous period in percents
    visitsEvolutiondoubleHow much amount of visits for current period changed according to previous period in percents
    revenueEvolutiondoubleHow much amount of revenue for current period changed according to previous period in percents
    averageRevenuePerVisitEvolutiondoubleHow much revenue per visit for current period changed according to previous period in percents
    averageRevenuePerConversionEvolutiondoubleHow much revenue per conversion for current period changed according to previous period in percents
    visitsGapTotaldoublePercentage of the current number of visits to the total one
    conversionsGapTotaldoublePercentage of the current number of conversions to the total one
    revenueGapTotaldoublePercentage of the current revenue to the total one
    conversionRateGapTotaldoublePercentage of the current conversion rate to the total one
    averageRevenuePerConversionGapTotaldoublePercentage of the current average revenue per conversion to the total one

    BreakdownData
    NameTypeDescription
    usualBreakdownStatsmap
    customDataStatsmap

    Custom datas

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

    Partial update custom data

    Example request

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

    PATCH /custom-datas/{customDataId}

    Update several fields of custom data

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

    CustomDataUpdate
    NameTypeDescription
    namestringThe name for the given custom data
    isConstantbooleanIndicates whether custom data is a constant
    customEvalCodestringCustom code that will be executed
    isFiltrableVentilablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    learnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    methodstringA method through which a custom data will be transmitted
    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

    Example response

    {
      "id" : "123456789",
      "isConstant" : "false",
      "customEvalCode" : "string",
      "isFiltrableVentilable" : "false",
      "gtmVariableName" : "string",
      "learnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a constant
    customEvalCodestringCustom code that will be executed
    isFiltrableVentilablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    learnablebooleanIndicates 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
    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
    siteIdlongUnique site identifier assigned with the record

    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",
      "isFiltrableVentilable" : "false",
      "gtmVariableName" : "string",
      "learnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    

    PUT /custom-datas/{customDataId}

    Update custom data with given id

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

    CustomData
    NameTypeDescription
    id
    *read only
    longThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a constant
    customEvalCodestringCustom code that will be executed
    isFiltrableVentilablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    learnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    name
    *required
    stringThe name for the given custom data
    methodstringA method through which a custom data will be transmitted
    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
    creationDate
    *read only
    datetimeDate and time a record is created
    modificationDate
    *read only
    datetimeDate and time a record is modified
    siteIdlongUnique site identifier assigned with the record

    Example response

    {
      "id" : "123456789",
      "isConstant" : "false",
      "customEvalCode" : "string",
      "isFiltrableVentilable" : "false",
      "gtmVariableName" : "string",
      "learnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a constant
    customEvalCodestringCustom code that will be executed
    isFiltrableVentilablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    learnablebooleanIndicates 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
    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
    siteIdlongUnique site identifier assigned with the record

    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",
      "isFiltrableVentilable" : "false",
      "gtmVariableName" : "string",
      "learnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a constant
    customEvalCodestringCustom code that will be executed
    isFiltrableVentilablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    learnablebooleanIndicates 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
    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
    siteIdlongUnique site identifier assigned with the record

    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

    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",
      "isFiltrableVentilable" : "false",
      "gtmVariableName" : "string",
      "learnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    } ]
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a constant
    customEvalCodestringCustom code that will be executed
    isFiltrableVentilablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    learnablebooleanIndicates 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
    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
    siteIdlongUnique site identifier assigned with the record

    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",
      "isFiltrableVentilable" : "false",
      "gtmVariableName" : "string",
      "learnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    

    POST /custom-datas

    Create new custom data with given parameters

    Request body

    CustomData
    NameTypeDescription
    id
    *read only
    longThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a constant
    customEvalCodestringCustom code that will be executed
    isFiltrableVentilablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    learnablebooleanIndicates whether this data should be included in Kameleoon machine learning
    isLocalOnlybooleanIndicates whether this data is stored on a user's device only
    name
    *required
    stringThe name for the given custom data
    methodstringA method through which a custom data will be transmitted
    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
    creationDate
    *read only
    datetimeDate and time a record is created
    modificationDate
    *read only
    datetimeDate and time a record is modified
    siteIdlongUnique site identifier assigned with the record

    Example response

    {
      "id" : "123456789",
      "isConstant" : "false",
      "customEvalCode" : "string",
      "isFiltrableVentilable" : "false",
      "gtmVariableName" : "string",
      "learnable" : "false",
      "isLocalOnly" : "false",
      "name" : "string",
      "method" : "string",
      "tcVariableName" : "string",
      "tealiumVariableName" : "string",
      "type" : "string",
      "tags" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    
    Response body

    CustomData
    NameTypeDescription
    idlongThe unique identifier of the given custom data
    isConstantbooleanIndicates whether custom data is a constant
    customEvalCodestringCustom code that will be executed
    isFiltrableVentilablebooleanIndicates whether custom data should be filtered and marked available for a breakdown
    gtmVariableNamestringVariable name of the Google Tag Manager
    learnablebooleanIndicates 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
    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
    siteIdlongUnique site identifier assigned with the record

    Customers

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

    Partial update a customer

    Example request

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

    PATCH /customers/{customerId}

    Update several fields of a customer

    Request arguments
    NamePlaceTypeDescription
    customerIdpathlongcustomerId

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "status" : "ACTIVE",
      "level" : "FREEMIUM",
      "country" : "FRANCE",
      "timeZone" : "string",
      "products" : [ "ABTESTING" ],
      "passwordExpirationPolicy" : "2021-08-31T15:14:16.915186",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "passwordResetPolicy" : "1234",
      "passwordDateResetPolicy" : "2021-08-31T15:14:16.915186"
    }
    
    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 [FREEMIUM, ENTERPRISE, INTERNAL, PARTNER]
    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, ABTESTING_SERVER_SIDE, FEATURE_FLAG]
    passwordExpirationPolicydatetimeThe number of days before password expires
    dateCreateddatetimeDate when the customer was created
    passwordResetPolicyintegerThe number of days after which the password is regenerated
    passwordDateResetPolicydatetimeDate when the password is regenerated

    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
    optionalFieldsqueryarrayoptionalFields

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "status" : "ACTIVE",
      "level" : "FREEMIUM",
      "country" : "FRANCE",
      "timeZone" : "string",
      "products" : [ "ABTESTING" ],
      "passwordExpirationPolicy" : "2021-08-31T15:14:16.915186",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "passwordResetPolicy" : "1234",
      "passwordDateResetPolicy" : "2021-08-31T15:14:16.915186"
    }
    
    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 [FREEMIUM, ENTERPRISE, INTERNAL, PARTNER]
    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, ABTESTING_SERVER_SIDE, FEATURE_FLAG]
    passwordExpirationPolicydatetimeThe number of days before password expires
    dateCreateddatetimeDate when the customer was created
    passwordResetPolicyintegerThe number of days after which the password is regenerated
    passwordDateResetPolicydatetimeDate when the password is regenerated

    Get personal customer data

    Example request

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

    GET /customers/me

    Get personal customer data

    Request arguments
    NamePlaceTypeDescription
    optionalFieldsqueryarrayoptionalFields

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "status" : "ACTIVE",
      "level" : "FREEMIUM",
      "country" : "FRANCE",
      "timeZone" : "string",
      "products" : [ "ABTESTING" ],
      "passwordExpirationPolicy" : "2021-08-31T15:14:16.915186",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "passwordResetPolicy" : "1234",
      "passwordDateResetPolicy" : "2021-08-31T15:14:16.915186"
    }
    
    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 [FREEMIUM, ENTERPRISE, INTERNAL, PARTNER]
    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, ABTESTING_SERVER_SIDE, FEATURE_FLAG]
    passwordExpirationPolicydatetimeThe number of days before password expires
    dateCreateddatetimeDate when the customer was created
    passwordResetPolicyintegerThe number of days after which the password is regenerated
    passwordDateResetPolicydatetimeDate when the password is regenerated

    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

    Request arguments
    NamePlaceTypeDescription
    optionalFieldsqueryarrayoptionalFields

    Example response

    [ {
      "id" : "123456789",
      "siteId" : "123456789",
      "name" : "string",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "type" : "GOOGLE_ANALYTICS",
        "customVariable" : "1234",
        "googleAnalyticsTracker" : "string",
        "universalAnalyticsDimension" : "1234",
        "adobeOmnitureObject" : "string",
        "eulerianUserCentricParameter" : "string",
        "heatMapPageWidth" : "1234",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "reportingScript" : "string"
      } ],
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoalId" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "respoolTime" : "",
      "targetingConfiguration" : "SITE",
      "variationsId" : [ "[]" ],
      "dateModified" : "2021-08-31T15:14:16.915186",
      "dateStarted" : "2021-08-31T15:14:16.915186",
      "dateEnded" : "2021-08-31T15:14:16.915186",
      "dateStatusModified" : "2021-08-31T15:14:16.915186",
      "isArchived" : "false",
      "createdBy" : "123456789",
      "commonCssCode" : "string",
      "commonJavaScriptCode" : "string"
    } ]
    
    Response body

    Experiment
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify an experiment
    siteIdlongThe website id that an experiment belongs to
    namestringThe name of the experiment
    baseURLstring
    typeenum. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    statusstringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoalIdlong
    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%).
    respoolTimemap
    targetingConfigurationenum. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
    variationsIdarrayList of associated variations id for this experiment
    dateModifieddatetime
    dateStarteddatetime
    dateEndeddatetime
    dateStatusModifieddatetime
    isArchivedboolean
    createdBylongAccount id to whom created this experiment
    commonCssCodestringCSS code specific to all variations
    commonJavaScriptCodestringJavaScript code specific to all variations

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    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",
      "siteId" : "123456789",
      "name" : "string",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "type" : "GOOGLE_ANALYTICS",
        "customVariable" : "1234",
        "googleAnalyticsTracker" : "string",
        "universalAnalyticsDimension" : "1234",
        "adobeOmnitureObject" : "string",
        "eulerianUserCentricParameter" : "string",
        "heatMapPageWidth" : "1234",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "reportingScript" : "string"
      } ],
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoalId" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "respoolTime" : "",
      "targetingConfiguration" : "SITE",
      "variationsId" : [ "[]" ],
      "dateModified" : "2021-08-31T15:14:16.915186",
      "dateStarted" : "2021-08-31T15:14:16.915186",
      "dateEnded" : "2021-08-31T15:14:16.915186",
      "dateStatusModified" : "2021-08-31T15:14:16.915186",
      "isArchived" : "false",
      "createdBy" : "123456789",
      "commonCssCode" : "string",
      "commonJavaScriptCode" : "string"
    }
    

    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
    siteId
    *required
    longThe website id that an experiment belongs to
    name
    *required
    stringThe name of the experiment
    baseURLstring
    typeenum. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    status
    *read only
    stringThe status of the given experiment
    dateCreated
    *read only
    datetime
    goalsarray
    targetingSegmentIdlong
    mainGoalIdlong
    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%).
    respoolTimemap
    targetingConfigurationenum. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
    variationsId
    *read only
    arrayList of associated variations id for this experiment
    dateModified
    *read only
    datetime
    dateStarted
    *read only
    datetime
    dateEnded
    *read only
    datetime
    dateStatusModified
    *read only
    datetime
    isArchived
    *read only
    boolean
    createdBy
    *read only
    longAccount id to whom created this experiment
    commonCssCodestringCSS code specific to all variations
    commonJavaScriptCodestringJavaScript code specific to all variations

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    Example response

    {
      "id" : "123456789",
      "siteId" : "123456789",
      "name" : "string",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "type" : "GOOGLE_ANALYTICS",
        "customVariable" : "1234",
        "googleAnalyticsTracker" : "string",
        "universalAnalyticsDimension" : "1234",
        "adobeOmnitureObject" : "string",
        "eulerianUserCentricParameter" : "string",
        "heatMapPageWidth" : "1234",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "reportingScript" : "string"
      } ],
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoalId" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "respoolTime" : "",
      "targetingConfiguration" : "SITE",
      "variationsId" : [ "[]" ],
      "dateModified" : "2021-08-31T15:14:16.915186",
      "dateStarted" : "2021-08-31T15:14:16.915186",
      "dateEnded" : "2021-08-31T15:14:16.915186",
      "dateStatusModified" : "2021-08-31T15:14:16.915186",
      "isArchived" : "false",
      "createdBy" : "123456789",
      "commonCssCode" : "string",
      "commonJavaScriptCode" : "string"
    }
    
    Response body

    Experiment
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify an experiment
    siteIdlongThe website id that an experiment belongs to
    namestringThe name of the experiment
    baseURLstring
    typeenum. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    statusstringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoalIdlong
    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%).
    respoolTimemap
    targetingConfigurationenum. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
    variationsIdarrayList of associated variations id for this experiment
    dateModifieddatetime
    dateStarteddatetime
    dateEndeddatetime
    dateStatusModifieddatetime
    isArchivedboolean
    createdBylongAccount id to whom created this experiment
    commonCssCodestringCSS code specific to all variations
    commonJavaScriptCodestringJavaScript code specific to all variations

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    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"
    {
      "interval" : "HOUR",
      "visitorData" : "false",
      "allVariationsData" : "false",
      "bayesian" : "false",
      "referenceVariationId" : "string",
      "breakdown" : {
        "type" : "BROWSER"
      },
      "goalsIds" : [ "[]" ],
      "filters" : [ {
        "type" : "string"
      } ],
      "dateIntervals" : [ {
        "start" : "2021-08-31T15:14:16.915186",
        "end" : "2021-08-31T15:14:16.915186"
      } ],
      "callbackUrl" : "string",
      "stringForHash" : "string"
    }
    

    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
    intervalenum. Can be [HOUR, DAY, WEEK, MONTH, YEAR]
    visitorDataboolean
    allVariationsDataboolean
    bayesianboolean
    referenceVariationIdstring
    breakdownBreakdown
    goalsIdsarray
    filtersarray[Filter]
    dateIntervalsarray[DateInterval]
    callbackUrlstring
    stringForHashstring

    Filter
    NameTypeDescription
    type
    *required
    string

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

    DateInterval
    NameTypeDescription
    startdatetime
    enddatetime

    DeviceTypeFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [DESKTOP, TABLET, PHONE]
    includeboolean

    TimeSpentFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    PageURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    AdBlockerFilter
    NameTypeDescription
    typestring
    includeboolean

    WeatherFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, ATMOSPHERIC_DISTURBANCES]
    includeboolean

    KeyPageFilter
    NameTypeDescription
    typestring
    includeboolean
    valuesarray

    NumberTabsFilter
    NameTypeDescription
    typestring
    includeboolean
    value
    *required
    integer

    CustomDataFilter
    NameTypeDescription
    typestring
    includeboolean
    customDataId
    *required
    long
    valuestring

    TimeSlotFilter
    NameTypeDescription
    typestring
    includeboolean
    visitorCalendarboolean
    valuesarray

    TargetingSegmentFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NewVisitorFilter
    NameTypeDescription
    typestring
    visitorsTypeenum. Can be [NEW_VISITORS, RETURNING_VISITORS]

    FilterContainer
    NameTypeDescription
    paramenum. Can be [GREATER, LOWER, EQUAL, BETWEEN]
    valueinteger
    unitenum. Can be [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

    PageTitleFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    BrowserFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [CHROME, EXPLORER, FIREFOX, SAFARI, OPERA]
    includeboolean

    FirstReferrerFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NumberVisitsFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    LandingPageURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NumberPagesFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    TemperatureFilter
    NameTypeDescription
    typestring
    includeboolean
    param
    *required
    enum. Can be [GREATER, LOWER, EQUAL, BETWEEN]
    from
    *required
    integer
    tointeger

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

    DayFilter
    NameTypeDescription
    typestring
    includeboolean

    OperatingSystemFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [WINDOWS, MAC_OS, I_OS, LINUX, ANDROID, WINDOWS_PHONE]
    includeboolean

    ReferrerURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    SinceLastVisitFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    TrafficFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [SEO, DIRECT, SEM, EMAIL, AFFILIATION]
    includeboolean

    ConversionsFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    WeekdayFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
    includeboolean
    visitorCalendarboolean

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

    Example response

    {
      "dataCode" : "string"
    }
    
    Response body

    DataCodeResponseIO
    NameTypeDescription
    dataCodestring

    Duplicate an experiment

    Example request

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

    POST /experiments/{experimentId}/clone

    Duplicate an experiment

    Request arguments
    NamePlaceTypeDescription
    experimentIdpathlongexperimentId

    Example response

    {
      "id" : "123456789",
      "siteId" : "123456789",
      "name" : "string",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "type" : "GOOGLE_ANALYTICS",
        "customVariable" : "1234",
        "googleAnalyticsTracker" : "string",
        "universalAnalyticsDimension" : "1234",
        "adobeOmnitureObject" : "string",
        "eulerianUserCentricParameter" : "string",
        "heatMapPageWidth" : "1234",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "reportingScript" : "string"
      } ],
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoalId" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "respoolTime" : "",
      "targetingConfiguration" : "SITE",
      "variationsId" : [ "[]" ],
      "dateModified" : "2021-08-31T15:14:16.915186",
      "dateStarted" : "2021-08-31T15:14:16.915186",
      "dateEnded" : "2021-08-31T15:14:16.915186",
      "dateStatusModified" : "2021-08-31T15:14:16.915186",
      "isArchived" : "false",
      "createdBy" : "123456789",
      "commonCssCode" : "string",
      "commonJavaScriptCode" : "string"
    }
    
    Response body

    Experiment
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify an experiment
    siteIdlongThe website id that an experiment belongs to
    namestringThe name of the experiment
    baseURLstring
    typeenum. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    statusstringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoalIdlong
    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%).
    respoolTimemap
    targetingConfigurationenum. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
    variationsIdarrayList of associated variations id for this experiment
    dateModifieddatetime
    dateStarteddatetime
    dateEndeddatetime
    dateStatusModifieddatetime
    isArchivedboolean
    createdBylongAccount id to whom created this experiment
    commonCssCodestringCSS code specific to all variations
    commonJavaScriptCodestringJavaScript code specific to all variations

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    Partial update an experiment

    Example request

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

    PATCH /experiments/{experimentId}

    Update several fields of an experiment

    Request arguments
    NamePlaceTypeDescription
    experimentIdpathlongexperimentId
    actionquerystringAction to change the status of experiment
    Request body

    ExperimentUpdate
    NameTypeDescription
    namestringThe name of the experiment
    baseURLstring
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    mainGoalIdlongThe main goal id of the experiment
    goalsarray
    targetingSegmentIdlong
    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%).
    respoolTimemap
    targetingConfigurationenum. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
    featureFlagSdkLanguageTypeenum. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    identificationKeystring
    commonCssCodestringCSS code specific to all variations
    commonJavaScriptCodestringJavaScript code specific to all variations

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    Example response

    {
      "id" : "123456789",
      "siteId" : "123456789",
      "name" : "string",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "type" : "GOOGLE_ANALYTICS",
        "customVariable" : "1234",
        "googleAnalyticsTracker" : "string",
        "universalAnalyticsDimension" : "1234",
        "adobeOmnitureObject" : "string",
        "eulerianUserCentricParameter" : "string",
        "heatMapPageWidth" : "1234",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "reportingScript" : "string"
      } ],
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoalId" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "respoolTime" : "",
      "targetingConfiguration" : "SITE",
      "variationsId" : [ "[]" ],
      "dateModified" : "2021-08-31T15:14:16.915186",
      "dateStarted" : "2021-08-31T15:14:16.915186",
      "dateEnded" : "2021-08-31T15:14:16.915186",
      "dateStatusModified" : "2021-08-31T15:14:16.915186",
      "isArchived" : "false",
      "createdBy" : "123456789",
      "commonCssCode" : "string",
      "commonJavaScriptCode" : "string"
    }
    
    Response body

    Experiment
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify an experiment
    siteIdlongThe website id that an experiment belongs to
    namestringThe name of the experiment
    baseURLstring
    typeenum. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    statusstringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoalIdlong
    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%).
    respoolTimemap
    targetingConfigurationenum. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
    variationsIdarrayList of associated variations id for this experiment
    dateModifieddatetime
    dateStarteddatetime
    dateEndeddatetime
    dateStatusModifieddatetime
    isArchivedboolean
    createdBylongAccount id to whom created this experiment
    commonCssCodestringCSS code specific to all variations
    commonJavaScriptCodestringJavaScript code specific to all variations

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    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
    optionalFieldsqueryarrayoptionalFields

    Example response

    {
      "id" : "123456789",
      "siteId" : "123456789",
      "name" : "string",
      "baseURL" : "string",
      "type" : "CLASSIC",
      "description" : "string",
      "tags" : [ "[]" ],
      "trackingTools" : [ {
        "type" : "GOOGLE_ANALYTICS",
        "customVariable" : "1234",
        "googleAnalyticsTracker" : "string",
        "universalAnalyticsDimension" : "1234",
        "adobeOmnitureObject" : "string",
        "eulerianUserCentricParameter" : "string",
        "heatMapPageWidth" : "1234",
        "comScoreCustomerId" : "string",
        "comScoreDomain" : "string",
        "reportingScript" : "string"
      } ],
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "goals" : [ "[]" ],
      "targetingSegmentId" : "123456789",
      "mainGoalId" : "123456789",
      "autoOptimized" : "false",
      "deviations" : "",
      "respoolTime" : "",
      "targetingConfiguration" : "SITE",
      "variationsId" : [ "[]" ],
      "dateModified" : "2021-08-31T15:14:16.915186",
      "dateStarted" : "2021-08-31T15:14:16.915186",
      "dateEnded" : "2021-08-31T15:14:16.915186",
      "dateStatusModified" : "2021-08-31T15:14:16.915186",
      "isArchived" : "false",
      "createdBy" : "123456789",
      "commonCssCode" : "string",
      "commonJavaScriptCode" : "string"
    }
    
    Response body

    Experiment
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify an experiment
    siteIdlongThe website id that an experiment belongs to
    namestringThe name of the experiment
    baseURLstring
    typeenum. Can be [CLASSIC, SERVER_SIDE, DEVELOPER, MVT, HYBRID]
    descriptionstring
    tagsarray
    trackingToolsarray[TrackingTool]
    statusstringThe status of the given experiment
    dateCreateddatetime
    goalsarray
    targetingSegmentIdlong
    mainGoalIdlong
    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%).
    respoolTimemap
    targetingConfigurationenum. Can be [SITE, PAGE, URL, SAVED_TEMPLATE]
    variationsIdarrayList of associated variations id for this experiment
    dateModifieddatetime
    dateStarteddatetime
    dateEndeddatetime
    dateStatusModifieddatetime
    isArchivedboolean
    createdBylongAccount id to whom created this experiment
    commonCssCodestringCSS code specific to all variations
    commonJavaScriptCodestringJavaScript code specific to all variations

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    Remove an experiment

    Example request

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

    DELETE /experiments/{experimentId}

    Remove experiment with given id

    Request arguments
    NamePlaceTypeDescription
    experimentIdpathlongexperimentId

    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" : "2021-08-31T15:14:16.915186",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "commonJavaScriptCode" : "string",
      "commonCssCode" : "string"
    } ]
    
    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
    expositionRatedoubleRate of the feature flag that will be exposed
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenum. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    statusstringThe status of the given feature flag
    dateCreateddatetime
    dateModifieddatetime
    commonJavaScriptCodestring
    commonCssCodestring

    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" : "2021-08-31T15:14:16.915186",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "commonJavaScriptCode" : "string",
      "commonCssCode" : "string"
    }
    

    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
    identificationKey
    *required
    string
    descriptionstring
    tagsarray
    siteId
    *required
    longThe website id that a feature flag belongs to
    expositionRatedoubleRate of the feature flag that will be exposed
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenum. Can 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
    commonJavaScriptCodestring
    commonCssCodestring

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "identificationKey" : "string",
      "description" : "string",
      "tags" : [ "[]" ],
      "siteId" : "123456789",
      "expositionRate" : "132.987",
      "targetingSegmentId" : "123456789",
      "goals" : [ "[]" ],
      "sdkLanguageType" : "ANDROID",
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "commonJavaScriptCode" : "string",
      "commonCssCode" : "string"
    }
    
    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
    expositionRatedoubleRate of the feature flag that will be exposed
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenum. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    statusstringThe status of the given feature flag
    dateCreateddatetime
    dateModifieddatetime
    commonJavaScriptCodestring
    commonCssCodestring

    Request feature flag's results

    Example request

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

    POST /feature-flags/{featureFlagId}/results

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

    Request arguments
    NamePlaceTypeDescription
    featureFlagIdpathlongfeatureFlagId
    Request body

    DataRequestParams
    NameTypeDescription
    intervalenum. Can be [HOUR, DAY, WEEK, MONTH, YEAR]
    visitorDataboolean
    allVariationsDataboolean
    bayesianboolean
    referenceVariationIdstring
    breakdownBreakdown
    goalsIdsarray
    filtersarray[Filter]
    dateIntervalsarray[DateInterval]
    callbackUrlstring
    stringForHashstring

    Filter
    NameTypeDescription
    type
    *required
    string

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

    DateInterval
    NameTypeDescription
    startdatetime
    enddatetime

    DeviceTypeFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [DESKTOP, TABLET, PHONE]
    includeboolean

    TimeSpentFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    PageURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    AdBlockerFilter
    NameTypeDescription
    typestring
    includeboolean

    WeatherFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, ATMOSPHERIC_DISTURBANCES]
    includeboolean

    KeyPageFilter
    NameTypeDescription
    typestring
    includeboolean
    valuesarray

    NumberTabsFilter
    NameTypeDescription
    typestring
    includeboolean
    value
    *required
    integer

    CustomDataFilter
    NameTypeDescription
    typestring
    includeboolean
    customDataId
    *required
    long
    valuestring

    TimeSlotFilter
    NameTypeDescription
    typestring
    includeboolean
    visitorCalendarboolean
    valuesarray

    TargetingSegmentFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NewVisitorFilter
    NameTypeDescription
    typestring
    visitorsTypeenum. Can be [NEW_VISITORS, RETURNING_VISITORS]

    FilterContainer
    NameTypeDescription
    paramenum. Can be [GREATER, LOWER, EQUAL, BETWEEN]
    valueinteger
    unitenum. Can be [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

    PageTitleFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    BrowserFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [CHROME, EXPLORER, FIREFOX, SAFARI, OPERA]
    includeboolean

    FirstReferrerFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NumberVisitsFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    LandingPageURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NumberPagesFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    TemperatureFilter
    NameTypeDescription
    typestring
    includeboolean
    param
    *required
    enum. Can be [GREATER, LOWER, EQUAL, BETWEEN]
    from
    *required
    integer
    tointeger

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

    DayFilter
    NameTypeDescription
    typestring
    includeboolean

    OperatingSystemFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [WINDOWS, MAC_OS, I_OS, LINUX, ANDROID, WINDOWS_PHONE]
    includeboolean

    ReferrerURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    SinceLastVisitFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    TrafficFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [SEO, DIRECT, SEM, EMAIL, AFFILIATION]
    includeboolean

    ConversionsFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    WeekdayFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
    includeboolean
    visitorCalendarboolean

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

    Example response

    {
      "dataCode" : "string"
    }
    
    Response body

    DataCodeResponseIO
    NameTypeDescription
    dataCodestring

    Duplicate a feature flag

    Example request

    curl -X POST \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/feature-flags/{featureFlagId}/clone"
    {
      "id" : "123456789",
      "name" : "string",
      "identificationKey" : "string",
      "description" : "string",
      "tags" : [ "[]" ],
      "siteId" : "123456789",
      "expositionRate" : "132.987",
      "targetingSegmentId" : "123456789",
      "goals" : [ "[]" ],
      "sdkLanguageType" : "ANDROID",
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "commonJavaScriptCode" : "string",
      "commonCssCode" : "string"
    }
    

    POST /feature-flags/{featureFlagId}/clone

    Duplicate a feature flag with given parameters

    Request arguments
    NamePlaceTypeDescription
    featureFlagIdpathlongfeatureFlagId
    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
    identificationKey
    *required
    string
    descriptionstring
    tagsarray
    siteId
    *required
    longThe website id that a feature flag belongs to
    expositionRatedoubleRate of the feature flag that will be exposed
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenum. Can 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
    commonJavaScriptCodestring
    commonCssCodestring

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "identificationKey" : "string",
      "description" : "string",
      "tags" : [ "[]" ],
      "siteId" : "123456789",
      "expositionRate" : "132.987",
      "targetingSegmentId" : "123456789",
      "goals" : [ "[]" ],
      "sdkLanguageType" : "ANDROID",
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "commonJavaScriptCode" : "string",
      "commonCssCode" : "string"
    }
    
    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
    expositionRatedoubleRate of the feature flag that will be exposed
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenum. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    statusstringThe status of the given feature flag
    dateCreateddatetime
    dateModifieddatetime
    commonJavaScriptCodestring
    commonCssCodestring

    Partial update feature flag

    Example request

    curl -X PATCH \
      -H "Authorization: Bearer qwerty123456789" \
      -H "Content-Type: application/json" -d @- \
      "https://api.kameleoon.com/feature-flags/{featureFlagId}"
    {
      "name" : "string",
      "identificationKey" : "string",
      "description" : "string",
      "tags" : [ "[]" ],
      "expositionRate" : "132.987",
      "targetingSegmentId" : "123456789",
      "goals" : [ "[]" ],
      "sdkLanguageType" : "ANDROID"
    }
    

    PATCH /feature-flags/{featureFlagId}

    Update several fields of feature flag

    Request arguments
    NamePlaceTypeDescription
    featureFlagIdpathlongfeatureFlagId
    actionquerystringAction to change the status of feature flag
    Request body

    FeatureFlagUpdate
    NameTypeDescription
    name
    *required
    stringThe name of the feature flag
    identificationKey
    *required
    string
    descriptionstring
    tagsarray
    expositionRatedoubleRate of the feature flag that will be exposed
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenum. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "identificationKey" : "string",
      "description" : "string",
      "tags" : [ "[]" ],
      "siteId" : "123456789",
      "expositionRate" : "132.987",
      "targetingSegmentId" : "123456789",
      "goals" : [ "[]" ],
      "sdkLanguageType" : "ANDROID",
      "status" : "string",
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "commonJavaScriptCode" : "string",
      "commonCssCode" : "string"
    }
    
    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
    expositionRatedoubleRate of the feature flag that will be exposed
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenum. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    statusstringThe status of the given feature flag
    dateCreateddatetime
    dateModifieddatetime
    commonJavaScriptCodestring
    commonCssCodestring

    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" : "2021-08-31T15:14:16.915186",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "commonJavaScriptCode" : "string",
      "commonCssCode" : "string"
    }
    
    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
    expositionRatedoubleRate of the feature flag that will be exposed
    targetingSegmentIdlong
    goalsarray
    sdkLanguageTypeenum. Can be [ANDROID, SWIFT, JAVA, CSHARP, NODEJS, PHP]
    statusstringThe status of the given feature flag
    dateCreateddatetime
    dateModifieddatetime
    commonJavaScriptCodestring
    commonCssCodestring

    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

    Validate a feature flag key

    Example request

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

    GET /feature-flags/{featureFlagId}/validateKey

    Validate a feature flag key

    Request arguments
    NamePlaceTypeDescription
    featureFlagIdpathlongfeatureFlagId
    keyquerystringkey

    Goals

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

    Partial update goal

    Example request

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

    PATCH /goals/{goalId}

    Update several fields of a goal

    Request arguments
    NamePlaceTypeDescription
    goalIdpathlonggoalId
    Request body

    GoalUpdate
    NameTypeDescription
    namestringName of goal
    descriptionstring
    isMainGoalboolean
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenum. Can 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.
    trackingToolsarray. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    tagsarray

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

    AccessToPageGoalParams
    NameTypeDescription
    matchTypeenum. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
    matchStringstring

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenum. Can 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
    numberMatchTypeenum. Can be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ],
      "isActive" : "false",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "tags" : [ "[]" ],
      "isTargetingSegmentMentalist" : "false",
      "createdBy" : "123456789",
      "experimentAmount" : "123456789",
      "personalizationAmount" : "123456789",
      "experiments" : [ "[]" ],
      "personalizations" : [ "[]" ],
      "status" : "ACTIVE"
    }
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenum. Can 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
    trackingToolsarray. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    isActivebooleanDeprecated. Use status instead. Indicates the status of the goal: active or not
    dateModifieddatetime
    tagsarray
    isTargetingSegmentMentalistboolean
    createdBylongAccount id to whom created this experiment
    experimentAmountlongNumber of experiments using this goal. This is an optional field needs to specify in request params.
    personalizationAmountlongNumber of personalizations using this goal. This is an optional field needs to specify in request params.
    experimentsarrayList of experiment ids using this goal. This is an optional field needs to specify in request params.
    personalizationsarrayList of personalization ids using this goal. This is an optional field needs to specify in request params.
    statusenumIndicates the status of the goal: active or inactive. Can be [ACTIVE, INACTIVE]

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

    AccessToPageGoalParams
    NameTypeDescription
    matchTypeenum. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
    matchStringstring

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenum. Can 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
    numberMatchTypeenum. Can 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",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ],
      "isActive" : "false",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "tags" : [ "[]" ],
      "isTargetingSegmentMentalist" : "false",
      "createdBy" : "123456789",
      "experimentAmount" : "123456789",
      "personalizationAmount" : "123456789",
      "experiments" : [ "[]" ],
      "personalizations" : [ "[]" ],
      "status" : "ACTIVE"
    }
    

    PUT /goals/{goalId}

    Update goal with given id

    Request arguments
    NamePlaceTypeDescription
    goalIdpathlonggoalId
    Request body

    Goal
    NameTypeDescription
    id
    *read only
    longUnique identifier of goal
    name
    *required
    stringName of goal
    siteIdlong
    descriptionstring
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenum. Can 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.
    dateCreated
    *read only
    datetime
    trackingToolsarray. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    isActive
    *read only
    booleanDeprecated. Use status instead. Indicates the status of the goal: active or not
    dateModified
    *read only
    datetime
    tagsarray
    isTargetingSegmentMentalist
    *read only
    boolean
    createdBy
    *read only
    longAccount id to whom created this experiment
    experimentAmount
    *read only
    longNumber of experiments using this goal. This is an optional field needs to specify in request params.
    personalizationAmount
    *read only
    longNumber of personalizations using this goal. This is an optional field needs to specify in request params.
    experiments
    *read only
    arrayList of experiment ids using this goal. This is an optional field needs to specify in request params.
    personalizations
    *read only
    arrayList of personalization ids using this goal. This is an optional field needs to specify in request params.
    statusenumIndicates the status of the goal: active or inactive. Can be [ACTIVE, INACTIVE]

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

    AccessToPageGoalParams
    NameTypeDescription
    matchTypeenum. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
    matchStringstring

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenum. Can 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
    numberMatchTypeenum. Can be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ],
      "isActive" : "false",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "tags" : [ "[]" ],
      "isTargetingSegmentMentalist" : "false",
      "createdBy" : "123456789",
      "experimentAmount" : "123456789",
      "personalizationAmount" : "123456789",
      "experiments" : [ "[]" ],
      "personalizations" : [ "[]" ],
      "status" : "ACTIVE"
    }
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenum. Can 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
    trackingToolsarray. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    isActivebooleanDeprecated. Use status instead. Indicates the status of the goal: active or not
    dateModifieddatetime
    tagsarray
    isTargetingSegmentMentalistboolean
    createdBylongAccount id to whom created this experiment
    experimentAmountlongNumber of experiments using this goal. This is an optional field needs to specify in request params.
    personalizationAmountlongNumber of personalizations using this goal. This is an optional field needs to specify in request params.
    experimentsarrayList of experiment ids using this goal. This is an optional field needs to specify in request params.
    personalizationsarrayList of personalization ids using this goal. This is an optional field needs to specify in request params.
    statusenumIndicates the status of the goal: active or inactive. Can be [ACTIVE, INACTIVE]

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

    AccessToPageGoalParams
    NameTypeDescription
    matchTypeenum. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
    matchStringstring

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenum. Can 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
    numberMatchTypeenum. Can 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
    optionalFieldsqueryarrayoptionalFields

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ],
      "isActive" : "false",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "tags" : [ "[]" ],
      "isTargetingSegmentMentalist" : "false",
      "createdBy" : "123456789",
      "experimentAmount" : "123456789",
      "personalizationAmount" : "123456789",
      "experiments" : [ "[]" ],
      "personalizations" : [ "[]" ],
      "status" : "ACTIVE"
    }
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenum. Can 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
    trackingToolsarray. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    isActivebooleanDeprecated. Use status instead. Indicates the status of the goal: active or not
    dateModifieddatetime
    tagsarray
    isTargetingSegmentMentalistboolean
    createdBylongAccount id to whom created this experiment
    experimentAmountlongNumber of experiments using this goal. This is an optional field needs to specify in request params.
    personalizationAmountlongNumber of personalizations using this goal. This is an optional field needs to specify in request params.
    experimentsarrayList of experiment ids using this goal. This is an optional field needs to specify in request params.
    personalizationsarrayList of personalization ids using this goal. This is an optional field needs to specify in request params.
    statusenumIndicates the status of the goal: active or inactive. Can be [ACTIVE, INACTIVE]

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

    AccessToPageGoalParams
    NameTypeDescription
    matchTypeenum. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
    matchStringstring

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenum. Can 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
    numberMatchTypeenum. Can 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

    List goals

    Example request

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

    GET /goals

    Get list of goals

    Request arguments
    NamePlaceTypeDescription
    optionalFieldsqueryarrayoptionalFields

    Example response

    [ {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ],
      "isActive" : "false",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "tags" : [ "[]" ],
      "isTargetingSegmentMentalist" : "false",
      "createdBy" : "123456789",
      "experimentAmount" : "123456789",
      "personalizationAmount" : "123456789",
      "experiments" : [ "[]" ],
      "personalizations" : [ "[]" ],
      "status" : "ACTIVE"
    } ]
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenum. Can 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
    trackingToolsarray. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    isActivebooleanDeprecated. Use status instead. Indicates the status of the goal: active or not
    dateModifieddatetime
    tagsarray
    isTargetingSegmentMentalistboolean
    createdBylongAccount id to whom created this experiment
    experimentAmountlongNumber of experiments using this goal. This is an optional field needs to specify in request params.
    personalizationAmountlongNumber of personalizations using this goal. This is an optional field needs to specify in request params.
    experimentsarrayList of experiment ids using this goal. This is an optional field needs to specify in request params.
    personalizationsarrayList of personalization ids using this goal. This is an optional field needs to specify in request params.
    statusenumIndicates the status of the goal: active or inactive. Can be [ACTIVE, INACTIVE]

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

    AccessToPageGoalParams
    NameTypeDescription
    matchTypeenum. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
    matchStringstring

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenum. Can 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
    numberMatchTypeenum. Can 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",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ],
      "isActive" : "false",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "tags" : [ "[]" ],
      "isTargetingSegmentMentalist" : "false",
      "createdBy" : "123456789",
      "experimentAmount" : "123456789",
      "personalizationAmount" : "123456789",
      "experiments" : [ "[]" ],
      "personalizations" : [ "[]" ],
      "status" : "ACTIVE"
    }
    

    POST /goals

    Create new goal with given parameters

    Request body

    Goal
    NameTypeDescription
    id
    *read only
    longUnique identifier of goal
    name
    *required
    stringName of goal
    siteIdlong
    descriptionstring
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenum. Can 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.
    dateCreated
    *read only
    datetime
    trackingToolsarray. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    isActive
    *read only
    booleanDeprecated. Use status instead. Indicates the status of the goal: active or not
    dateModified
    *read only
    datetime
    tagsarray
    isTargetingSegmentMentalist
    *read only
    boolean
    createdBy
    *read only
    longAccount id to whom created this experiment
    experimentAmount
    *read only
    longNumber of experiments using this goal. This is an optional field needs to specify in request params.
    personalizationAmount
    *read only
    longNumber of personalizations using this goal. This is an optional field needs to specify in request params.
    experiments
    *read only
    arrayList of experiment ids using this goal. This is an optional field needs to specify in request params.
    personalizations
    *read only
    arrayList of personalization ids using this goal. This is an optional field needs to specify in request params.
    statusenumIndicates the status of the goal: active or inactive. Can be [ACTIVE, INACTIVE]

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

    AccessToPageGoalParams
    NameTypeDescription
    matchTypeenum. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
    matchStringstring

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenum. Can 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
    numberMatchTypeenum. Can be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "siteId" : "123456789",
      "description" : "string",
      "mentalistWeight" : "132.987",
      "hasMultipleConversions" : "false",
      "type" : "CLICK",
      "params" : { },
      "dateCreated" : "2021-08-31T15:14:16.915186",
      "trackingTools" : [ "GOOGLE_ANALYTICS" ],
      "isActive" : "false",
      "dateModified" : "2021-08-31T15:14:16.915186",
      "tags" : [ "[]" ],
      "isTargetingSegmentMentalist" : "false",
      "createdBy" : "123456789",
      "experimentAmount" : "123456789",
      "personalizationAmount" : "123456789",
      "experiments" : [ "[]" ],
      "personalizations" : [ "[]" ],
      "status" : "ACTIVE"
    }
    
    Response body

    Goal
    NameTypeDescription
    idlongUnique identifier of goal
    namestringName of goal
    siteIdlong
    descriptionstring
    mentalistWeightdouble
    hasMultipleConversionsboolean
    typeenum. Can 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
    trackingToolsarray. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    isActivebooleanDeprecated. Use status instead. Indicates the status of the goal: active or not
    dateModifieddatetime
    tagsarray
    isTargetingSegmentMentalistboolean
    createdBylongAccount id to whom created this experiment
    experimentAmountlongNumber of experiments using this goal. This is an optional field needs to specify in request params.
    personalizationAmountlongNumber of personalizations using this goal. This is an optional field needs to specify in request params.
    experimentsarrayList of experiment ids using this goal. This is an optional field needs to specify in request params.
    personalizationsarrayList of personalization ids using this goal. This is an optional field needs to specify in request params.
    statusenumIndicates the status of the goal: active or inactive. Can be [ACTIVE, INACTIVE]

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

    AccessToPageGoalParams
    NameTypeDescription
    matchTypeenum. Can be [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]
    matchStringstring

    TimeSpentGoalParams
    NameTypeDescription
    matchTypeenum. Can 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
    numberMatchTypeenum. Can be [MORE_THAN, EQUALS, LESS_THAN]
    numberOfVisitedPagesinteger

    Export goals

    Example request

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

    GET /goals/export

    Export goals depending on specified format

    Request arguments
    NamePlaceTypeDescription
    optionalFieldsqueryarrayoptionalFields

    Interests

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

    Partial update interest

    Example request

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

    PATCH /interests/{interestId}

    Update several fields of interest

    Request arguments
    NamePlaceTypeDescription
    interestIdpathlonginterestId
    Request body

    InterestUpdate
    NameTypeDescription
    namestringThe name of the interest
    specificationsarray[InterestSpecification]

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    indexintegerThe 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",
      "index" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    

    PUT /interests/{interestId}

    Update interest with given id

    Request arguments
    NamePlaceTypeDescription
    interestIdpathlonginterestId
    Request body

    Interest
    NameTypeDescription
    id
    *read only
    longThe unique identifier of the given interest
    index
    *read only
    integerThe index for the given interest
    lastTimeCrawled
    *read only
    longDate and time the interest was crawled by a bot
    name
    *required
    stringThe name of the interest
    creationDate
    *read only
    datetimeDate and time an interest is created
    modificationDate
    *read only
    datetimeDate and time an interest is modified
    specificationsarray[InterestSpecification]
    siteIdlongUnique site identifier assigned with current interest

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    indexintegerThe 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",
      "index" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    indexintegerThe 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

    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",
      "index" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    } ]
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    indexintegerThe 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",
      "index" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    

    POST /interests

    Create new interest with given parameters

    Request body

    Interest
    NameTypeDescription
    id
    *read only
    longThe unique identifier of the given interest
    index
    *read only
    integerThe index for the given interest
    lastTimeCrawled
    *read only
    longDate and time the interest was crawled by a bot
    name
    *required
    stringThe name of the interest
    creationDate
    *read only
    datetimeDate and time an interest is created
    modificationDate
    *read only
    datetimeDate and time an interest is modified
    specificationsarray[InterestSpecification]
    siteIdlongUnique site identifier assigned with current interest

    InterestSpecification
    NameTypeDescription
    methodstring
    parametersstring

    Example response

    {
      "id" : "123456789",
      "index" : "1234",
      "lastTimeCrawled" : "123456789",
      "name" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "specifications" : [ {
        "method" : "string",
        "parameters" : "string"
      } ],
      "siteId" : "123456789"
    }
    
    Response body

    Interest
    NameTypeDescription
    idlongThe unique identifier of the given interest
    indexintegerThe 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

    Key pages

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

    Partial update key page

    Example request

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

    PATCH /key-pages/{keyPageId}

    Update several fields of a key page

    Request arguments
    NamePlaceTypeDescription
    keyPageIdpathlongkeyPageId
    Request body

    KeyPageUpdate
    NameTypeDescription
    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

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given 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",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    

    PUT /key-pages/{keyPageId}

    Update a key page with the given id

    Request arguments
    NamePlaceTypeDescription
    keyPageIdpathlongkeyPageId
    Request body

    KeyPage
    NameTypeDescription
    id
    *read only
    longThe unique identifier of the given key page
    name
    *required
    stringThe 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
    creationDate
    *read only
    datetimeDate and time a key page is created
    modificationDate
    *read only
    datetimeDate and time a key page is modified
    siteIdlongUnique site identifier assigned with the key page

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given 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",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given 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

    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",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    } ]
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given 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",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    

    POST /key-pages

    Create a new key page with the given parameters

    Request body

    KeyPage
    NameTypeDescription
    id
    *read only
    longThe unique identifier of the given key page
    name
    *required
    stringThe 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
    creationDate
    *read only
    datetimeDate and time a key page is created
    modificationDate
    *read only
    datetimeDate and time a key page is modified
    siteIdlongUnique site identifier assigned with the key page

    Example response

    {
      "id" : "123456789",
      "name" : "string",
      "relativeUrlRegExp" : "string",
      "matchType" : "string",
      "totalCount" : "1234",
      "secondMatchType" : "string",
      "creationDate" : "2021-08-31T15:14:16.915186",
      "modificationDate" : "2021-08-31T15:14:16.915186",
      "siteId" : "123456789"
    }
    
    Response body

    KeyPage
    NameTypeDescription
    idlongThe unique identifier of the given 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

    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

    Request arguments
    NamePlaceTypeDescription
    optionalFieldsqueryarrayoptionalFields

    Example response

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

    Personalization
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify a personalization
    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
    mainGoalIdlongMain 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]List of tracking tools
    tagsarrayList of tags
    dateCreateddatetimeDate and time when personalization was created
    dateStarteddatetimeDate and time when personalization was started
    dateEndeddatetimeDate and time when personalization was ended
    descriptionstringThis is description of personalization
    isArchivedbooleanIf true the personalization is archived
    dateModifieddatetimeDate and time when personalization was updated last time
    typeenumType of personalization. Can be [CLASSIC, AUTOPROMO, IA, MAIL]
    createdBylongAccount id to whom created this personalization
    cssCodestringCSS code to add in the page
    javaScriptCodestringJavaScript code to add in the page
    personalizationConfigurationenumPersonalization configuration. Can be [POPIN, STICKY_BLOCK, IMAGE_IN_PAGE, HTML_IN_PAGE, VARIATION, EMAIL, CUSTOM, COUNTDOWN_HEADBAND, GOOGLE_FORM, COOKIE_INFO_BANNER, COOKIE_INFO_BANNER_VARIATION, I_ADVIZE, SOCIAL_BAR, VIDEO_POPIN, AD_BLOCK, INFOBULLE_IN, INFOBULLE_ABOVE, REDIRECT_BANNER, VISITS_COUNTER, NEWS_LETTER, NONE, TEMPLATE]
    iadvizeIAdvizeSettings of an iAdvize chat widget

    IAdvize
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    iAdvizeIdentifierstring
    platformTypeenum. Can be [STANDARD, HIGH_AVAILABILITY]
    iadvizeIdentifierstring

    VisitsCounter
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    descriptionTextstring
    counterFromTypeenum. Can be [DAY, WEEK, DAYS_15, PRECISE_DATE]
    counterFromDatedatetime
    counterFormatenum. Can be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
    minimumVisitslong

    AdBlock
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    redirectURLstring
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    typeenum. Can be [POPIN, STICKY_BLOCK]
    actionTypeenum. Can be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
    imageTypeenum. Can be [NONE, DEFAULT, CUSTOM]
    blockNavigationTypeenum. Can be [ALL, OPAQUE, REDIRECT]
    messageContentstring
    messageTitlestring
    verticalAlignmentTypeenum. Can be [TOP, CENTER, BOTTOM]
    horizontalAlignmentTypeenum. Can be [LEFT, CENTER, RIGHT]
    fontSizestring
    textColorstring
    backgroundColorstring
    imageImage
    showMessageboolean
    withOverlayboolean
    closeWithClickOnOverlayboolean
    shouldScrollToboolean
    shiftContentboolean
    trackActionboolean
    goalNamestring

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

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

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

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    ImageInPage
    NameTypeDescription
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    widthstring
    heightstring
    imageImage
    redirectURLstring
    htmlContentstring

    GoogleForm
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    googleFormURLstring
    withOverlayboolean
    closeWithClickOnOverlayboolean
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring

    SocialBar
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    urlToSharestring
    urlTypeenum. Can be [CURRENT, FIXED]
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    orientationenum. Can be [HORIZONTAL, VERTICAL]
    marginTopstring
    marginBottomstring
    marginLeftstring
    marginRightstring

    NewsLetter
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    titleEnabledboolean
    legalNoticeUrlstring
    backgroundColorstring
    confirmationTextstring
    backgroundImageImage
    typeenum. Can be [FORM, SERVICE]
    requestTypeenum. Can be [GET, POST]
    urlstring
    pageUrlstring
    emailKeystring
    overlayEnabledboolean
    outsideCloseboolean
    timerCloseinteger

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

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

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

    CountDownBanner
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    redirectURLstring
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    textContentstring
    htmlContentstring
    contentTypeenum. Can be [TEXT, HTML]
    yearinteger
    monthinteger
    dayOfMonthinteger
    hourOfDayinteger
    minuteinteger
    secondinteger
    verticalAlignmentTypeenum. Can be [TOP, CENTER, BOTTOM]
    horizontalAlignmentTypeenum. Can be [LEFT, CENTER, RIGHT]
    textColorstring
    backgroundColorstring

    Create new personalization

    Example request

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

    POST /personalizations

    Create new personalization with given parameters

    Request body

    Personalization
    NameTypeDescription
    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
    targetingSegmentIdlongSelected targeting segment
    mainGoalIdlongMain 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
    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
    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]List of tracking tools
    tagsarrayList of tags
    dateCreated
    *read only
    datetimeDate and time when personalization was created
    dateStarted
    *read only
    datetimeDate and time when personalization was started
    dateEnded
    *read only
    datetimeDate and time when personalization was ended
    descriptionstringThis is description of personalization
    isArchivedbooleanIf true the personalization is archived
    dateModified
    *read only
    datetimeDate and time when personalization was updated last time
    typeenumType of personalization. Can be [CLASSIC, AUTOPROMO, IA, MAIL]
    createdBy
    *read only
    longAccount id to whom created this personalization
    cssCodestringCSS code to add in the page
    javaScriptCodestringJavaScript code to add in the page
    personalizationConfigurationenumPersonalization configuration. Can be [POPIN, STICKY_BLOCK, IMAGE_IN_PAGE, HTML_IN_PAGE, VARIATION, EMAIL, CUSTOM, COUNTDOWN_HEADBAND, GOOGLE_FORM, COOKIE_INFO_BANNER, COOKIE_INFO_BANNER_VARIATION, I_ADVIZE, SOCIAL_BAR, VIDEO_POPIN, AD_BLOCK, INFOBULLE_IN, INFOBULLE_ABOVE, REDIRECT_BANNER, VISITS_COUNTER, NEWS_LETTER, NONE, TEMPLATE]
    iadvizeIAdvizeSettings of an iAdvize chat widget

    IAdvize
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    iAdvizeIdentifierstring
    platformTypeenum. Can be [STANDARD, HIGH_AVAILABILITY]
    iadvizeIdentifierstring

    VisitsCounter
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    descriptionTextstring
    counterFromTypeenum. Can be [DAY, WEEK, DAYS_15, PRECISE_DATE]
    counterFromDatedatetime
    counterFormatenum. Can be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
    minimumVisitslong

    AdBlock
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    redirectURLstring
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    typeenum. Can be [POPIN, STICKY_BLOCK]
    actionTypeenum. Can be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
    imageTypeenum. Can be [NONE, DEFAULT, CUSTOM]
    blockNavigationTypeenum. Can be [ALL, OPAQUE, REDIRECT]
    messageContentstring
    messageTitlestring
    verticalAlignmentTypeenum. Can be [TOP, CENTER, BOTTOM]
    horizontalAlignmentTypeenum. Can be [LEFT, CENTER, RIGHT]
    fontSizestring
    textColorstring
    backgroundColorstring
    imageImage
    showMessageboolean
    withOverlayboolean
    closeWithClickOnOverlayboolean
    shouldScrollToboolean
    shiftContentboolean
    trackActionboolean
    goalNamestring

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

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

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

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    ImageInPage
    NameTypeDescription
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    widthstring
    heightstring
    imageImage
    redirectURLstring
    htmlContentstring

    GoogleForm
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    googleFormURLstring
    withOverlayboolean
    closeWithClickOnOverlayboolean
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring

    SocialBar
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    urlToSharestring
    urlTypeenum. Can be [CURRENT, FIXED]
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    orientationenum. Can be [HORIZONTAL, VERTICAL]
    marginTopstring
    marginBottomstring
    marginLeftstring
    marginRightstring

    NewsLetter
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    titleEnabledboolean
    legalNoticeUrlstring
    backgroundColorstring
    confirmationTextstring
    backgroundImageImage
    typeenum. Can be [FORM, SERVICE]
    requestTypeenum. Can be [GET, POST]
    urlstring
    pageUrlstring
    emailKeystring
    overlayEnabledboolean
    outsideCloseboolean
    timerCloseinteger

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

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

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

    CountDownBanner
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    redirectURLstring
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    textContentstring
    htmlContentstring
    contentTypeenum. Can be [TEXT, HTML]
    yearinteger
    monthinteger
    dayOfMonthinteger
    hourOfDayinteger
    minuteinteger
    secondinteger
    verticalAlignmentTypeenum. Can be [TOP, CENTER, BOTTOM]
    horizontalAlignmentTypeenum. Can be [LEFT, CENTER, RIGHT]
    textColorstring
    backgroundColorstring

    Example response

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

    Personalization
    NameTypeDescription
    idlongThis field is generated by the system to uniquely identify a personalization
    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
    mainGoalIdlongMain 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]List of tracking tools
    tagsarrayList of tags
    dateCreateddatetimeDate and time when personalization was created
    dateStarteddatetimeDate and time when personalization was started
    dateEndeddatetimeDate and time when personalization was ended
    descriptionstringThis is description of personalization
    isArchivedbooleanIf true the personalization is archived
    dateModifieddatetimeDate and time when personalization was updated last time
    typeenumType of personalization. Can be [CLASSIC, AUTOPROMO, IA, MAIL]
    createdBylongAccount id to whom created this personalization
    cssCodestringCSS code to add in the page
    javaScriptCodestringJavaScript code to add in the page
    personalizationConfigurationenumPersonalization configuration. Can be [POPIN, STICKY_BLOCK, IMAGE_IN_PAGE, HTML_IN_PAGE, VARIATION, EMAIL, CUSTOM, COUNTDOWN_HEADBAND, GOOGLE_FORM, COOKIE_INFO_BANNER, COOKIE_INFO_BANNER_VARIATION, I_ADVIZE, SOCIAL_BAR, VIDEO_POPIN, AD_BLOCK, INFOBULLE_IN, INFOBULLE_ABOVE, REDIRECT_BANNER, VISITS_COUNTER, NEWS_LETTER, NONE, TEMPLATE]
    iadvizeIAdvizeSettings of an iAdvize chat widget

    IAdvize
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    iAdvizeIdentifierstring
    platformTypeenum. Can be [STANDARD, HIGH_AVAILABILITY]
    iadvizeIdentifierstring

    VisitsCounter
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    descriptionTextstring
    counterFromTypeenum. Can be [DAY, WEEK, DAYS_15, PRECISE_DATE]
    counterFromDatedatetime
    counterFormatenum. Can be [FRENCH, ENGLISH, GERMAN, FRENCH_ABBREVIATED, ENGLISH_ABBREVIATED, GERMAN_ABBREVIATED]
    minimumVisitslong

    AdBlock
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    redirectURLstring
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    typeenum. Can be [POPIN, STICKY_BLOCK]
    actionTypeenum. Can be [SHOW_MESSAGE, BLOCK_NAVIGATION, TRACK_ACTION]
    imageTypeenum. Can be [NONE, DEFAULT, CUSTOM]
    blockNavigationTypeenum. Can be [ALL, OPAQUE, REDIRECT]
    messageContentstring
    messageTitlestring
    verticalAlignmentTypeenum. Can be [TOP, CENTER, BOTTOM]
    horizontalAlignmentTypeenum. Can be [LEFT, CENTER, RIGHT]
    fontSizestring
    textColorstring
    backgroundColorstring
    imageImage
    showMessageboolean
    withOverlayboolean
    closeWithClickOnOverlayboolean
    shouldScrollToboolean
    shiftContentboolean
    trackActionboolean
    goalNamestring

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

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

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

    TrackingTool
    NameTypeDescription
    typeenum. Can be [GOOGLE_ANALYTICS, UNIVERSAL_ANALYTICS, ECONDA, AT_INTERNET, SMART_TAG, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, HEATMAP, KISS_METRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, MANDRILL, MAILPERFORMANCE, SMARTFOCUS, MAILJET, MAILUP, EMARSYS, EXPERT_SENDER, TAG_COMMANDER, GOOGLE_TAG_MANAGER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATION, HEAP, SEGMENT, MIXPANEL, IABTCF, KAMELEOON_TRACKING, CUSTOM_TRACKING]
    customVariableinteger
    googleAnalyticsTrackerstring
    universalAnalyticsDimensioninteger
    adobeOmnitureObjectstring
    eulerianUserCentricParameterstring
    heatMapPageWidthinteger
    comScoreCustomerIdstring
    comScoreDomainstring
    reportingScriptstring

    ImageInPage
    NameTypeDescription
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    widthstring
    heightstring
    imageImage
    redirectURLstring
    htmlContentstring

    GoogleForm
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    googleFormURLstring
    withOverlayboolean
    closeWithClickOnOverlayboolean
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring

    SocialBar
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    urlToSharestring
    urlTypeenum. Can be [CURRENT, FIXED]
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    orientationenum. Can be [HORIZONTAL, VERTICAL]
    marginTopstring
    marginBottomstring
    marginLeftstring
    marginRightstring

    NewsLetter
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    titleEnabledboolean
    legalNoticeUrlstring
    backgroundColorstring
    confirmationTextstring
    backgroundImageImage
    typeenum. Can be [FORM, SERVICE]
    requestTypeenum. Can be [GET, POST]
    urlstring
    pageUrlstring
    emailKeystring
    overlayEnabledboolean
    outsideCloseboolean
    timerCloseinteger

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

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

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

    CountDownBanner
    NameTypeDescription
    positionenum. Can be [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]
    widthstring
    heightstring
    customPositionAxisXstring
    customPositionAxisYstring
    displayPluginConfigurationenum. Can be [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]
    personalizationPluginLocationenum. Can be [INSIDE_PAGES, ABOVE_PAGES]
    redirectURLstring
    positionDefinitionenum. Can be [EDITOR, SELECTOR]
    domElementSelectorstring
    positionSelectorRelativeenum. Can be [REPLACE, BEFORE, AFTER]
    mainPageUrlstring
    textContentstring
    htmlContentstring
    contentTypeenum. Can be [TEXT, HTML]
    yearinteger
    monthinteger
    dayOfMonthinteger
    hourOfDayinteger
    minuteinteger
    secondinteger
    verticalAlignmentTypeenum. Can be [TOP, CENTER, BOTTOM]
    horizontalAlignmentTypeenum. Can be [LEFT, CENTER, RIGHT]
    textColorstring
    backgroundColorstring

    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"
    {
      "interval" : "HOUR",
      "visitorData" : "false",
      "allVariationsData" : "false",
      "bayesian" : "false",
      "referenceVariationId" : "string",
      "breakdown" : {
        "type" : "BROWSER"
      },
      "goalsIds" : [ "[]" ],
      "filters" : [ {
        "type" : "string"
      } ],
      "dateIntervals" : [ {
        "start" : "2021-08-31T15:14:16.915186",
        "end" : "2021-08-31T15:14:16.915186"
      } ],
      "callbackUrl" : "string",
      "stringForHash" : "string"
    }
    

    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
    intervalenum. Can be [HOUR, DAY, WEEK, MONTH, YEAR]
    visitorDataboolean
    allVariationsDataboolean
    bayesianboolean
    referenceVariationIdstring
    breakdownBreakdown
    goalsIdsarray
    filtersarray[Filter]
    dateIntervalsarray[DateInterval]
    callbackUrlstring
    stringForHashstring

    Filter
    NameTypeDescription
    type
    *required
    string

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

    DateInterval
    NameTypeDescription
    startdatetime
    enddatetime

    DeviceTypeFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [DESKTOP, TABLET, PHONE]
    includeboolean

    TimeSpentFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    PageURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    AdBlockerFilter
    NameTypeDescription
    typestring
    includeboolean

    WeatherFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, ATMOSPHERIC_DISTURBANCES]
    includeboolean

    KeyPageFilter
    NameTypeDescription
    typestring
    includeboolean
    valuesarray

    NumberTabsFilter
    NameTypeDescription
    typestring
    includeboolean
    value
    *required
    integer

    CustomDataFilter
    NameTypeDescription
    typestring
    includeboolean
    customDataId
    *required
    long
    valuestring

    TimeSlotFilter
    NameTypeDescription
    typestring
    includeboolean
    visitorCalendarboolean
    valuesarray

    TargetingSegmentFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NewVisitorFilter
    NameTypeDescription
    typestring
    visitorsTypeenum. Can be [NEW_VISITORS, RETURNING_VISITORS]

    FilterContainer
    NameTypeDescription
    paramenum. Can be [GREATER, LOWER, EQUAL, BETWEEN]
    valueinteger
    unitenum. Can be [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

    PageTitleFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    BrowserFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [CHROME, EXPLORER, FIREFOX, SAFARI, OPERA]
    includeboolean

    FirstReferrerFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NumberVisitsFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    LandingPageURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    NumberPagesFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    TemperatureFilter
    NameTypeDescription
    typestring
    includeboolean
    param
    *required
    enum. Can be [GREATER, LOWER, EQUAL, BETWEEN]
    from
    *required
    integer
    tointeger

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

    DayFilter
    NameTypeDescription
    typestring
    includeboolean

    OperatingSystemFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [WINDOWS, MAC_OS, I_OS, LINUX, ANDROID, WINDOWS_PHONE]
    includeboolean

    ReferrerURLFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    SinceLastVisitFilter
    NameTypeDescription
    typestring
    values
    *required
    array[FilterContainer]
    includeboolean

    TrafficFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [SEO, DIRECT, SEM, EMAIL, AFFILIATION]
    includeboolean

    ConversionsFilter
    NameTypeDescription
    typestring
    values
    *required
    array
    includeboolean

    WeekdayFilter
    NameTypeDescription
    typestring
    values
    *required
    array. Can be [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
    includeboolean
    visitorCalendarboolean

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

    Example response

    {
      "dataCode" : "string"
    }
    
    Response body

    DataCodeResponseIO
    NameTypeDescription
    dataCodestring

    Duplicate a personalization

    Example request

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

    POST /personalizations/{personalizationId}/clone

    Duplicate a personalization

    Request arguments
    NamePlaceTypeDescription
    personalizationIdpathlongpersonalizationId

    Example response

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