Text responses for project

curl --request POST \
  --url https://text.sightx.io/text-service/text \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromDate": "2020-01-01",
  "toDate": "2022-12-31",
  "filter": [],
  "questionProjection": [
    "qQuestionId"
  ]
}
'

import requests

url = "https://text.sightx.io/text-service/text"

payload = {
    "fromDate": "2020-01-01",
    "toDate": "2022-12-31",
    "filter": [],
    "questionProjection": ["qQuestionId"]
}
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({
    fromDate: '2020-01-01',
    toDate: '2022-12-31',
    filter: [],
    questionProjection: ['qQuestionId']
  })
};

fetch('https://text.sightx.io/text-service/text', 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://text.sightx.io/text-service/text",
  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([
    'fromDate' => '2020-01-01',
    'toDate' => '2022-12-31',
    'filter' => [
        
    ],
    'questionProjection' => [
        'qQuestionId'
    ]
  ]),
  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://text.sightx.io/text-service/text"

	payload := strings.NewReader("{\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"questionProjection\": [\n    \"qQuestionId\"\n  ]\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://text.sightx.io/text-service/text")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"questionProjection\": [\n    \"qQuestionId\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://text.sightx.io/text-service/text")

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  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"questionProjection\": [\n    \"qQuestionId\"\n  ]\n}"

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

{
  "projectId": "60de2ba329a7230061e209f6",
  "fromDate": "2020-01-01",
  "toDate": "2022-12-31",
  "filter": [],
  "responses": {
    "q60de3468ffcabb005be2974a": [
      "asdasd",
      "qweqweqw"
    ],
    "q60de347a29a7230061e20b93": [
      "asdasd",
      "10"
    ],
    "q60de348129a7230061e20b98": [
      "asdasd",
      "21"
    ],
    "q60de3468ffcabb005be2974b": [
      "234234",
      "awesome",
      "Chevere puma"
    ],
    "q60de347a29a7230061e20b94": [
      "qwewqeq",
      "good",
      "Chevere puma"
    ],
    "q60de348129a7230061e20b99": [
      "qeqww",
      "bad",
      "bacan Chevere puma"
    ],
    "q60de3528ffcabb005be2983a": [
      "234",
      "tytyty",
      "none",
      "it is extreme",
      "surf",
      "bad",
      "Water",
      "Lorem ipsum"
    ],
    "q60de3528ffcabb005be2983b": [
      "345",
      "rtr",
      "none",
      "really nice",
      "surf",
      "cool",
      "10",
      "otra vez surf"
    ],
    "q60de3528ffcabb005be2983c": [
      "23",
      "rtrtrt",
      "none",
      "red",
      "surf",
      "terrible",
      "90",
      "Lorem ipsum SUrf"
    ],
    "q60de3564ffcabb005be29b0c": [
      "2342",
      "124323",
      "none",
      "I love it",
      "soccer",
      "not sure",
      "as",
      "Sokser"
    ],
    "q60de3564ffcabb005be29b0d": [
      "234",
      "213",
      "none",
      "yes ",
      "soccer",
      "great",
      "as",
      "design Sokser"
    ],
    "q60de3564ffcabb005be29b0e": [
      "343",
      "123",
      "none",
      "white",
      "soccer",
      "awful",
      "as",
      "colors Sokser"
    ],
    "q60de3564ffcabb005be29b1d": [
      "2342",
      "89",
      "none",
      "funny",
      "basketball",
      "not sure",
      "12",
      "Canasta"
    ],
    "q60de3564ffcabb005be29b1e": [
      "234",
      "56",
      "none",
      "it is really good",
      "basketball",
      "awesome",
      "des",
      "Canasta"
    ],
    "q60de3564ffcabb005be29b1f": [
      "2342",
      "42",
      "none",
      "black",
      "basketball",
      "amazing",
      "ign",
      "COlor canasta"
    ],
    "q60de355bffcabb005be29ad8": [
      "qweqw",
      "none",
      "it is rude",
      "12"
    ],
    "q60de355bffcabb005be29ad9": [
      "qweq",
      "none",
      "it is bored",
      "12"
    ],
    "q60de355bffcabb005be29ada": [
      "qweq",
      "none",
      "white",
      "22"
    ],
    "q60de3564ffcabb005be29b2f": [
      "qweqwe",
      "yuiyui",
      "none",
      "It is cool",
      "once a month",
      "not sure",
      "Ni idea"
    ],
    "q60de3564ffcabb005be29b30": [
      "qweqweqeq",
      "uyiy",
      "none",
      "sure",
      "once a month",
      "cool",
      "Deisgn ni idea"
    ],
    "q60de3564ffcabb005be29b31": [
      "asdadasd",
      "yuiyu",
      "none",
      "black",
      "once a month",
      "great",
      "dasdadas"
    ],
    "q60de3564ffcabb005be29b40": [
      "123123",
      "78",
      "it happens once a week",
      "Once a week",
      "fsdfsd"
    ],
    "q60de3564ffcabb005be29b41": [
      "234",
      "98",
      "sure",
      "Once a week",
      "gdfg dgfg"
    ],
    "q60de3564ffcabb005be29b42": [
      "2qweq",
      "23",
      "nice",
      "Once a week",
      "gdfg dgf g"
    ],
    "q60de3564ffcabb005be29b51": [
      "89",
      "Daily",
      "so cool",
      "dsily"
    ],
    "q60de3564ffcabb005be29b52": [
      "89",
      "Daily",
      "nice",
      "werw"
    ],
    "q60de3564ffcabb005be29b53": [
      "54",
      "Daily",
      "awesome",
      "rwerwecw. wer wer"
    ],
    "q60de3468ffcabb005be29749": [
      "nice"
    ],
    "q60de347a29a7230061e20b92": [
      "nothing"
    ],
    "q60de348129a7230061e20b97": [
      "more  nothing"
    ],
    "q60de3468ffcabb005be29748": [
      "it is good ",
      "nike",
      "Just do it"
    ],
    "q60de347429a7230061e20b8d": [
      "It is good",
      "nike",
      "Wow"
    ],
    "q60de348129a7230061e20b96": [
      "not bad",
      "nike",
      "Wonderful"
    ]
  }
}

