Get all personalizations

Get list of all personalizations. To use optionalFields check out this guide.

GET /personalizations

Get all personalizations

cURL

curl --request GET \
  --url https://api.kameleoon.com/personalizations \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "baseURL": "<string>",
    "name": "<string>",
    "siteId": 123,
    "attributionWindow": 123,
    "cappingPerVisitorConvertGoal": true,
    "cappingPerVisitorExposedVisits": true,
    "cappingPerVisitorExpositions": true,
    "cappingPerVisitorGoalId": 123,
    "category": "<string>",
    "collectingDataEnabled": true,
    "createdBy": 123,
    "cssCode": "<string>",
    "customExpositionRate": 123,
    "dateCollectingDataStopped": "2023-11-07T05:31:56Z",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateEnded": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "dateStarted": "2023-11-07T05:31:56Z",
    "dateStatusModified": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "exposedVisitsSameVisitorMax": 123,
    "expositionFrequencyDelay": 123,
    "format": "<string>",
    "globalCappingGoalId": 123,
    "globalCappingNumberVisitors": true,
    "globalScript": "<string>",
    "goals": [
      123
    ],
    "id": 123,
    "imageInPage": {
      "domElementSelector": "<string>",
      "height": "<string>",
      "htmlContent": "<string>",
      "image": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "mainPageUrl": "<string>",
      "redirectURL": "<string>",
      "width": "<string>"
    },
    "isArchived": true,
    "javaScriptCode": "<string>",
    "location": "<string>",
    "mainGoalId": 123,
    "market": "<string>",
    "maxNumberVisitorsExposed": 123,
    "metaReadOnly": "<string>",
    "multiExpositionFrequencyDelay": 123,
    "popIn": {
      "backgroundColor": "<string>",
      "closeWithClickOnOverlay": true,
      "customPositionAxisX": "<string>",
      "customPositionAxisY": "<string>",
      "fontSize": "<string>",
      "height": "<string>",
      "heightImageDesktop": "<string>",
      "heightImageMobile": "<string>",
      "heightImageTablet": "<string>",
      "htmlContent": "<string>",
      "idTarget2Sell": "<string>",
      "image": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "imageDesktop": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "imageMobile": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "imageTablet": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "name": "<string>",
      "redirectURL": "<string>",
      "targetBlank": true,
      "template": true,
      "textColor": "<string>",
      "textContent": "<string>",
      "width": "<string>",
      "widthImageDesktop": "<string>",
      "widthImageMobile": "<string>",
      "widthImageTablet": "<string>",
      "withOverlay": true
    },
    "priority": 123,
    "status": "<string>",
    "stickyBlock": {
      "backgroundColor": "<string>",
      "customPositionAxisX": "<string>",
      "customPositionAxisY": "<string>",
      "fontSize": "<string>",
      "height": "<string>",
      "heightImageDesktop": "<string>",
      "heightImageMobile": "<string>",
      "heightImageTablet": "<string>",
      "htmlContent": "<string>",
      "idTarget2Sell": "<string>",
      "image": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "imageDesktop": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "imageMobile": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "imageTablet": {
        "altText": "<string>",
        "baseColor": 123,
        "colorDepth": 123,
        "createdById": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "fileName": "<string>",
        "fileWeight": 123,
        "height": 123,
        "id": 123,
        "keywords": [
          "<string>"
        ],
        "name": "<string>",
        "path": "<string>",
        "shared": true,
        "siteId": 123,
        "size": 123,
        "source": "<string>",
        "sourceUrl": "<string>",
        "tags": [
          "<string>"
        ],
        "width": 123
      },
      "name": "<string>",
      "redirectURL": "<string>",
      "shiftContent": true,
      "shouldScrollTo": true,
      "targetBlank": true,
      "template": true,
      "textColor": "<string>",
      "textContent": "<string>",
      "width": "<string>",
      "widthImageDesktop": "<string>",
      "widthImageMobile": "<string>",
      "widthImageTablet": "<string>"
    },
    "tags": [
      "<string>"
    ],
    "targetingRule": {
      "siteId": 123,
      "id": 123,
      "segmentId": 123,
      "targetingConfigurationParam": "<string>",
      "triggerId": 123
    },
    "targetingRuleId": 123,
    "targetingSegmentId": 123,
    "trackingTools": [
      {
        "adobeOmnitureObject": "<string>",
        "comScoreCustomerId": "<string>",
        "comScoreDomain": "<string>",
        "contentSquareUrl": "<string>",
        "customIntegrations": [
          "<string>"
        ],
        "customVariable": 123,
        "eulerianUserCentricParameter": "<string>",
        "reportingScript": "<string>",
        "universalAnalyticsDimension": 123
      }
    ],
    "variationId": 123,
    "variationIds": [
      123
    ],
    "visitExpositionFrequency": 123,
    "visitorExpositionFrequency": 123,
    "visitorExpositionFrequencyMax": 123,
    "widget": {
      "siteId": 123,
      "config": "<string>",
      "cssCode": "<string>",
      "dateActivated": "2023-11-07T05:31:56Z",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateModified": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "htmlCode": "<string>",
      "id": 123,
      "isCustomTemplate": true,
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "templateCssCode": "<string>",
      "templateHtmlCode": "<string>",
      "templateJavaScriptCode": "<string>",
      "themeId": 123,
      "url": "<string>",
      "useCustomData": true,
      "widgetEditorTemplate": "<string>"
    }
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

