Appearance

Interview​

POST
/studies/{study_id}/interview

Start interviews for a study.

Two modes:

  1. Use existing GSUs: Provide 'syntheticUsers' (List[UUID])
  2. Generate + Interview: Provide 'quantity' only

In Mode 2, audience/problems/research_goal/files are automatically pulled from the study.

Authorizations​

HTTPBearer

Use your API token

Type
HTTP (bearer)

Parameters​

Path Parameters

study_id*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"syntheticUsers": [
"string"
],
"quantity": 0,
"customScript": "string",
"ongoingWalkthrough": false
}

Responses​

Successful Response

application/json
object
Format"uuid"
string |null
Required
Format"uuid"
Format"date-time"
string[]
Required
object[]
Required
string[]
Required
object[]
Required
string[]
Required
string |null
Required
object |null
string |null
object |null
string |null
object |null
string[]
Valid values"solution_feedback""problem_exploration""custom_script""dynamic_interview""ethnographic_research""concept_study"
integer |null
string[]
Required
string[]
Required

Samples​

Powered by VitePress OpenAPI