client.interviews

Test runs (your own interviews through the dashboard’s Try Interview or Preview) and simulated interviews are left out unless you ask for them. See Analyzing responses.

list()

client.interviews.list(
    study_id,
    *,
    completed: bool | None = None,
    simulated: bool | None = None,
    test_runs: bool | None = None,
    external_participant_id: str | None = None,
    started_after: str | datetime | None = None,
    started_before: str | datetime | None = None,
    limit: int | None = None,
    offset: int | None = None,
) -> InterviewListOut

A study’s interviews, newest first.

bool

Filter by completion status.

bool

True for only simulated interviews, False for only real ones. Only real interviews are returned when omitted.

bool

True for only test runs, False to leave them out. Test runs are left out when omitted.

str

Only interviews that arrived with this ID of yours.

str | datetime

Only interviews started after this time.

str | datetime

Only interviews started before this time.

int

default:"50"

Page size.

int

Page offset.

Returns InterviewListOut, with interviews holding a list of InterviewSummary.

find_by_external_id()

client.interviews.find_by_external_id(
    study_id,
    *,
    external_participant_id: str,
    include_simulated: bool | None = None,
    include_test_runs: bool | None = None,
    limit: int | None = None,
) -> InterviewDetailListOut

Every interview that arrived carrying your participant ID, in full detail.

str

required

Your ID for the participant, exactly as the entry link (?participant_id=) or embed metadata carried it.

bool

default:"False"

Include simulated interviews.

bool

default:"False"

Include test runs.

int

default:"20"

The most recent N attempts.

Returns InterviewDetailListOut.

get()

client.interviews.get(interview_id) -> InterviewDetailOut

One interview with its screening answers (qualifications), characteristics, embed_metadata and captured flow variables. Returns InterviewDetailOut.

get_transcript()

client.interviews.get_transcript(interview_id) -> TranscriptOut

The interview’s messages in order, plus captured variables and branch decisions.

t = client.interviews.get_transcript(interview_id)
for m in t.messages:
    print(f"[{m.type}] {m.content}")

Returns TranscriptOut.

get_fetches_and_signals()

client.interviews.get_fetches_and_signals(interview_id) -> InterviewEffectsOut

What an interview flow’s data fetches and signals did: URLs, request bodies, status codes and errors. Empty for linear studies. Returns InterviewEffectsOut.

Client

Study setup

Recruitment

Simulation

Results

Organization

Utilities

list()

find_by_external_id()

get()

get_transcript()

get_fetches_and_signals()

​list()

​find_by_external_id()

​get()

​get_transcript()

​get_fetches_and_signals()

list()

find_by_external_id()

get()

get_transcript()

get_fetches_and_signals()