Skip to main content
GET
Report lift for 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 report on, e.g. hero-banner.

Required string length: 1 - 100

Query Parameters

variant_a
string
required

Baseline arm — a variant name, or __default__ for the segment's untagged default content.

Required string length: 1 - 50
variant_b
string
required

Treatment arm — the variant under test. Must differ from variant_a, otherwise the request is rejected.

Required string length: 1 - 50
conversion_event
string
required

Name of the SDK event that counts as a conversion, e.g. clicked_cta or purchase.

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_.-]+$
segment_label
string

Report only on visitors in this segment (champion, high_value_engaged, engaged, new, passive, at_risk, dormant, lost). Unrecognised values are ignored.

Required string length: 1 - 64
since_days
integer
default:30

Lookback window in days (1–365).

Required range: 1 <= x <= 365

Response

The lift report — data.arm_a and data.arm_b carry each arm's impressions, conversions and conversion rate, and data.absolute_lift_pct, data.relative_lift_pct, data.confidence_interval, data.z_score, data.p_value and data.is_significant describe the difference. Those are null while data.state is no_traffic or collecting.

The lift report — data.arm_a and data.arm_b carry each arm's impressions, conversions and conversion rate, and data.absolute_lift_pct, data.relative_lift_pct, data.confidence_interval, data.z_score, data.p_value and data.is_significant describe the difference. Those are null while data.state is no_traffic or collecting.

data
object
meta
object