Fetch Analysis (multiple choice)

curl --request POST \
  --url https://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromDate": "2019-01-01",
  "toDate": "2022-12-31",
  "filter": [],
  "groups": {
    "qQuestionId": [
      "qRelatedQuestionId1"
    ]
  },
  "aggregateOptions": {
    "questionId": {
      "optionPosition1": [
        1,
        2
      ],
      "optionPosition2": [
        6,
        7
      ]
    }
  },
  "excludeQuestions": [
    "excludedQuestionId"
  ]
}
'

import requests

url = "https://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis"

payload = {
    "fromDate": "2019-01-01",
    "toDate": "2022-12-31",
    "filter": [],
    "groups": { "qQuestionId": ["qRelatedQuestionId1"] },
    "aggregateOptions": { "questionId": {
            "optionPosition1": [1, 2],
            "optionPosition2": [6, 7]
        } },
    "excludeQuestions": ["excludedQuestionId"]
}
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: '2019-01-01',
    toDate: '2022-12-31',
    filter: [],
    groups: {qQuestionId: ['qRelatedQuestionId1']},
    aggregateOptions: {questionId: {optionPosition1: [1, 2], optionPosition2: [6, 7]}},
    excludeQuestions: ['excludedQuestionId']
  })
};

fetch('https://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis', 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://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis",
  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' => '2019-01-01',
    'toDate' => '2022-12-31',
    'filter' => [
        
    ],
    'groups' => [
        'qQuestionId' => [
                'qRelatedQuestionId1'
        ]
    ],
    'aggregateOptions' => [
        'questionId' => [
                'optionPosition1' => [
                                1,
                                2
                ],
                'optionPosition2' => [
                                6,
                                7
                ]
        ]
    ],
    'excludeQuestions' => [
        'excludedQuestionId'
    ]
  ]),
  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://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis"

	payload := strings.NewReader("{\n  \"fromDate\": \"2019-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"groups\": {\n    \"qQuestionId\": [\n      \"qRelatedQuestionId1\"\n    ]\n  },\n  \"aggregateOptions\": {\n    \"questionId\": {\n      \"optionPosition1\": [\n        1,\n        2\n      ],\n      \"optionPosition2\": [\n        6,\n        7\n      ]\n    }\n  },\n  \"excludeQuestions\": [\n    \"excludedQuestionId\"\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://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fromDate\": \"2019-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"groups\": {\n    \"qQuestionId\": [\n      \"qRelatedQuestionId1\"\n    ]\n  },\n  \"aggregateOptions\": {\n    \"questionId\": {\n      \"optionPosition1\": [\n        1,\n        2\n      ],\n      \"optionPosition2\": [\n        6,\n        7\n      ]\n    }\n  },\n  \"excludeQuestions\": [\n    \"excludedQuestionId\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis")

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\": \"2019-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"groups\": {\n    \"qQuestionId\": [\n      \"qRelatedQuestionId1\"\n    ]\n  },\n  \"aggregateOptions\": {\n    \"questionId\": {\n      \"optionPosition1\": [\n        1,\n        2\n      ],\n      \"optionPosition2\": [\n        6,\n        7\n      ]\n    }\n  },\n  \"excludeQuestions\": [\n    \"excludedQuestionId\"\n  ]\n}"

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

{
  "projectId": "60de2ba329a7230061e209f6",
  "fromDate": "2019-01-01",
  "toDate": "2022-12-31",
  "filter": [],
  "dateFilters": [
    {
      "collection": "year",
      "start": "2019-01-01",
      "end": "2022-12-31"
    }
  ],
  "responsesCounter": 8,
  "responsesCounters": {
    "undefined": 167
  },
  "responsesByQuestionCounter": {
    "undefined": 167
  },
  "responses": {
    "qQuestionId": {
      "responses": 0,
      "mean": "NaN",
      "median": 0,
      "mode": [],
      "variance": "NaN",
      "standardDeviation": "NaN",
      "frecuency": [],
      "percent": [],
      "cumulativeFrecuency": [],
      "cumulativeFrecuencyByVotes": [],
      "cumulativePercent": [],
      "cumulativePercentByVotes": []
    },
    "other": {}
  }
}

Analysis / Question Dashboard

Fetch Analysis (multiple choice)

Description

Get analysis data for multiple choice questions.

Payload

