v1

latestOpenAPI 3.0.32026-07-22177397578.0 KB

Personalization

Create new personalization

Create new personalization with given parameters

post/personalizations

Request body

attributionWindowinteger

baseURLstring required

URL of the website to load in editor and preview mode

cappingPerVisitorConvertGoalboolean

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

cappingPerVisitorExposedVisitsboolean

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

cappingPerVisitorExpositionsboolean

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

cappingPerVisitorGoalIdinteger

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

categorystring

checkConditionsRule'ALL_CONDITIONS' | 'CUMULATIVE_WEIGHT'

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

collectingDataEnabledboolean

createdByinteger

Account Id of the creator of this personalization

cssCodestring

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

customExpositionRatenumber double

Percentage of the segment exposed to a personalization

dateCollectingDataStoppedstring date-time

Date of the latest data collection

dateCreatedstring date-time

Date when personalization was created

dateEndedstring date-time

Date when personalization was ceased

dateModifiedstring date-time

Date and time when the personalization was last modified

dateStartedstring date-time

Date when personalization was started

dateStatusModifiedstring date-time

Timestamp of the last update

descriptionstring

Description of the personalization

exposedVisitsSameVisitorMaxinteger

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

expositionFrequencyDelayinteger

Frequency of exposure for different visitors

formatstring

globalCappingGoalIdinteger

Threshold goal for the total number of exposed visitors

globalCappingNumberVisitorsboolean

Option to allow capping visitors for a configuration

globalCappingVisitorsConfig'NUMBER_VISITORS' | 'NUMBER_VISITORS_CONVERT_GOAL' | 'NUMBER_VISITORS_NOT_CONVERT_GOAL'

Visitors configuration for the capped number of exposed visitors

globalScriptstring

JavaScript code that will be applied only to the selected personalization and executed in the end of the Global custom script

goalsinteger[]

Selected goals

idinteger

Unique Id of the personalization

isArchivedboolean

Indicates if the personalization is archived

javaScriptCodestring

JavaScript code to add in the page

locationstring

mainGoalIdinteger

Id of the main goal

marketstring

maxNumberVisitorsExposedinteger

Limit of the total number of exposed visitors

metaReadOnlystring

Personalization in READ_ONLY mode for sub-personalization

multiExpositionFrequencyDelayinteger

Minimum delay between each exposure

namestring required

Name of the personalization

Personalization configuration

priorityinteger

Priority of the personalization

siteIdinteger required

Site Id of the project the personalization belongs to

statusstring

Status of the personalization

tagsstring[]

List of tags

targetingRuleIdinteger

Deprecated. Use TargetingRule instead.

targetingSegmentIdinteger

Selected targeting segment

type'AUTOPROMO' | 'BUILDER' | 'CLASSIC' | 'IA' | 'PERSO_RULE'

Type of personalization

variationIdinteger

Variation Id of the personalization

variationIdsinteger[]

List of variation ids for this personalization. Includes variations from other personalizations (variation.personalizationId != this ID). Variations with personalizationId can only be deleted via 'Delete variation' operation.

visitExpositionFrequencyinteger

Frequency of exposure during a unique visit

visitorExpositionFrequencyinteger

Frequency of exposure for a unique visitor

visitorExpositionFrequencyMaxinteger

Cease exposing to this visitor once their exposure exceeds this limit.

Response

Created