Skip to main content

Get all personalizations​

Get list of all personalizations

Query Parameters
  • paramsIO object required
  • optionalFields string[]
Responses

OK

Schema
  • Array [
  • cappingPerVisitorConvertGoal boolean

    If true stop exposing a same visitor when the goal is completed

  • cappingPerVisitorExposedVisits boolean

    If true stop exposing a same visitor when the number of visits exceeds this threshold

  • cappingPerVisitorExpositions boolean

    If true stop exposing a same visitor when the total number of expositions exceeds this threshold

  • cappingPerVisitorGoalId int64

    Stop exposing a same visitor when the goal with given id is completed

  • category string
  • checkConditionsRule string

    Possible values: [ALL_CONDITIONS, CUMULATIVE_WEIGHT]

    The behavior of Kameleoon to determine if a visitor is targeted or not

  • collectingDataEnabled boolean
  • createdBy int64

    Account id to whom created this personalization

  • cssCode string

    CSS code to add in the page

  • customExpositionRate double

    The segment percentage exposed to personalization

  • dateCollectingDataStopped date-time

    Date of last data collection stops

  • dateCreated date-time

    Date and time when personalization was created

  • dateEnded date-time

    Date and time when personalization was ended

  • dateModified date-time

    Date and time when personalization was updated last time

  • dateStarted date-time

    Date and time when personalization was started

  • dateStatusModified date-time

    Last moment when status was updated

  • description string

    This is description of personalization

  • emailAction object

    Settings of an email

  • customDataIndex int32
  • customSolutionName string
  • emailContentSolution string

    Possible values: [CUSTOM_TEMPLATE, HTML_CODE, NONE]

  • emailSolution string

    Possible values: [CUSTOM, SMARTFOCUS, EMARSYS, EXPERTSENDER, NONE, CUSTOM_INTEGRATIONS]

  • emailTags string
  • emailTemplateId string
  • fetchingMethod string

    Possible values: [CUSTOM_DATA, SCRIPT, NONE]

  • fetchingScript string
  • goalCancellingId int64
  • headerEmailSubject string
  • headerReplyEmail string
  • headerSenderEmail string
  • headerSenderName string
  • htmlContent string
  • neverCancelSending boolean
  • randomTagId string
  • secondsDelayToSend int64
  • sendAtOnce boolean
  • solutionKey string
  • solutionSecret string
  • solutionUrl string
  • exposedVisitsSameVisitorMax int32

    Stop exposing a same visitor when the number of visits exceeds this threshold

  • expositionFrequencyDelay int64

    Period of time of exposition frequency during different visitors

  • format string
  • globalCappingGoalId int64

    The goal for threshold of total number of exposed visitors

  • globalCappingNumberVisitors boolean

    This option allows you to set the capping configuration

  • globalCappingVisitorsConfig string

    Possible values: [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]

    The visitors configuration for threshold of total number of exposed visitors

  • goals int64[]

    Selected goals

  • id int64

    This field is generated by the system to uniquely identify a personalization

  • imageInPage object

    Settings of an image in page

  • domElementSelector string
  • height string
  • htmlContent string
  • image object
  • baseColor int32
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • 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

    Threshold of the total number of exposed visitors

  • metaReadOnly string

    Personalization read only mode for sub personalization

  • multiExpositionFrequencyDelay int64

    Minimum delay between each exposition

  • name string required

    The name of the personalization

  • personalizationConfiguration string

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

    Personalization configuration

  • 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
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • imageDesktop object
  • baseColor int32
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • imageMobile object
  • baseColor int32
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • imageTablet object
  • baseColor int32
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • 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

    The priority of the personalization

  • siteId int64 required

    The website id that a personalization belongs to

  • status string

    The 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
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • imageDesktop object
  • baseColor int32
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • imageMobile object
  • baseColor int32
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • imageTablet object
  • baseColor int32
  • colorDepth int32
  • date date-time
  • fileName string
  • fileWeight int64

    File weight of image

  • format string

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

  • height int32
  • id int64

    The unique identifier of the given image

  • keywords string[]
  • name string
  • path string
  • shared boolean
  • siteId int64
  • size int64

    Size of image

  • source string
  • sourceUrl string
  • width int32
  • 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, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

  • reportingScript string
  • universalAnalyticsDimension int32
  • ]
  • type string

    Possible values: [CLASSIC, AUTOPROMO, IA, MAIL]

    Type of personalization

  • variationId int64

    The variation id of the given personalization

  • visitExpositionFrequency int32

    Exposition frequency during a unique visit

  • visitorExpositionFrequency int32

    Exposition frequency during a unique visitor

  • visitorExpositionFrequencyMax int32

    Stop exposing a same visitor when the total number of expositions exceeds this threshold

  • widget object
  • config string

    Widget editor config field is associated with translation locales field JSON type

  • cssCode string

    UiCssCode that is associated with this template

  • dateActivated date-time

    Date and time a record is activated

  • dateCreated date-time

    Date and time a record is created

  • dateModified date-time

    Date and time a record is modified

  • description string

    Description of template

  • htmlCode string

    UiHtmlCode that is associated with this template

  • id int64

    The unique identifier of the given template

  • name string

    The name for the given template

  • siteId int64 required

    The website id that an template belongs to

  • status string

    Possible values: [DRAFT, ACTIVE, PAUSED]

    Template status

  • tags string[]

    This fields stores tags that are associated with this template

  • templateCssCode string

    templateCssCode that is associated with this template

  • templateHtmlCode string

    templateHtmlCode that is associated with this template

  • templateJavaScriptCode string

    templateJavaScriptCode that is associated with this template

  • type string

    Possible values: [TEMPLATE, EDITOR]

    The type of template

  • url string

    Url associated with this template

  • useCustomData boolean

    Boolean value of use custom data

  • widgetEditorTemplate string

    Widget editor code that is associated with this template

  • ]
Loading...