Get personalizations

GET

/api/v1/public/personalizations

Retrieve all personalizations (experiences) for a specific website, including their configuration, targeting rules, variants, and status information.

Use Cases

• Dashboard Overview: Retrieve all personalizations for management interface
• Performance Monitoring: Get current state and configuration of all experiences
• Bulk Operations: Fetch personalizations for batch updates or analysis
• Integration: Sync personalization data with external systems
• Reporting: Generate reports on personalization coverage and status

Notes

• All timestamp fields are in Unix timestamp format (milliseconds)
• Rules are stored as JSON strings and need to be parsed
• Priority (prio) determines execution order when multiple personalizations could apply
• Component-based personalizations have additional fields for component configuration
• The variants array contains the different variations being tested

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

Query Parameters

accountId

required

string

Your account ID. See: https://unless.com/en/dashboard/account/settings

websiteId

required

string

The website ID to retrieve personalizations for.

Responses

200

Successful response with array of personalizations.

Array<object>

object

accountId

The account ID that owns this personalization.

string

nullable

assignee

User assigned to this personalization.

string

nullable

changed

Whether the personalization has been modified.

boolean

nullable

componentAccountId

Account ID for component-based personalizations.

string

nullable

componentPackageName

Package name for component-based personalizations.

string

nullable

componentSettings

JSON string containing component configuration.

string

nullable

componentType

Type of component used.

string

nullable

componentVersion

Version of the component.

number

nullable

createdAt

Timestamp when personalization was created.

number

nullable

createdDate

Creation date timestamp.

number

nullable

delayOption

Delay trigger option (e.g., “seconds”, “pageviews”).

string

nullable

delayValue

Delay value for trigger timing.

number

nullable

diffUrl

URL for viewing changes diff.

string

nullable

disabled

Whether the personalization is disabled.

boolean

nullable

endDate

Timestamp when personalization should stop running.

number

nullable

excludedRule

Rules for excluding visitors.

string

nullable

exclusive

Whether this personalization is exclusive.

boolean

nullable

hideOption

Option for hiding the personalization.

string

nullable

hideValue

Value for hide timing.

number

nullable

isComponent

Whether this is a component-based personalization.

boolean

nullable

isHiddenAiComponent

Whether this is a hidden AI component.

boolean

nullable

javascriptTrigger

JavaScript trigger code.

string

nullable

javascriptTriggerParsed

Parsed JavaScript trigger.

string

nullable

longurl

Extended URL information.

string

nullable

maxValue

Maximum value for certain triggers.

number

nullable

personalizationTags

Array of tags associated with this personalization.

Array<string>

nullable

prio

Priority level (higher numbers = higher priority).

number

nullable

recipe

Personalization recipe/template.

string

nullable

redirectUrl

URL for redirect-type personalizations.

string

nullable

rule

Targeting rules in JSON format.

string

nullable

startDate

Timestamp when personalization should start running.

number

nullable

state

Current state (e.g., “running”, “paused”, “draft”).

string

nullable

targetTemplateDomain

Target domain for template.

string

nullable

targetTemplatePath

Target path for template.

string

nullable

testMode

Test mode configuration.

string

nullable

updatedDate

Timestamp of last update.

number

nullable

variants

Array of personalization variants.

Array<object>

nullable

object

variationId

ID of the variation.

string

nullable

variationName

Name of the variation.

string

nullable

webPagePath

Web page path where personalization applies.

string

nullable

websiteId

Website ID this personalization belongs to.

string

nullable

Example

[
  {
    "accountId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "websiteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "variationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "variationName": "Homepage Hero Optimization",
    "state": "running",
    "disabled": false,
    "prio": 100,
    "rule": "{\"and\":[{\"field\":\"url\",\"operator\":\"equals\",\"value\":\"/\"}]}",
    "startDate": 1640995200000,
    "endDate": null,
    "createdAt": 1640995200000,
    "updatedDate": 1641081600000,
    "webPagePath": "/",
    "personalizationTags": [
      "homepage",
      "hero",
      "conversion"
    ],
    "testMode": "live",
    "exclusive": false,
    "isComponent": false,
    "variants": [
      {
        "id": "control",
        "name": "Control",
        "weight": 50
      },
      {
        "id": "variation-1",
        "name": "New Hero Design",
        "weight": 50
      }
    ]
  }
]

400

Bad request - invalid parameters.

401

Unauthorized - invalid API key.

403

Forbidden - insufficient permissions.

404

Not found - invalid account or website ID.