client.characteristics

Characteristics are collected before the interview and stored on each interview under the question’s variable name. They have the same shape of API as screening.

client.characteristics.create_question(
    study.id,
    question="What is your role?",
    variable="role",
    options=["Engineer", "PM", "Designer"],
)
client.characteristics.create_question(
    study.id,
    question="How many people work at your company?",
    variable="company_size",
    question_type="slot",
    slot_description="Approximate headcount as a number",
)
client.characteristics.set_settings(study.id, enabled=True)

Read them back on interviews.get() as characteristics.

get()

client.characteristics.get(study_id) -> CharacteristicsOut

Settings plus the ordered question list. Returns CharacteristicsOut.

set_settings()

client.characteristics.set_settings(study_id, *, enabled: bool, anonymous: bool | None = None) -> CharacteristicsSettingsOut

Enable or disable characteristic collection. Disabling keeps the question list.

bool

required

Whether characteristics are collected before the interview.

bool

Skip collecting participants’ first names.

Returns CharacteristicsSettingsOut.

create_question()

client.characteristics.create_question(
    study_id,
    *,
    question: str,
    variable: str,
    question_type: str | None = None,
    options: list[str] | None = None,
    slot_description: str | None = None,
) -> CharacteristicQuestionOut

str

required

Question text.

str

required

Variable name the answer is stored under.

str

default:"multiple"

multiple (choose from options) or slot (a free-form value described by slot_description).

list[str]

Answer options, for multiple-choice questions.

str

The value to elicit, for slot questions.

Returns CharacteristicQuestionOut.

update_question()

client.characteristics.update_question(study_id, question_id, *, question=None, variable=None,
                                       question_type=None, options=None, slot_description=None)

Update a characteristic question. Only the arguments you pass change. Returns CharacteristicQuestionOut.

delete_question()

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

Returns SuccessResponse.

reorder_questions()

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

Pass every characteristic question ID, in the order you want. Returns CharacteristicsOut.

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()