Export responses as json

curl --request POST \
  --url https://responses-export-import.sightx.io/api/export/json \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "50c957e3f3e4670e361b5fca",
  "campaignId": "50c957e3f3e4670e361b5fcb",
  "fromDate": "2020-01-01",
  "toDate": "2022-12-31",
  "offset": 0,
  "limit": 100,
  "onlyCount": false
}
'

import requests

url = "https://responses-export-import.sightx.io/api/export/json"

payload = {
    "projectId": "50c957e3f3e4670e361b5fca",
    "campaignId": "50c957e3f3e4670e361b5fcb",
    "fromDate": "2020-01-01",
    "toDate": "2022-12-31",
    "offset": 0,
    "limit": 100,
    "onlyCount": False
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: '50c957e3f3e4670e361b5fca',
    campaignId: '50c957e3f3e4670e361b5fcb',
    fromDate: '2020-01-01',
    toDate: '2022-12-31',
    offset: 0,
    limit: 100,
    onlyCount: false
  })
};

fetch('https://responses-export-import.sightx.io/api/export/json', 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://responses-export-import.sightx.io/api/export/json",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'projectId' => '50c957e3f3e4670e361b5fca',
    'campaignId' => '50c957e3f3e4670e361b5fcb',
    'fromDate' => '2020-01-01',
    'toDate' => '2022-12-31',
    'offset' => 0,
    'limit' => 100,
    'onlyCount' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://responses-export-import.sightx.io/api/export/json"

	payload := strings.NewReader("{\n  \"projectId\": \"50c957e3f3e4670e361b5fca\",\n  \"campaignId\": \"50c957e3f3e4670e361b5fcb\",\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"offset\": 0,\n  \"limit\": 100,\n  \"onlyCount\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://responses-export-import.sightx.io/api/export/json")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"50c957e3f3e4670e361b5fca\",\n  \"campaignId\": \"50c957e3f3e4670e361b5fcb\",\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"offset\": 0,\n  \"limit\": 100,\n  \"onlyCount\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://responses-export-import.sightx.io/api/export/json")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"projectId\": \"50c957e3f3e4670e361b5fca\",\n  \"campaignId\": \"50c957e3f3e4670e361b5fcb\",\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"offset\": 0,\n  \"limit\": 100,\n  \"onlyCount\": false\n}"

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

Responses / Export

Export responses as json

Description

Gets a single response full data.

Body

{
   "projectId": "50c957e3f3e4670e361b5fca",
   "campaignId": "50c957e3f3e4670e361b5fcb",
   "fromDate": "2020-01-01",
   "toDate": "2022-12-31",
   "offset": 0,
   "limit": 100,
   "onlyCount": true
}

where:

projectId: The id of the project.
campaignId: The id of the campaign. Don’t send this field to get responses from all campaigns.
fromDate: The initial date of the responses data desired.
toDate: The final date of the responses data desired.
offset: numeric. From what response to export (using for pagination).
limit: Boolean. How much response to export, the maximun for this value is 100 (using for pagination).
onlyCount: when it is set to true, the endpoint only returns the amount of responses available

Response

200 OK

[{
   "answers": {
      "questionId": {
         "na": boolean,
         "values": array|object|null,
         "value": array|number|string|null,
      },
   },
   "timeToComplete": number,
   "id": string,
   "projectId": string,
   "createdAt": string,
   "channel": string,
   "campaignId": string,
   "serverCreationDate": string,
   "requestInfo": object,
   "code": string,
   "conceptTestsDisplayed": {
      "conceptTestId": [
         "conceptId"
      ]
   },
   "headers": object,
   "urlHash": string,
   "isAdmin": boolean,
   "uuid": string,
   "completenessPercent": number,
   "questionsDisplayedCount": number,
   "responsesCount": number
},
...
]

where:

answers: Object containing the responses of the questions answered by the respondent. The format of each response may vary according to the type of the question.
timeToComplete: Time in seconds that the respondent took to complete the survey.
id: The unique id of the response.
projectId: The id of the project.
createdAt: The timestamp when the response was submitted.
channel: The distribution channel through the survey was sent to the respondent.
campaignId: The id of the campaign.
serverCreationDate: The date in UTC format when the response was submitted.
requestInfo: The location info of the request that was made when the response was submitted.
code: The unique and short code assigned to the response.
conceptTestsDisplayed: The concept tests that were displayed to the respondent.
headers: The headers info of the request that was made when the response was submitted.
urlHash: The public url hash to identify the survey. Used in the public survey link.
isAdmin: A flag to know if the response was submitted with the admin link.
uuid: Unique code generated to avoid duplicates.
completenessPercent: The percentage of completion of the survey. Calculated with questionsDisplayedCount and responsesCount.
questionsDisplayedCount: The amount of questions displayed to the respondent in the survey.
responsesCount: The amount of questions actually answered by the respondent in the survey.

401 Unauthorized

The user doesn’t have permissions.

500 Internal Server Error

Error occurred while processing the request.

POST

api

export

json

Export responses as json

