Retrieve Responses

Use this endpoint to retrieve responses from your studies. This endpoint allows you to retrieve up to 1000 responses at a time.

GET /v1/responses

Retrieve Responses

cURL

curl --request GET \
  --url https://api.sprig.com/v1/responses \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.sprig.com/v1/responses"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.sprig.com/v1/responses', 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://api.sprig.com/v1/responses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$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://api.sprig.com/v1/responses"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sprig.com/v1/responses")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sprig.com/v1/responses")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

200

consent/legal example

{
  "cursor": "cursor",
  "data": [
    {
      "createdAt": "2023-10-19T17:04:26.253Z",
      "externalUserId": null,
      "questionId": 2,
      "questionText": "Consent / Legal Question",
      "questionType": "CONSENTLEGAL",
      "response": {
        "submitted": true
      },
      "responseGroupUid": "9fa86a17-82b1-423a-979a-30ee35ada562",
      "surveyId": 1,
      "updatedAt": "2023-10-19T17:04:26.253Z",
      "visitorId": 0,
      "visitorUuid": "3b7b4806-c082-4f0c-a8f0-b869121f47cb"
    }
  ]
}

Headers

Authorization · string · required

Bearer YOUR_API_KEY

Query Parameters

start · integer

The earliest creation data for a generated theme to return, represented as milliseconds from epoch time

end · integer

The latest creation date for a generated theme to return, represented as milleseconds from epoch time

cursor · string

A Base64 encoded string representing an opaque cursor position

limit · integer

Specific number of results to return

Required range: 1 <= x <= 1000

sid · integer

An integer id for a specific Survey

with_snapshots · boolean

true/false(default). If true, the API will return visitorSnapshots, which contains all events, attributes, triggeringEvent, and eventProperties set for the visitor at the time of survey delivery.

with_urls · boolean

true/false (default). If true, the API will return the page URL from which the survey was taken.

with_meta · boolean

true/false (default). If true, the API will return the metadata JSON blob containing details available from the client.

with_custom_metadata · boolean

true/false (default). If true, the API will return any custom metadata associated with the response (applicable to link platform surveys only).

with_deleted_responses · boolean

true/false (default). If true, the API will return the responses that have been previously deleted.

Response

200

application/json

OK

cursor · string

Minimum string length: 1

data · object[]

Minimum array length: 1

Show child attributes