Skip to main content

Simulate widget

POST 
/templates/simulate/:widgetId

Generate simulation for widget and redirect to simulation page

Request​

Path Parameters

    widgetId int64required

Body

required

    widgetTemplateInput

    object

    required

    Widget template fields.

    displayPluginConfiguration stringrequired
    domElementSelector string
    locales string
    position stringrequired

    Possible values: [INPAGE, ABOVE]

    positionSelectorRelative string
    shadowDom booleanrequired

    surveyDataConfig

    object

    Configuration settings for survey data collection.

    fields

    object[]

    required

  • Array [

    • elementId stringrequired
    id stringrequired
    isDeprecated boolean
    name stringrequired
    parentId string
    valueType stringrequired

    Possible values: [BOOLEAN, NUMBER, STRING, STRING_ARRAY, DATE, TIME]

  • ]

    • isCollectData booleanrequired
    methodTypes string[]required

    Possible values: [KAMELEOON, HTTP_REQUEST, CUSTOM_JS_CODE]

    requestSettings

    object

    headers

    object[]

  • Array [

    • customData

    object

    adobeAnalyticsVariableName string

    Variable name of the Adobe Analytics

    advancedProposedValues string

    Enables to set values for targeting conditions in the form of a JS table

    customEvalCode string

    Custom code that will be executed

    description string

    Description of the custom data

    format string

    Custom data value format

    Possible values: [BOOLEAN, NUMBER, STRING]

    gtmVariableName string

    Variable name of the Google Tag Manager

    isConstant boolean

    Indicates if the custom data is a constant

    isFiltrableVentilable boolean

    Indicates if custom data should be filtered and marked as available for breakdown

    isLearnable boolean

    Indicates if this data should be included in Kameleoon machine learning

    isLocalOnly boolean

    Indicates if the custom data is only stored on the user's device.

    method stringrequired

    Method through which a custom data will be transmitted

    Possible values: [ADOBE_ANALYTICS, CLIENT, CUSTOM_CODE, GTM, SDK, TC, TEALIUM]

    name stringrequired

    Name of the custom data

    siteId int64required

    Id of the project this record belongs

    tags string

    Tags that belong to this record

    tcVariableName string

    Name of the tag commander data layer, if it is selected as a transmission method

    tealiumVariableName string

    Name of the Tealium, if it is selected as a transmission method

    type string

    Custom data type. Custom data can be presented as a single value (UNIQUE), or a list of values (LIST), ​​or a countable list of values (COUNT_LIST)

    Possible values: [COUNT_LIST, LIST, UNIQUE]

    id stringrequired
    name stringrequired
    type stringrequired

    Possible values: [CUSTOM_DATA, CUSTOM_TEXT, LOCAL_STORAGE, COOKIES]

    value stringrequired

  • ]

    • type stringrequired

    Possible values: [GET, POST]

    url stringrequired

    triggerSettings

    object

    required

    type stringrequired

    Possible values: [CLICK, CLOSE, ANSWER]

    value string
    widgetFonts string

Responses​

OK

Schema

    string

Loading...