{
    "fromDate": string,
    "toDate": string,
    "filter": array,
    "groups": object
    "aggregateOptions": object,
    "excludeQuestions": array
}

where:

fromDate: start date in ISO format. Required.
toDate: end date in ISO format. Required.
filter: array of filters to filter the responses. Optional.
groups: Object indexed by question id with a q as prefix. Every key has assigned an array with the question ids with q prefix that are the same question through different concepts inside a concept test. Only needed for project with Concept Tests or Question Loops. Optional.
aggregateOptions: Used when filtering with a bucket. Specifies the bucket configuration applied. Optional.
excludeQuestions: Array of question ids. Questions specified in this array belong to a Contact Info item, specifically the country and state questions that should be excluded from analysis. Optional.

Response

200 OK

{
  "projectId": string,
  "fromDate": string,
  "toDate": string,
  "filter": array,
  "dateFilters": [
    {
      "collection": string,
      "start": string,
      "end": string
    }
  ],
  "responsesCounter": number,
  "responsesCounters": {
    "qQuestionId": number,
  },
  "responsesByQuestionCounter": {
    "qQuestionId": 5,
  },
  "responses": {
    "qQuestionId": object
  }
}

where:

projectId: unique identifier of the project.
fromDate: start date received as param to the query in ISO format.
toDate: end date received as param to the query in ISO format.
dateFilters: Array of date filters used for querying the responses.
filter: Array of filters sent in the request.
responses: object mapping unique question identifiers to analysis data for every question.
responsesCounter: Integer representing the number of responses for the given filter.
responsesCounters: Object containing the number of responses per question for the given filter.

400 Bad Request

Missing or invalid projectId/fromDate/toDate fields.

401 Unauthorized

Invalid authorization.

404 Not Found

Resource not found.

500 Internal Server Error

Error occurred in the service.

POST

multiple-question-analysis-service

analysis

Fetch Analysis (multiple choice)

curl --request POST \
  --url https://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromDate": "2019-01-01",
  "toDate": "2022-12-31",
  "filter": [],
  "groups": {
    "qQuestionId": [
      "qRelatedQuestionId1"
    ]
  },
  "aggregateOptions": {
    "questionId": {
      "optionPosition1": [
        1,
        2
      ],
      "optionPosition2": [
        6,
        7
      ]
    }
  },
  "excludeQuestions": [
    "excludedQuestionId"
  ]
}
'

import requests

url = "https://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis"

payload = {
    "fromDate": "2019-01-01",
    "toDate": "2022-12-31",
    "filter": [],
    "groups": { "qQuestionId": ["qRelatedQuestionId1"] },
    "aggregateOptions": { "questionId": {
            "optionPosition1": [1, 2],
            "optionPosition2": [6, 7]
        } },
    "excludeQuestions": ["excludedQuestionId"]
}
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: '2019-01-01',
    toDate: '2022-12-31',
    filter: [],
    groups: {qQuestionId: ['qRelatedQuestionId1']},
    aggregateOptions: {questionId: {optionPosition1: [1, 2], optionPosition2: [6, 7]}},
    excludeQuestions: ['excludedQuestionId']
  })
};

fetch('https://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis', 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://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis",
  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' => '2019-01-01',
    'toDate' => '2022-12-31',
    'filter' => [
        
    ],
    'groups' => [
        'qQuestionId' => [
                'qRelatedQuestionId1'
        ]
    ],
    'aggregateOptions' => [
        'questionId' => [
                'optionPosition1' => [
                                1,
                                2
                ],
                'optionPosition2' => [
                                6,
                                7
                ]
        ]
    ],
    'excludeQuestions' => [
        'excludedQuestionId'
    ]
  ]),
  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://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis"

	payload := strings.NewReader("{\n  \"fromDate\": \"2019-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"groups\": {\n    \"qQuestionId\": [\n      \"qRelatedQuestionId1\"\n    ]\n  },\n  \"aggregateOptions\": {\n    \"questionId\": {\n      \"optionPosition1\": [\n        1,\n        2\n      ],\n      \"optionPosition2\": [\n        6,\n        7\n      ]\n    }\n  },\n  \"excludeQuestions\": [\n    \"excludedQuestionId\"\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://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fromDate\": \"2019-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"groups\": {\n    \"qQuestionId\": [\n      \"qRelatedQuestionId1\"\n    ]\n  },\n  \"aggregateOptions\": {\n    \"questionId\": {\n      \"optionPosition1\": [\n        1,\n        2\n      ],\n      \"optionPosition2\": [\n        6,\n        7\n      ]\n    }\n  },\n  \"excludeQuestions\": [\n    \"excludedQuestionId\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://multiple-question-analysis.sightx.io/multiple-question-analysis-service/analysis")

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\": \"2019-01-01\",\n  \"toDate\": \"2022-12-31\",\n  \"filter\": [],\n  \"groups\": {\n    \"qQuestionId\": [\n      \"qRelatedQuestionId1\"\n    ]\n  },\n  \"aggregateOptions\": {\n    \"questionId\": {\n      \"optionPosition1\": [\n        1,\n        2\n      ],\n      \"optionPosition2\": [\n        6,\n        7\n      ]\n    }\n  },\n  \"excludeQuestions\": [\n    \"excludedQuestionId\"\n  ]\n}"

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

