Listen LabsDocs

    Endpoints

    Get Responses

    List a study's responses with answers and summaries, paginated

    GET/api/public/v1/responses/{linkId}
    Request
    curl -X GET 'https://listenlabs.ai/api/public/v1/responses/<linkId>' \
      -H 'x-api-key: <api_key>'
    Response
    JSON
    [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "readableId": 0,
        "createdAt": "string",
        "updatedAt": "string",
        "progress": "complete",
        "responseDurationSeconds": 0,
        "answers": {},
        "answersArray": [
          {
            "answerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "discussionGuideQuestionId": "string",
            "conceptId": "string",
            "question": "string",
            "answer": "string",
            "optionIds": [
              "string"
            ],
            "matrixSelections": [
              {
                "rowId": "string",
                "columnId": "string",
                "groupName": "string"
              }
            ]
          }
        ],
        "urlParams": {},
        "shortTranscript": "string",
        "tagline": "string",
        "bulletSummary": [
          "string"
        ],
        "tags": [
          "string"
        ],
        "shortAssistantMessages": [
          "string"
        ],
        "qualityScore": 0,
        "qualityCategory": "string",
        "qualityReasoning": "string",
        "otherRemarks": "string",
        "personas": "string"
      }
    ]

    Authorization

    x-api-keystringheaderrequired

    Your workspace API key. See Authentication.

    Path parameters

    linkIdstringrequired

    The study's editable link ID (as used in the response URL) or the study UUID.

    Query parameters

    pageinteger

    Default: 0

    perPageinteger

    Default: 1000

    updatedSincestring<date-time>

    Only responses updated at or after this timestamp.

    includeInProgressboolean

    Default: true

    Responses

    Responses

    idstring<uuid>required
    readableIdintegerrequired
    createdAtstringrequired
    updatedAtstringrequired
    progressstringrequired

    One of: complete, screened_out, in_progress

    responseDurationSecondsintegerrequired
    answersmaprequired
    answersArrayListResponseAnswer[]required
    urlParamsmaprequired
    shortTranscriptstring | nullrequired
    taglinestring | nullrequired
    bulletSummarystring[]required
    tagsstring[]
    shortAssistantMessagesstring[]
    qualityScorenumber | string
    qualityCategorystring
    qualityReasoningstring | null
    otherRemarksstring
    personasstring