Skip to main content

Search variations

POST 
/variations/search

Search variations with given parameters

Request​

Body

required

    filter

    object

    oneOf

    field string
    operator string

    Possible values: [EQUAL, NOT_EQUAL, LESS, GREATER, LESS_OR_EQUAL, GREATER_OR_EQUAL, LIKE, NOT_LIKE, BETWEEN, IN, NOT_IN, NOT, IS_NULL, IS_NOT_NULL, IS_TRUE, IS_FALSE, IS_EMPTY, IS_NOT_EMPTY, CONTAINS]

    parameters object[]
    page int32

    Page number

    perPage int32

    Number of items per page

    sort

    object[]

    Sorting parameters

  • Array [

    • direction string

    Sorting direction

    Possible values: [ASC, DESC]

    field string

    Sorting field name

  • ]

Responses​

OK

Schema

  • Array [

    • color int32

    Variation color displayed in the editor

    cssCode string

    Code editor css code for variation

    customJson string

    Custom JSON for this variation

    experimentId int64

    Id of the experiment this variation belongs to

    expositionFrequencyDelaySecondsBetweenTwoExpositions int64

    Delay in seconds between two exposures

    expositionFrequencySameVisit int32

    Frequency of exposure during the same visit

    expositionFrequencySameVisitor int32

    Frequency of the exposure for the same visitor

    expositionFrequencySameVisitorDelaySeconds int64

    Delay in seconds between exposure for the same visitor

    forceNoFlicker boolean
    id int64

    Unique Id of the variation

    isJsCodeAfterDomReady boolean

    Set to true (which is also the default value) if the code is applied once the DOM is ready.

    jsCode string

    Code editor javascript code for variation

    name stringrequired

    Name of the variation

    personalizationId int64

    Id of the personalization this variation belongs to

    prompt

    object

    Object used to define an autorun message in the variation. Triggers the creation of a message of type autorun if valid

    promptSource string

    Internal tracking value for analytics or partner attribution

    textInput stringrequired

    The actual prompt content to be sent and executed by Electra

    redirection

    object

    Redirection parameters of a variation

    includeQueryParameters boolean

    In case of global redirection, option to include query parameters from the original url

    parameters string

    Parameters used for the redirection, in case of parameter redirection

    Example: param1=foo&param2=bar
    type string

    Type of the redirection

    Possible values: [GLOBAL_REDIRECTION, PARAMETER_REDIRECTION]

    url string

    URL used for the redirection, in case of global redirection

    Example: www.kameleoon.com
    redirectionStrings stringdeprecated

    Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead

    shadowDom boolean

    ShadowDOM option

    siteId int64required

    Site Id of the project the variation belongs to

    widgetTemplateInput string

    Widget template input data in JSON format.

  • ]

Loading...