Skip to main content

Get one personalization​

Get a personalization with the given id

Path Parameters
  • personalizationId int64 required
Query Parameters
  • optionalFields string[]
Responses

OK

Schema
  • 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

    Possible values: [ALL_CONDITIONS, CUMULATIVE_WEIGHT]

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

  • 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

    Possible values: [NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL]

    Visitors configuration for the capped number of exposed visitors

  • 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
  • colorDepth int32
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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

    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 string required

    Name of the personalization

  • personalizationConfiguration string

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

    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
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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

    Priority of the personalization

  • siteId int64 required

    Website 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
  • colorDepth int32
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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
  • createdById int64

    Account id to whom created this image

  • date date-time
  • fileName string
  • fileWeight int64

    File size of the image

  • format string

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

  • height int32
  • id int64

    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, 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

    Possible values: [AUTOPROMO, CLASSIC, IA]

    Type of personalization

  • 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
  • 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 int64 required

    Website id of the studio template.

  • status string

    Possible values: [DRAFT, ACTIVE, PAUSED]

    Template status.

  • 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

    Possible values: [TEMPLATE, EDITOR]

    Type of template.

  • 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...