{
  "projectId": "60de2ba329a7230061e209f6",
  "fromDate": "2019-01-01",
  "toDate": "2022-12-31",
  "filter": [],
  "dateFilters": [
    {
      "collection": "year",
      "start": "2019-01-01",
      "end": "2022-12-31"
    }
  ],
  "responsesCounter": 8,
  "responsesCounters": {
    "undefined": 167
  },
  "responsesByQuestionCounter": {
    "undefined": 167
  },
  "responses": {
    "qQuestionId": {
      "responses": 0,
      "mean": "NaN",
      "median": 0,
      "mode": [],
      "variance": "NaN",
      "standardDeviation": "NaN",
      "frecuency": [],
      "percent": [],
      "cumulativeFrecuency": [],
      "cumulativeFrecuencyByVotes": [],
      "cumulativePercent": [],
      "cumulativePercentByVotes": []
    },
    "other": {}
  }
}

Description

Get analysis data for multiple choice questions.

Payload

{
    "fromDate": string,
    "toDate": string,
    "filter": array,
    "groups": object
    "aggregateOptions": object,
    "excludeQuestions": array
}

where:

fromDate: start date in ISO format. Required.
toDate: end date in ISO format. Required.
filter: array of filters to filter the responses. Optional.
groups: Object indexed by question id with a q as prefix. Every key has assigned an array with the question ids with q prefix that are the same question through different concepts inside a concept test. Only needed for project with Concept Tests or Question Loops. Optional.
aggregateOptions: Used when filtering with a bucket. Specifies the bucket configuration applied. Optional.
excludeQuestions: Array of question ids. Questions specified in this array belong to a Contact Info item, specifically the country and state questions that should be excluded from analysis. Optional.

Response

200 OK

{
  "projectId": string,
  "fromDate": string,
  "toDate": string,
  "filter": array,
  "dateFilters": [
    {
      "collection": string,
      "start": string,
      "end": string
    }
  ],
  "responsesCounter": number,
  "responsesCounters": {
    "qQuestionId": number,
  },
  "responsesByQuestionCounter": {
    "qQuestionId": 5,
  },
  "responses": {
    "qQuestionId": object
  }
}

where:

projectId: unique identifier of the project.
fromDate: start date received as param to the query in ISO format.
toDate: end date received as param to the query in ISO format.
dateFilters: Array of date filters used for querying the responses.
filter: Array of filters sent in the request.
responses: object mapping unique question identifiers to analysis data for every question.
responsesCounter: Integer representing the number of responses for the given filter.
responsesCounters: Object containing the number of responses per question for the given filter.

400 Bad Request

Missing or invalid projectId/fromDate/toDate fields.

401 Unauthorized

Invalid authorization.

404 Not Found

Resource not found.

500 Internal Server Error

Error occurred in the service.

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

Authorization token

Query Parameters

projectId

string

Body

application/json

The body is of type object.

Response

Fetch Analysis

The response is of type object.

Get date of first response Fetch Analysis (Scale)

⌘I

​Description

​Payload

​Response

​200 OK

​400 Bad Request

​401 Unauthorized

​404 Not Found

​500 Internal Server Error

Query Parameters

Authorizations

Headers

Query Parameters

Body

Response

Description

Payload

Response

200 OK

400 Bad Request

401 Unauthorized

404 Not Found

500 Internal Server Error