Skip to main content

Get one template

GET 
/templates/:templateId

Get one template with the given id

Request​

Path Parameters

    templateId int64required

Query Parameters

    optionalFields string[]

Responses​

OK

Schema

    config string

    Widget editor configuration field linked to the translation locales field in JSON format.

    cssCode string

    UI CSS script that is associated with this template.

    dateActivated date-time

    Timestamp of when a record is activated.

    dateCreated date-time

    Timestamp of when a record is created.

    dateModified date-time

    Timestamp of when a record is modified.

    description string

    Description of template.

    htmlCode string

    UI Html markup text that is associated with this template.

    id int64

    Unique identifier of the given template.

    isCustomTemplate boolean

    Boolean value of is custom template.

    name string

    Name for the given template.

    siteId int64required

    Website id of the studio template.

    status string

    Template status.

    Possible values: [DRAFT, ACTIVE, PAUSED]

    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

    List of custom data using this goal

    adobeAnalyticsVariableName string

    Variable name of the Adobe Analytics

    advancedProposedValues string

    Enables the selection of custom data values for targeting conditions by displaying them in a select box rather than a simple text field.

    createdById int64

    Account Id of the creator of the custom data

    customEvalCode string

    Custom code that will be executed

    dateCreated date-time

    Date and time a record is created

    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

    id int64

    Unique Id of the custom data.

    index int32
    isConstant boolean

    Indicates whether the custom data is a constant

    isFiltrableVentilable boolean

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

    isLearnable boolean

    Indicates whether this data should be included in Kameleoon machine learning

    isLocalOnly boolean

    Indicates whether the 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]

    modificationDate date-time

    Date and time a record is modified

    name stringrequired

    Name of the given custom data

    siteCode string

    System generated code to uniquely identify a website.
    This is an optional field needs to specify in request params.

    siteId int64required

    Unique project identifier assigned to the record

    tags string

    Field to store tags that are associated with this record

    tcVariableName string

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

    tealiumVariableName string

    Name for 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

  • ]

    • name stringrequired
    type stringrequired

    Possible values: [GET, POST]

    url stringrequired

    triggerSettings

    object

    required

    type stringrequired

    Possible values: [CLICK, CLOSE, ANSWER]

    value string
    tags string[]

    Field to store tags that are associated with this template.

    templateCssCode string

    Template CSS script that is associated with this template.

    templateHtmlCode string

    Template HTML markup that is associated with this template.

    templateJavaScriptCode string

    Template JavaScript code that is associated with this template.

    type string

    Type of template.

    Possible values: [TEMPLATE, EDITOR]

    url string

    Url associated with this template.

    useCustomData boolean

    Boolean value to indicate if custom data is being used.

    widgetEditorTemplate string

    Widget editor code that is associated with this template.

Loading...