Skip to main content
POST
Launch Panel

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Path Parameters

study_id
string
required

Body

application/json

Field a paid panel for a Panel-type study. The interview language is taken from the study (not set here).

target
integer
required

Target number of completed responses

incident_rate
number
required

Expected audience incidence rate as percentage points (10 means 10%). Rates below 10% require a feasibility request.

Required range: 0 <= x <= 100
country_code
enum<string>
default:US

Target country (one of the supported countries).

Available options:
AR,
AU,
AT,
BE,
BO,
BR,
CA,
CL,
CN,
CO,
CR,
CZ,
DK,
DO,
EC,
EG,
FI,
FR,
DE,
GR,
HK,
HU,
IN,
ID,
IE,
IT,
JP,
KE,
KR,
LU,
MY,
MX,
NL,
NZ,
NG,
NO,
PK,
PE,
PH,
PL,
PT,
RO,
RU,
SA,
SG,
SK,
ZA,
ES,
SE,
CH,
TW,
TH,
TR,
UG,
AE,
GB,
US,
VN
frequency
enum<string>
default:one-time

Recurring schedule, or one-time.

Available options:
one-time,
weekly,
monthly,
quarterly
dry_run
boolean
default:false

Return a cost estimate without provisioning the panel

Response

Successful Response

Either a launch acknowledgement (study_id + panel_status) or, for dry_run, a cost + timeline estimate.

study_id
string | null
panel_status
string | null
dry_run
boolean | null
target
integer | null
estimated_total_cost_per_interview_usd
number | null

Per-interview cost in USD (interview credit cost + participant reward).

estimated_total_cost_usd
number | null

Total estimated cost in USD (per-interview × target).

estimated_timeline_hours
integer | null

Estimated time to complete, in whole hours (rounded up).