Analysis / Question Dashboard

Text responses for project

Description

Retrieve responses for all text questions in a project.

Payload

{
    "fromDate": string,
    "toDate": string,
    "filter": array,
    "questionProjection": [string]
}

where:

fromDate: start date of responses to query. (Required).
toDate: end date of responses to query. (Required).
filter: array of questions to filter responses by. (Optional).
questionProjection: array of unique identifiers of text questions. Each question ID is prepended with a “q”. (Required).

Responses

200 OK

{
    "projectId": "string",
    "fromDate": "date (string)",
    "toDate": "date (string)",
    "filter": array,
    "responses": {
        "q000000000000000000000000": [
            "response1 (string)",
            "response2 (string)"
        ],
        "q000000000000000000000001": [
            "response1 (string)",
            "response2 (string)"
        ]
    }
}

where:

projectId: unique identifier of the project.
fromDate: start date of responses to query.
toDate: end date of responses to query.
filter: array of questions to filter responses by.
responses: object mapping unique question identifiers to arrays of text responses.

400 Bad Request

Missing or invalid required fields.

401 Unauthorized

Invalid authorization.

404 Not Found

Resource not found.

500 Internal Server Error

Error occurred in text-service microservice.

POST

text-service

text

Text responses for project

curl --request POST \
  --url https://text.sightx.io/text-service/text \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromDate": "2020-01-01",
  "toDate": "2022-12-31",
  "filter": [],
  "questionProjection": [
    "qQuestionId"
  ]
}
'

import requests

url = "https://text.sightx.io/text-service/text"

