Get Responses

This endpoint lists all responses for a given study.

GET /api/public/responses/{link_id}

Example Request

curl 'https://listenlabs.ai/api/public/responses/study123?page=0&per_page=100&updated_since=2023-08-18T00:00:00Z' \
-H 'x-api-key: <api_key>'

Response

[
  {
    "id": "12345678-0000-0000-0000-000000000000",
    "created_at": "2023-08-18T11:51:54.649916+00:00",
    "answers": {
      "Summary": "Summary of response 1",
      "Question 1": "Answer of question 1",
      "Question 2": "Answer of question 2"
    },
    "answers_array": [
      {
        "answer_id": "f1e2d3c4-0000-0000-0000-000000000001",
        "discussion_guide_question_id": "a1b2c3d4-0000-0000-0000-000000000001",
        "concept_id": null,
        "question_id": "q-001",
        "question": "Question 1",
        "answer": "Answer of question 1"
      },
      {
        "answer_id": "f1e2d3c4-0000-0000-0000-000000000002",
        "discussion_guide_question_id": "a1b2c3d4-0000-0000-0000-000000000002",
        "concept_id": "b2c3d4e5-0000-0000-0000-000000000001",
        "question_id": "q-002",
        "question": "Question 2",
        "answer": "Answer of question 2"
      }
    ],
    "attributes": { "id": "123" },
    "short_transcript": "• Welcome → Start\n• Ask for name → John\n• Thank you, bye → "
  },
  {
    "id": "23456789-0000-0000-0000-000000000000",
    "created_at": "2023-08-19T11:51:54.649916+00:00",
    "answers": {
      "Summary": "Summary of response 2",
      "Question 1": "Answer of question 1",
      "Question 2": "Answer of question 2"
    },
    "answers_array": [
      {
        "answer_id": "f1e2d3c4-0000-0000-0000-000000000001",
        "discussion_guide_question_id": "a1b2c3d4-0000-0000-0000-000000000001",
        "concept_id": null,
        "question_id": "q-001",
        "question": "Question 1",
        "answer": "Answer of question 1"
      },
      {
        "answer_id": "f1e2d3c4-0000-0000-0000-000000000002",
        "discussion_guide_question_id": "a1b2c3d4-0000-0000-0000-000000000002",
        "concept_id": null,
        "question_id": "q-002",
        "question": "Question 2",
        "answer": "Answer of question 2"
      }
    ],
    "attributes": { "id": "567" },
    "short_transcript": "• Welcome → Start\n• Ask for name → Alice\n• Thank you, bye → "
  }
]

Path Parameters

link_id · string

The link ID of the study. You can find this in the study URL or via the List Studies endpoint. For example, in https://listenlabs.ai/s/abc123 the link ID is abc123.

Query Parameters

page · integer · default: "0"

The page number for pagination.

per_page · integer · default: "1000"

Number of responses to return per page.

updated_since · string

ISO 8601 date string to filter responses updated after this date (e.g., 2023-08-18T11:51:54.649916Z).

include_in_progress · boolean · default: "true"

Whether to include responses that who’s analysis is still in progress.

Response

Returns a list of responses for the given study. Each response is an object with the following fields:

id · uuid

Unique identifier for the response.

response_number · number

The ordered number of the response.

created_at · string

UTC timestamp of when the response was created.

updated_at · string

UTC timestamp of when the response was last updated.

answers · object

Answers to all questions of the study.

Show Example Answers

Summary · string

A summary of the entire conversation. Available for all studys.

Question 1 · string

Everything the user said in response to question 1.

Question 2 · string

Everything the user said in response to question 2.

answers_array · Response[]

Answers to all questions of the study as an array.

Show Response

answer_id · string

The answer ID. Matches the answer_id on transcript rows from the single response endpoint, enabling cross-referencing.

discussion_guide_question_id · string

The discussion guide question ID.

concept_id · string | null

The concept ID. Null if not concept-specific.

question_id · string · deprecated

Deprecated. Use answer_id instead.

question · string

The question text.

answer · string

The answer to the question.

attributes · object

URL parameters that were passed to the study.

Show Example Attributes

id · string

An id that is passed to study eg. https://listenlabs.ai/s/abc123?id=123.

short_transcript · string

A transcript of the entire conversation where the assistant messages are shortened to a couple of words.

Example Request

curl 'https://listenlabs.ai/api/public/responses/study123?page=0&per_page=100&updated_since=2023-08-18T00:00:00Z' \
-H 'x-api-key: <api_key>'

Response

[
  {
    "id": "12345678-0000-0000-0000-000000000000",
    "created_at": "2023-08-18T11:51:54.649916+00:00",
    "answers": {
      "Summary": "Summary of response 1",
      "Question 1": "Answer of question 1",
      "Question 2": "Answer of question 2"
    },
    "answers_array": [
      {
        "answer_id": "f1e2d3c4-0000-0000-0000-000000000001",
        "discussion_guide_question_id": "a1b2c3d4-0000-0000-0000-000000000001",
        "concept_id": null,
        "question_id": "q-001",
        "question": "Question 1",
        "answer": "Answer of question 1"
      },
      {
        "answer_id": "f1e2d3c4-0000-0000-0000-000000000002",
        "discussion_guide_question_id": "a1b2c3d4-0000-0000-0000-000000000002",
        "concept_id": "b2c3d4e5-0000-0000-0000-000000000001",
        "question_id": "q-002",
        "question": "Question 2",
        "answer": "Answer of question 2"
      }
    ],
    "attributes": { "id": "123" },
    "short_transcript": "• Welcome → Start\n• Ask for name → John\n• Thank you, bye → "
  },
  {
    "id": "23456789-0000-0000-0000-000000000000",
    "created_at": "2023-08-19T11:51:54.649916+00:00",
    "answers": {
      "Summary": "Summary of response 2",
      "Question 1": "Answer of question 1",
      "Question 2": "Answer of question 2"
    },
    "answers_array": [
      {
        "answer_id": "f1e2d3c4-0000-0000-0000-000000000001",
        "discussion_guide_question_id": "a1b2c3d4-0000-0000-0000-000000000001",
        "concept_id": null,
        "question_id": "q-001",
        "question": "Question 1",
        "answer": "Answer of question 1"
      },
      {
        "answer_id": "f1e2d3c4-0000-0000-0000-000000000002",
        "discussion_guide_question_id": "a1b2c3d4-0000-0000-0000-000000000002",
        "concept_id": null,
        "question_id": "q-002",
        "question": "Question 2",
        "answer": "Answer of question 2"
      }
    ],
    "attributes": { "id": "567" },
    "short_transcript": "• Welcome → Start\n• Ask for name → Alice\n• Thank you, bye → "
  }
]