Skip to main content

Get all personalizations

GET 
/personalizations

Get list of all personalizations

Request​

Query Parameters

    paramsIO objectrequired
    optionalFields string[]

Responses​

OK

Schema

  • Array [

    • cappingPerVisitorConvertGoal boolean

    If true, cease exposing the same visitor when the goal is reached

    cappingPerVisitorExposedVisits boolean

    If true, cease exposing the same visitor when the number of visits exceeds this limit

    cappingPerVisitorExpositions boolean

    If true, cease exposing the same visitor when total exposures exceed this limit.

    cappingPerVisitorGoalId int64

    Cease exposing the same visitor when the goal with this Id is reached

    category string
    checkConditionsRule string

    Kameleoon’s behavior in determining whether a visitor is targeted or not.

    Possible values: [ALL_CONDITIONS, CUMULATIVE_WEIGHT]

    collectingDataEnabled boolean
    createdBy int64

    Account Id of the creator of this personalization

    cssCode string

    CSS script to be integrated into the source code of the page

    customExpositionRate double

    Percentage of the segment exposed to a personalization

    dateCollectingDataStopped date-time

    Timestamp of last data collection

    dateCreated date-time

    Timestamp of when personalization was created

    dateEnded date-time

    Timestamp of when personalization was ceased

    dateModified date-time

    Date and time when personalization was updated last time

    dateStarted date-time

    Timestamp of when personalization was started

    dateStatusModified date-time

    Timestamp of the last update

    description string

    Description of the personalization

    exposedVisitsSameVisitorMax int32

    Cease exposing the same visitor when the number of visits exceed this limit

    expositionFrequencyDelay int64

    Frequency of exposure time for different visitors

    format string
    globalCappingGoalId int64

    Threshold goal for the total number of exposed visitors

    globalCappingNumberVisitors boolean

    Option to allow capping visitors for a configuration

    globalCappingVisitorsConfig string

    Visitors configuration for the capped number of exposed visitors

    Possible values: [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]

    goals int64[]

    Selected goals

    id int64

    System-generated field to uniquely identify a personalization

    imageInPage

    object

    Settings of an image in page

    domElementSelector string
    height string
    htmlContent string

    image

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    mainPageUrl string
    positionDefinition string

    Possible values: [EDITOR, SELECTOR]

    positionSelectorRelative string

    Possible values: [REPLACE, BEFORE, AFTER, NULL]

    redirectURL string
    width string
    isArchived boolean

    If true, the personalization is archived

    javaScriptCode string

    JavaScript code to add in the page

    location string
    mainGoalId int64

    Main goal

    market string
    maxNumberVisitorsExposed int64

    Limit of the total number of exposed visitors

    metaReadOnly string

    Personalization in READ_ONLY mode for sub-personalization

    multiExpositionFrequencyDelay int64

    Minimum delay between each exposure

    name stringrequired

    Name of the personalization

    personalizationConfiguration string

    Personalization configuration

    Possible values: [CUSTOM, HTML_IN_PAGE, IMAGE_IN_PAGE, INFOBULLE_ABOVE, NEWS_LETTER, NONE, POPIN, STICKY_BLOCK, TEMPLATE, VARIATION]

    popIn

    object

    Pop-In settings

    animationDirection string

    Possible values: [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]

    animationTrigger string

    Possible values: [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]

    animationType string

    Possible values: [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]

    backgroundColor string
    closeWithClickOnOverlay boolean
    customPositionAxisX string
    customPositionAxisY string
    displayImageConfiguration string

    Possible values: [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]

    fontSize string
    height string
    heightImageDesktop string
    heightImageMobile string
    heightImageTablet string
    htmlContent string
    idTarget2Sell string

    image

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    imageDesktop

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    imageMobile

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    imageTablet

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    name string
    position string

    Possible values: [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]

    redirectURL string
    targetBlank boolean
    template boolean
    textColor string
    textContent string
    type string

    Possible values: [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]

    width string
    widthImageDesktop string
    widthImageMobile string
    widthImageTablet string
    withOverlay boolean
    priority int32

    Priority of the personalization

    siteId int64required

    Site Id of the given personalization

    status string

    Status of the given personalization

    stickyBlock

    object

    Sticky block settings

    animationDirection string

    Possible values: [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]

    animationTrigger string

    Possible values: [ON_OPEN, ON_CLOSE, ON_OPEN_AND_CLOSE, CONTINUOUSLY]

    animationType string

    Possible values: [NONE, FADE, SLIDER, ZOOM_IN, ZOOM_OUT, BOUNCE]

    backgroundColor string
    customPositionAxisX string
    customPositionAxisY string
    displayImageConfiguration string

    Possible values: [DISPLAY_ALL_DEVICES, DISPLAY_ONLY_DESKTOP, DISPLAY_ONLY_TABLET, DISPLAY_ONLY_MOBILE, DISPLAY_DESKTOP_TABLET, DISPLAY_DESKTOP_MOBILE, DISPLAY_TABLET_MOBILE]

    fontSize string
    height string
    heightImageDesktop string
    heightImageMobile string
    heightImageTablet string
    htmlContent string
    idTarget2Sell string

    image

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    imageDesktop

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    imageMobile

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    imageTablet

    object

    baseColor int32

    Image base color

    colorDepth int32
    createdById int64

    Account Id of the image uploader

    date date-time

    Date the image was uploaded

    fileName string

    Image file name

    fileWeight int64

    Image file size in KB

    format string

    Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

    Possible values: [PNG, JPEG, GIF, SVG, MVG, WEB]

    height int32

    Image height in pixels

    id int64

    Unique Id of the image

    keywords string[]

    Keyword(s) associated with the image

    name string

    Image name

    path string

    Image path

    shared boolean

    Indicates if the image has been shared

    siteId int64

    Unique Id of the site your project is associated with

    size int64

    Image size in bytes. Image file size should be maximum 5242880 bytes

    source string

    Image source

    sourceUrl string

    URL or the image source

    width int32

    Image width in pixels

    name string
    position string

    Possible values: [TOP, BOTTOM, LEFT, RIGHT, CENTER, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM]

    redirectURL string
    shiftContent boolean
    shouldScrollTo boolean
    targetBlank boolean
    template boolean
    textColor string
    textContent string
    type string

    Possible values: [SINGLE_IMAGE, FULL_IMAGE_TEXT, FULL_TEXT_IMAGE, HTML, TARGET2SELL]

    width string
    widthImageDesktop string
    widthImageMobile string
    widthImageTablet string
    tags string[]

    List of tags

    targetingSegmentId int64

    Selected targeting segment

    trackingTools

    object[]

    List of tracking tools

  • Array [

    • adobeOmnitureObject string
    comScoreCustomerId string
    comScoreDomain string
    contentSquareUrl string
    customIntegrations string[]
    customVariable int32
    eulerianUserCentricParameter string
    name string

    Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, DATABRICKS, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

    reportingScript string
    universalAnalyticsDimension int32

  • ]

    • type string

    Type of personalization

    Possible values: [AUTOPROMO, CLASSIC, IA]

    variationId int64

    Variation Id of the given personalization

    visitExpositionFrequency int32

    Frequency of exposure during a unique visit

    visitorExpositionFrequency int32

    Frequency of exposure for a unique visitor

    visitorExpositionFrequencyMax int32

    Cease showing the same visitor once their exposure exceeds this limit.

    widget

    object

    Widget linked to personalization

    config string

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

    cssCode string

    CSS that belongs to this template.

    dateActivated date-time

    Date when the widget was activated.

    dateCreated date-time

    Date when this widget was created

    dateModified date-time

    Date when this widget was modified

    description string

    Description of the template.

    htmlCode string

    UI text that belongs to this template.

    id int64

    Unique Id of the template

    isCustomTemplate boolean

    Indicates if this is a custom template.

    name string

    Name of the template.

    siteId int64required

    Web Id of the studio template.

    status string

    Template status.

    Possible values: [DRAFT, ACTIVE, PAUSED]

    tags string[]

    Tags that belong to this template.

    templateCssCode string

    CSS code that belongs to this template.

    templateHtmlCode string

    HTML code that belongs to this template.

    templateJavaScriptCode string

    JavaScript code that belongs to this template.

    type string

    Type of template.

    Possible values: [TEMPLATE, EDITOR]

    url string

    Url associated with this template.

    useCustomData boolean

    Indicates if custom data is being used.

    widgetEditorTemplate string

    Widget editor code that belongs to this template.

  • ]

Loading...