payload = {
    "fromDate": "2020-01-01",
    "toDate": "2022-12-31",
    "filter": [],
    "questionProjection": ["qQuestionId"]
}
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({
    fromDate: '2020-01-01',
    toDate: '2022-12-31',
    filter: [],
    questionProjection: ['qQuestionId']
  })
};

fetch('https://text.sightx.io/text-service/text', 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://text.sightx.io/text-service/text",
  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([
    'fromDate' => '2020-01-01',
    'toDate' => '2022-12-31',
    'filter' => [
        
    ],
    'questionProjection' => [
        'qQuestionId'
    ]
  ]),
  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://text.sightx.io/text-service/text"

	payload := strings.NewReader("{\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"questionProjection\": [\n    \"qQuestionId\"\n  ]\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://text.sightx.io/text-service/text")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"questionProjection\": [\n    \"qQuestionId\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://text.sightx.io/text-service/text")

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  \"fromDate\": \"2020-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"questionProjection\": [\n    \"qQuestionId\"\n  ]\n}"

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

{
  "projectId": "60de2ba329a7230061e209f6",
  "fromDate": "2020-01-01",
  "toDate": "2022-12-31",
  "filter": [],
  "responses": {
    "q60de3468ffcabb005be2974a": [
      "asdasd",
      "qweqweqw"
    ],
    "q60de347a29a7230061e20b93": [
      "asdasd",
      "10"
    ],
    "q60de348129a7230061e20b98": [
      "asdasd",
      "21"
    ],
    "q60de3468ffcabb005be2974b": [
      "234234",
      "awesome",
      "Chevere puma"
    ],
    "q60de347a29a7230061e20b94": [
      "qwewqeq",
      "good",
      "Chevere puma"
    ],
    "q60de348129a7230061e20b99": [
      "qeqww",
      "bad",
      "bacan Chevere puma"
    ],
    "q60de3528ffcabb005be2983a": [
      "234",
      "tytyty",
      "none",
      "it is extreme",
      "surf",
      "bad",
      "Water",
      "Lorem ipsum"
    ],
    "q60de3528ffcabb005be2983b": [
      "345",
      "rtr",
      "none",
      "really nice",
      "surf",
      "cool",
      "10",
      "otra vez surf"
    ],
    "q60de3528ffcabb005be2983c": [
      "23",
      "rtrtrt",
      "none",
      "red",
      "surf",
      "terrible",
      "90",
      "Lorem ipsum SUrf"
    ],
    "q60de3564ffcabb005be29b0c": [
      "2342",
      "124323",
      "none",
      "I love it",
      "soccer",
      "not sure",
      "as",
      "Sokser"
    ],
    "q60de3564ffcabb005be29b0d": [
      "234",
      "213",
      "none",
      "yes ",
      "soccer",
      "great",
      "as",
      "design Sokser"
    ],
    "q60de3564ffcabb005be29b0e": [
      "343",
      "123",
      "none",
      "white",
      "soccer",
      "awful",
      "as",
      "colors Sokser"
    ],
    "q60de3564ffcabb005be29b1d": [
      "2342",
      "89",
      "none",
      "funny",
      "basketball",
      "not sure",
      "12",
      "Canasta"
    ],
    "q60de3564ffcabb005be29b1e": [
      "234",
      "56",
      "none",
      "it is really good",
      "basketball",
      "awesome",
      "des",
      "Canasta"
    ],
    "q60de3564ffcabb005be29b1f": [
      "2342",
      "42",
      "none",
      "black",
      "basketball",
      "amazing",
      "ign",
      "COlor canasta"
    ],
    "q60de355bffcabb005be29ad8": [
      "qweqw",
      "none",
      "it is rude",
      "12"
    ],
    "q60de355bffcabb005be29ad9": [
      "qweq",
      "none",
      "it is bored",
      "12"
    ],
    "q60de355bffcabb005be29ada": [
      "qweq",
      "none",
      "white",
      "22"
    ],
    "q60de3564ffcabb005be29b2f": [
      "qweqwe",
      "yuiyui",
      "none",
      "It is cool",
      "once a month",
      "not sure",
      "Ni idea"
    ],
    "q60de3564ffcabb005be29b30": [
      "qweqweqeq",
      "uyiy",
      "none",
      "sure",
      "once a month",
      "cool",
      "Deisgn ni idea"
    ],
    "q60de3564ffcabb005be29b31": [
      "asdadasd",
      "yuiyu",
      "none",
      "black",
      "once a month",
      "great",
      "dasdadas"
    ],
    "q60de3564ffcabb005be29b40": [
      "123123",
      "78",
      "it happens once a week",
      "Once a week",
      "fsdfsd"
    ],
    "q60de3564ffcabb005be29b41": [
      "234",
      "98",
      "sure",
      "Once a week",
      "gdfg dgfg"
    ],
    "q60de3564ffcabb005be29b42": [
      "2qweq",
      "23",
      "nice",
      "Once a week",
      "gdfg dgf g"
    ],
    "q60de3564ffcabb005be29b51": [
      "89",
      "Daily",
      "so cool",
      "dsily"
    ],
    "q60de3564ffcabb005be29b52": [
      "89",
      "Daily",
      "nice",
      "werw"
    ],
    "q60de3564ffcabb005be29b53": [
      "54",
      "Daily",
      "awesome",
      "rwerwecw. wer wer"
    ],
    "q60de3468ffcabb005be29749": [
      "nice"
    ],
    "q60de347a29a7230061e20b92": [
      "nothing"
    ],
    "q60de348129a7230061e20b97": [
      "more  nothing"
    ],
    "q60de3468ffcabb005be29748": [
      "it is good ",
      "nike",
      "Just do it"
    ],
    "q60de347429a7230061e20b8d": [
      "It is good",
      "nike",
      "Wow"
    ],
    "q60de348129a7230061e20b96": [
      "not bad",
      "nike",
      "Wonderful"
    ]
  }
}

