# Listen Labs

> Create research studies and retrieve interviews, transcripts, and summaries.

App · 10 actions. Web page: https://docs.lodol.com/docs/integrations/listen-labs

## Actions

### Create a draft study

Create a draft study.

**Inputs**

- Title (`title`, text, required): Title.
- External title (`external_title`, text): External title.
- Background (`background`, text): Background.
- Study goal (`study_goal`, text): Study goal.
- Config (`config`, object): Config.
- Welcome message (`welcome_message`, object): Welcome message.
- Closing message (`closing_message`, text): Closing message.
- Study guide (`study_guide`, list, required): Study guide.

**Outputs**

- `data` (object): The response from Listen Labs.

**Example output**

```json
{
  "data": {
    "id": "example",
    "linkId": "example",
    "status": "draft"
  }
}
```

### Get an interview response

Get an interview response.

**Inputs**

- Link (`link_id`, text, required): The study's editable link ID (as used in the response URL) or the study UUID.
- Response ID (`response_id`, text, required): Response UUID or positive readable numeric ID.

**Outputs**

- `data` (object): The response from Listen Labs.

**Example output**

```json
{
  "data": {
    "bulletSummary": [
      "example"
    ],
    "id": "example",
    "linkId": "example",
    "readableId": 1,
    "tagline": "example",
    "transcript": [
      {
        "answerId": "example",
        "audio": "example",
        "conceptId": "example",
        "discussionGuideQuestionId": "example",
        "isFollowUp": true,
        "moderator": "example",
        "responseIndex": 1,
        "screenVideo": {
          "mp4Url": "example",
          "streamUrl": "example"
        },
        "user": "example",
        "video": {
          "mp4Url": "example",
          "streamUrl": "example"
        }
      }
    ],
    "urlParams": {}
  }
}
```

### Get response deletion status

Get response deletion status.

**Inputs**

- Deletion ID (`deletion_id`, text, required): Deletion id.

**Outputs**

- `data` (object): The response from Listen Labs.

**Example output**

```json
{
  "data": {
    "completedAt": "example",
    "deletionId": "example",
    "requestedAt": "example",
    "responseId": "example",
    "status": "queued"
  }
}
```

### Get study questions

Get study questions.

**Inputs**

- Study (`study_id`, text, required): Study UUID or the study's link ID.

**Outputs**

- `data` (object): The response from Listen Labs.

**Example output**

```json
{
  "data": {
    "questions": [
      {
        "columns": [
          "example"
        ],
        "concepts": [
          {}
        ],
        "id": "example",
        "isMultiSelect": true,
        "isScreener": true,
        "itemsPerScreen": 1,
        "metric": "example",
        "options": [
          "example"
        ],
        "questionNumber": 1,
        "rows": [
          "example"
        ],
        "text": "example",
        "type": "max_diff"
      }
    ]
  }
}
```

### Launch a study

Launch a study.

**Inputs**

- Study (`study_id`, text, required): Study id.
- Wallet (`wallet_id`, text): Wallet to bill this study from; must be granted to the API key's workspace (see GET /api/public/v1/wallets). Omit to auto-select the workspace's wallet when it has exactly one.

**Outputs**

- `data` (object): The response from Listen Labs.

**Example output**

```json
{
  "data": {
    "id": "example",
    "linkId": "example",
    "selfRecruitLink": "example",
    "status": "live",
    "wallet": {
      "name": "example",
      "projectCreditBalance": {
        "balance": 1,
        "usage": 1
      },
      "recruitmentCreditBalance": {
        "balance": 1,
        "usage": 1
      },
      "walletId": "example"
    }
  }
}
```

### List studies

List studies.

**Inputs**: None.

**Outputs**

- `data` (list): The response from Listen Labs.

**Example output**

```json
{
  "data": [
    {
      "createdAt": "example",
      "creator": {
        "email": "example",
        "name": "example"
      },
      "folderPath": [
        "example"
      ],
      "id": "example",
      "linkId": "example",
      "responseCount": 1,
      "title": "example"
    }
  ]
}
```

### List study responses

List study responses.

**Inputs**

- Link (`link_id`, text, required): The study's editable link ID (as used in the response URL) or the study UUID.
- Page (`page`, number): Page. At least 0.
- Per page (`per_page`, number): Per page. At least 1.
- Updated since (`updated_since`, date and time): Only responses updated at or after this timestamp.
- Include in progress (`include_in_progress`, true/false): Include in progress.

**Outputs**

- `data` (list): The response from Listen Labs.

**Example output**

```json
{
  "data": [
    {
      "answers": {},
      "answersArray": [
        {
          "answer": "example",
          "answerId": "example",
          "conceptId": "example",
          "discussionGuideQuestionId": "example",
          "question": "example"
        }
      ],
      "bulletSummary": [
        "example"
      ],
      "createdAt": "example",
      "id": "example",
      "otherRemarks": "example",
      "personas": "example",
      "progress": "complete",
      "qualityScore": "example",
      "readableId": 1,
      "responseDurationSeconds": 1,
      "shortAssistantMessages": [
        "example"
      ],
      "shortTranscript": "example",
      "tagline": "example",
      "tags": [
        "example"
      ],
      "updatedAt": "example",
      "urlParams": {}
    }
  ]
}
```

### List wallets

List wallets.

**Inputs**: None.

**Outputs**

- `data` (object): The response from Listen Labs.

**Example output**

```json
{
  "data": {
    "wallets": [
      {
        "name": "example",
        "projectCreditBalance": {
          "balance": 1,
          "usage": 1
        },
        "recruitmentCreditBalance": {
          "balance": 1,
          "usage": 1
        },
        "walletId": "example"
      }
    ]
  }
}
```

### Request response deletion

Request response deletion.

**Inputs**

- Study (`study_id`, text, required): Study id.
- Response ID (`response_id`, text, required): Response id.

**Outputs**

- `data` (object): The response from Listen Labs.

**Example output**

```json
{
  "data": {
    "deletionId": "example",
    "responseId": "example",
    "status": "queued"
  }
}
```

### Search responses by URL parameter

Search responses by URL parameter.

**Inputs**

- Parameter (`parameter`, text, required): Parameter.
- Value (`value`, text, required): Value.
- Cursor (`cursor`, text): Use nextCursor from the previous page to continue. Keep the other search parameters unchanged. Invalid cursors return 400.
- Limit (`limit`, number): Limit. From 1 to 1000.
- Include hidden (`include_hidden`, true/false): Include hidden.

**Outputs**

- `data` (object): The response from Listen Labs.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "results": [
      {
        "linkId": "example",
        "readableResponseId": 1,
        "responseId": "example",
        "responseUrl": "example",
        "studyId": "example",
        "studyUrl": "example"
      }
    ]
  }
}
```
