Get Responses - Listen Labs

List responses for a study

curl --request GET \
  --url https://listenlabs.ai/api/public/v1/responses/{linkId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://listenlabs.ai/api/public/v1/responses/{linkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://listenlabs.ai/api/public/v1/responses/{linkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://listenlabs.ai/api/public/v1/responses/{linkId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://listenlabs.ai/api/public/v1/responses/{linkId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "readableId": 1,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "progress": "complete",
    "responseDurationSeconds": 1,
    "answers": {},
    "answersArray": [
      {
        "answerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "discussionGuideQuestionId": "<string>",
        "conceptId": "<string>",
        "question": "<string>",
        "answer": "<string>"
      }
    ],
    "urlParams": {},
    "shortTranscript": "<string>",
    "tagline": "<string>",
    "bulletSummary": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "shortAssistantMessages": [
      "<string>"
    ],
    "qualityScore": 123,
    "otherRemarks": "<string>",
    "personas": "<string>"
  }
]

GET

api

public

responses

{linkId}

List responses for a study

curl --request GET \
  --url https://listenlabs.ai/api/public/v1/responses/{linkId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://listenlabs.ai/api/public/v1/responses/{linkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://listenlabs.ai/api/public/v1/responses/{linkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://listenlabs.ai/api/public/v1/responses/{linkId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://listenlabs.ai/api/public/v1/responses/{linkId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "readableId": 1,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "progress": "complete",
    "responseDurationSeconds": 1,
    "answers": {},
    "answersArray": [
      {
        "answerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "discussionGuideQuestionId": "<string>",
        "conceptId": "<string>",
        "question": "<string>",
        "answer": "<string>"
      }
    ],
    "urlParams": {},
    "shortTranscript": "<string>",
    "tagline": "<string>",
    "bulletSummary": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "shortAssistantMessages": [
      "<string>"
    ],
    "qualityScore": 123,
    "otherRemarks": "<string>",
    "personas": "<string>"
  }
]

Authorizations

x-api-key

string

header

required

Path Parameters

linkId

string

required

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

Query Parameters

page

integer

default:0

Required range: x >= 0

perPage

integer

default:1000

Required range: x >= 1

updatedSince

string<date-time>

Only responses updated at or after this timestamp.

includeInProgress

boolean

default:true

Response

Responses

string<uuid>

required

readableId

integer

required

Required range: x > 0

createdAt

string

required

updatedAt

string

required

progress

enum<string>

required

Available options:

complete,

screened_out,

in_progress

responseDurationSeconds

integer

required

Required range: x >= 0

answers

object

required

Show child attributes

answersArray

object[]

required

Show child attributes

urlParams

object

required

Show child attributes

shortTranscript

string | null

required

tagline

string | null

required

bulletSummary

string[]

required