Description

Retrieve responses for all text questions in a project.

Payload

{
    "fromDate": string,
    "toDate": string,
    "filter": array,
    "questionProjection": [string]
}

where:

fromDate: start date of responses to query. (Required).
toDate: end date of responses to query. (Required).
filter: array of questions to filter responses by. (Optional).
questionProjection: array of unique identifiers of text questions. Each question ID is prepended with a “q”. (Required).

Responses

200 OK

{
    "projectId": "string",
    "fromDate": "date (string)",
    "toDate": "date (string)",
    "filter": array,
    "responses": {
        "q000000000000000000000000": [
            "response1 (string)",
            "response2 (string)"
        ],
        "q000000000000000000000001": [
            "response1 (string)",
            "response2 (string)"
        ]
    }
}

where:

projectId: unique identifier of the project.
fromDate: start date of responses to query.
toDate: end date of responses to query.
filter: array of questions to filter responses by.
responses: object mapping unique question identifiers to arrays of text responses.

400 Bad Request

Missing or invalid required fields.

401 Unauthorized

Invalid authorization.

404 Not Found

Resource not found.

500 Internal Server Error

Error occurred in text-service microservice.

Query Parameters

Parameter	Description	Required	Example
`projectId`	—	No	—

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

Query Parameters

projectId

string

Body

application/json

The body is of type object.

Response

Text responses for project

The response is of type object.

Fetch Analysis (numeric)Fetch Analysis (conjoint)

⌘I

​Description

​Payload

​Responses

​200 OK

​400 Bad Request

​401 Unauthorized

​404 Not Found

​500 Internal Server Error

Query Parameters

Authorizations

Headers

Query Parameters

Body

Response

Description

Payload

Responses

200 OK

400 Bad Request

401 Unauthorized

404 Not Found

500 Internal Server Error