client.screening

Screening runs before the interview. Each question lists the acceptable_options that qualify a participant. Participants who don’t qualify see the disqualification message and can be redirected.

client.screening.create_question(
    study.id,
    question="Do you use the product at work?",
    options=["Yes", "No"],
    acceptable_options=["Yes"],
)
client.screening.set_settings(study.id, enabled=True, disqualification_message="Thanks anyway!")

get()

client.screening.get(study_id) -> ScreeningOut

Screening settings plus the ordered question list. Returns ScreeningOut.

set_settings()

client.screening.set_settings(
    study_id, *, enabled: bool, disqualification_message: str | None = None, redirect_url: str | None = None
) -> ScreeningSettingsOut

Enable or disable screening. Disabling keeps the questions and settings.

bool

required

Whether screening runs before the interview.

str

Shown to participants who don’t qualify.

str

Where disqualified participants are sent. May contain {{external_participant_id}}.

Returns ScreeningSettingsOut.

create_question()

client.screening.create_question(
    study_id, *, question: str, options: list[str], acceptable_options: list[str]
) -> ScreeningQuestionOut

Append a multiple-choice qualifying question.

str

required

Question text.

list[str]

required

Answer options.

list[str]

required

The subset of options that qualify the participant.

Returns ScreeningQuestionOut.

update_question()

client.screening.update_question(
    study_id, question_id, *, question=None, options=None, acceptable_options=None
) -> ScreeningQuestionOut

Update a screening question. Only the arguments you pass change. Returns ScreeningQuestionOut.

delete_question()

client.screening.delete_question(study_id, question_id) -> SuccessResponse

Delete a screening question and any recorded answers to it. Returns SuccessResponse.

reorder_questions()

client.screening.reorder_questions(study_id, *, question_ids: Sequence[str | UUID]) -> ScreeningOut

Reorder screening questions. Pass every screening question ID, in the order you want. Returns ScreeningOut.

Client

Study setup

Recruitment

Simulation

Results

Organization

Utilities

get()

set_settings()

create_question()

update_question()

delete_question()

reorder_questions()

​get()

​set_settings()

​create_question()

​update_question()

​delete_question()

​reorder_questions()

get()

set_settings()

create_question()

update_question()

delete_question()

reorder_questions()