curl --request POST \
  --url https://responses-export-import.sightx.io/api/export/json \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "50c957e3f3e4670e361b5fca",
  "campaignId": "50c957e3f3e4670e361b5fcb",
  "fromDate": "2020-01-01",
  "toDate": "2022-12-31",
  "offset": 0,
  "limit": 100,
  "onlyCount": false
}
'

import requests

url = "https://responses-export-import.sightx.io/api/export/json"

payload = {
    "projectId": "50c957e3f3e4670e361b5fca",
    "campaignId": "50c957e3f3e4670e361b5fcb",
    "fromDate": "2020-01-01",
    "toDate": "2022-12-31",
    "offset": 0,
    "limit": 100,
    "onlyCount": False
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: '50c957e3f3e4670e361b5fca',
    campaignId: '50c957e3f3e4670e361b5fcb',
    fromDate: '2020-01-01',
    toDate: '2022-12-31',
    offset: 0,
    limit: 100,
    onlyCount: false
  })
};

fetch('https://responses-export-import.sightx.io/api/export/json', 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://responses-export-import.sightx.io/api/export/json",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'projectId' => '50c957e3f3e4670e361b5fca',
    'campaignId' => '50c957e3f3e4670e361b5fcb',
    'fromDate' => '2020-01-01',
    'toDate' => '2022-12-31',
    'offset' => 0,
    'limit' => 100,
    'onlyCount' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://responses-export-import.sightx.io/api/export/json"

	payload := strings.NewReader("{\n  \"projectId\": \"50c957e3f3e4670e361b5fca\",\n  \"campaignId\": \"50c957e3f3e4670e361b5fcb\",\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"offset\": 0,\n  \"limit\": 100,\n  \"onlyCount\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://responses-export-import.sightx.io/api/export/json")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"50c957e3f3e4670e361b5fca\",\n  \"campaignId\": \"50c957e3f3e4670e361b5fcb\",\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"offset\": 0,\n  \"limit\": 100,\n  \"onlyCount\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://responses-export-import.sightx.io/api/export/json")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"projectId\": \"50c957e3f3e4670e361b5fca\",\n  \"campaignId\": \"50c957e3f3e4670e361b5fcb\",\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"offset\": 0,\n  \"limit\": 100,\n  \"onlyCount\": false\n}"

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

Description

Gets a single response full data.

Body

{
   "projectId": "50c957e3f3e4670e361b5fca",
   "campaignId": "50c957e3f3e4670e361b5fcb",
   "fromDate": "2020-01-01",
   "toDate": "2022-12-31",
   "offset": 0,
   "limit": 100,
   "onlyCount": true
}

where:

projectId: The id of the project.
campaignId: The id of the campaign. Don’t send this field to get responses from all campaigns.
fromDate: The initial date of the responses data desired.
toDate: The final date of the responses data desired.
offset: numeric. From what response to export (using for pagination).
limit: Boolean. How much response to export, the maximun for this value is 100 (using for pagination).
onlyCount: when it is set to true, the endpoint only returns the amount of responses available

Response

200 OK

[{
   "answers": {
      "questionId": {
         "na": boolean,
         "values": array|object|null,
         "value": array|number|string|null,
      },
   },
   "timeToComplete": number,
   "id": string,
   "projectId": string,
   "createdAt": string,
   "channel": string,
   "campaignId": string,
   "serverCreationDate": string,
   "requestInfo": object,
   "code": string,
   "conceptTestsDisplayed": {
      "conceptTestId": [
         "conceptId"
      ]
   },
   "headers": object,
   "urlHash": string,
   "isAdmin": boolean,
   "uuid": string,
   "completenessPercent": number,
   "questionsDisplayedCount": number,
   "responsesCount": number
},
...
]

where:

answers: Object containing the responses of the questions answered by the respondent. The format of each response may vary according to the type of the question.
timeToComplete: Time in seconds that the respondent took to complete the survey.
id: The unique id of the response.
projectId: The id of the project.
createdAt: The timestamp when the response was submitted.
channel: The distribution channel through the survey was sent to the respondent.
campaignId: The id of the campaign.
serverCreationDate: The date in UTC format when the response was submitted.
requestInfo: The location info of the request that was made when the response was submitted.
code: The unique and short code assigned to the response.
conceptTestsDisplayed: The concept tests that were displayed to the respondent.
headers: The headers info of the request that was made when the response was submitted.
urlHash: The public url hash to identify the survey. Used in the public survey link.
isAdmin: A flag to know if the response was submitted with the admin link.
uuid: Unique code generated to avoid duplicates.
completenessPercent: The percentage of completion of the survey. Calculated with questionsDisplayedCount and responsesCount.
questionsDisplayedCount: The amount of questions displayed to the respondent in the survey.
responsesCount: The amount of questions actually answered by the respondent in the survey.

401 Unauthorized

The user doesn’t have permissions.

500 Internal Server Error

Error occurred while processing the request.

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

string

Body

application/json

The body is of type object.

Response

Successful response

Export responses as Excel file Export SPSS file

⌘I

​Description

​Body

​Response

​200 OK

​401 Unauthorized

​500 Internal Server Error

Authorizations

Headers

Body

Response

Description

Body

Response

200 OK

401 Unauthorized

500 Internal Server Error