paramsIO · object · required

Show child attributes

optionalFields · string[]

Response

200

*/*

OK

baseURL · string · required

URL of the website to load in editor and preview mode

name · string · required

Name of the personalization

siteId · integer<int64> · required

Site Id of the project the personalization belongs to

attributionWindow · integer<int64>

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 · integer<int64>

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

category · string

checkConditionsRule · enum<string> · read-only

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

Available options: ALL_CONDITIONS, CUMULATIVE_WEIGHT

collectingDataEnabled · boolean

createdBy · integer<int64> · read-only

Account Id of the creator of this personalization

cssCode · string

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

customExpositionRate · number<double>

Percentage of the segment exposed to a personalization

dateCollectingDataStopped · string<date-time> · read-only

Date of the latest data collection

dateCreated · string<date-time> · read-only

Date when personalization was created

dateEnded · string<date-time> · read-only

Date when personalization was ceased

dateModified · string<date-time> · read-only

Date and time when the personalization was last modified

dateStarted · string<date-time> · read-only

Date when personalization was started

dateStatusModified · string<date-time> · read-only

Timestamp of the last update

description · string

Description of the personalization

exposedVisitsSameVisitorMax · integer<int32>

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

expositionFrequencyDelay · integer<int64>

Frequency of exposure for different visitors

format · string

globalCappingGoalId · integer<int64>

Threshold goal for the total number of exposed visitors

globalCappingNumberVisitors · boolean

Option to allow capping visitors for a configuration

globalCappingVisitorsConfig · enum<string>

Visitors configuration for the capped number of exposed visitors

Available options: NUMBER_VISITORS, NUMBER_VISITORS_CONVERT_GOAL, NUMBER_VISITORS_NOT_CONVERT_GOAL

globalScript · string

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

goals · integer<int64>[]

Selected goals

Selected goals

id · integer<int64> · read-only

Unique Id of the personalization

imageInPage · object

Settings of an image in page

Show child attributes

isArchived · boolean

Indicates if the personalization is archived

javaScriptCode · string

JavaScript code to add in the page

location · string

mainGoalId · integer<int64>

Id of the main goal

market · string

maxNumberVisitorsExposed · integer<int64>

Limit of the total number of exposed visitors

metaReadOnly · string

Personalization in READ_ONLY mode for sub-personalization

multiExpositionFrequencyDelay · integer<int64>

Minimum delay between each exposure

personalizationConfiguration · enum<string>

Personalization configuration

Available options: CUSTOM, HTML_IN_PAGE, IMAGE_IN_PAGE, INFOBULLE_ABOVE, NEWS_LETTER, NONE, POPIN, STICKY_BLOCK, TEMPLATE, VARIATION

popIn · object

Pop-In settings

Show child attributes

priority · integer<int32> · read-only

Priority of the personalization

status · string · read-only

Status of the personalization

stickyBlock · object

Sticky block settings

Show child attributes

tags · string[]

List of tags

List of tags

targetingRule · object

Targeting Rule defines the conditions for displaying content to specific user groups based on segments and triggers

Show child attributes

targetingRuleId · integer<int64> · deprecated · read-only

Deprecated. Use TargetingRule instead.

targetingSegmentId · integer<int64>

Selected targeting segment

trackingTools · object[]

List of tracking tools

Show child attributes

type · enum<string>

Type of personalization

Available options: AUTOPROMO, BUILDER, CLASSIC, IA, PERSO_RULE

variationId · integer<int64>

Variation Id of the personalization

variationIds · integer<int64>[]

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.

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.

visitExpositionFrequency · integer<int32>

Frequency of exposure during a unique visit

visitorExpositionFrequency · integer<int32>

Frequency of exposure for a unique visitor

visitorExpositionFrequencyMax · integer<int32>

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

widget · object

Show child attributes