Skip to main content
GET
Preview a personalization slot

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

slot
string
required

Slot key to resolve, e.g. hero-banner.

Query Parameters

segment_label
string

Segment to preview as (champion, high_value_engaged, engaged, new, passive, at_risk, dormant, lost). Omit it to preview the default content; unrecognised values are treated the same way.

Response

data.slot and data.requested_segment echo what was resolved, and data.resolved carries the winning variant — null when no active variant matches, meaning the SDK leaves your page markup untouched.

data.slot and data.requested_segment echo what was resolved, and data.resolved carries the winning variant — null when no active variant matches, meaning the SDK leaves your page markup untouched.

data
object
meta
object