Elastic search for pattern

curl --request POST \
  --url https://elasticsearch-api.sightx.io/elasticsearch-api/textSearch \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "{{projectId}}",
  "pattern": "string",
  "questionId": [
    "questionId",
    "questionId2"
  ],
  "wordType": "string",
  "sentiment": [
    "vpos",
    "pos",
    "neu",
    "neg",
    "vneg"
  ],
  "conceptTestsDisplayed": []
}
'

import requests

url = "https://elasticsearch-api.sightx.io/elasticsearch-api/textSearch"

payload = {
    "projectId": "{{projectId}}",
    "pattern": "string",
    "questionId": ["questionId", "questionId2"],
    "wordType": "string",
    "sentiment": ["vpos", "pos", "neu", "neg", "vneg"],
    "conceptTestsDisplayed": []
}
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: '{{projectId}}',
    pattern: 'string',
    questionId: ['questionId', 'questionId2'],
    wordType: 'string',
    sentiment: ['vpos', 'pos', 'neu', 'neg', 'vneg'],
    conceptTestsDisplayed: []
  })
};

fetch('https://elasticsearch-api.sightx.io/elasticsearch-api/textSearch', 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://elasticsearch-api.sightx.io/elasticsearch-api/textSearch",
  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' => '{{projectId}}',
    'pattern' => 'string',
    'questionId' => [
        'questionId',
        'questionId2'
    ],
    'wordType' => 'string',
    'sentiment' => [
        'vpos',
        'pos',
        'neu',
        'neg',
        'vneg'
    ],
    'conceptTestsDisplayed' => [
        
    ]
  ]),
  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://elasticsearch-api.sightx.io/elasticsearch-api/textSearch"

	payload := strings.NewReader("{\n  \"projectId\": \"{{projectId}}\",\n  \"pattern\": \"string\",\n  \"questionId\": [\n    \"questionId\",\n    \"questionId2\"\n  ],\n  \"wordType\": \"string\",\n  \"sentiment\": [\n    \"vpos\",\n    \"pos\",\n    \"neu\",\n    \"neg\",\n    \"vneg\"\n  ],\n  \"conceptTestsDisplayed\": []\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://elasticsearch-api.sightx.io/elasticsearch-api/textSearch")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"{{projectId}}\",\n  \"pattern\": \"string\",\n  \"questionId\": [\n    \"questionId\",\n    \"questionId2\"\n  ],\n  \"wordType\": \"string\",\n  \"sentiment\": [\n    \"vpos\",\n    \"pos\",\n    \"neu\",\n    \"neg\",\n    \"vneg\"\n  ],\n  \"conceptTestsDisplayed\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://elasticsearch-api.sightx.io/elasticsearch-api/textSearch")

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\": \"{{projectId}}\",\n  \"pattern\": \"string\",\n  \"questionId\": [\n    \"questionId\",\n    \"questionId2\"\n  ],\n  \"wordType\": \"string\",\n  \"sentiment\": [\n    \"vpos\",\n    \"pos\",\n    \"neu\",\n    \"neg\",\n    \"vneg\"\n  ],\n  \"conceptTestsDisplayed\": []\n}"

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

Analysis / Text Dashboard

Elastic search for pattern

Description

Query text responses given a pattern and optional sentiment filters. Optionally find synonyms or antonyms.

Payload

{
    "projectId": string,
    "pattern": string,
    "questionId": [string],
    "wordType": string,
    "sentiment": [
        "vpos",
        "pos",
        "neu",
        "neg",
        "vneg"
    ],
    "conceptTestsDisplayed": array
}

where:

projectId: unique identifier of the project. (Required).
pattern: term to query responses for. (Required).
questionId: single element array containing the unique identifier of the text question. (Required).
wordType: can be “none”, “synonym”, or “antonym”. “none” searches for the provided pattern, “synonym” searches for synonyms of the pattern, and “antonym” searches for antonyms of the pattern. If not specified, this will be treated as “none”. (Optional).
sentiment: an array containing any of the following elements: “vpos”, “pos”, “neu”, “neg”, and “vneg”. “vpos” is very positive, “pos” is positive, “neu” is neutral, “neg” is negative, and “vneg” is very negative. The service queries only responses with the selected sentiment parameters. (Required).
conceptTestsDisplayed: an array describing which responses within concept tests to query. (Optional).

Responses

200 OK

{
    "result": [
        {
            "matches": [
                "string"
            ],
            "fullText": "string",
            "sentiment": "string",
            "questionId": "string",
            "responseId": "string",
            "_score": "float"
        }
    ]
}

where:

result: array of objects, where each object is of the following structure:
- object:
  - matches: string array consisting of matches wrapped in html <em> tags.
  - fullText: full response text of the found match
  - sentiment: sentiment tag of the response of the found match (vpos, pos, neu, neg, vneg).
  - questionId: unique identifier of the text question.
  - responseId: unique identifier of the response of the found match.
  - _score: calculated score of the found match as a floating point number.

401 Unauthorized

Invalid authorization.

500 Internal Server Error

An error occurred processing the request.

502 Bad Gateway

Invalid or missing parameters, or other internal error.

POST

elasticsearch-api

textSearch

Elastic search for pattern

curl --request POST \
  --url https://elasticsearch-api.sightx.io/elasticsearch-api/textSearch \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "{{projectId}}",
  "pattern": "string",
  "questionId": [
    "questionId",
    "questionId2"
  ],
  "wordType": "string",
  "sentiment": [
    "vpos",
    "pos",
    "neu",
    "neg",
    "vneg"
  ],
  "conceptTestsDisplayed": []
}
'

import requests

url = "https://elasticsearch-api.sightx.io/elasticsearch-api/textSearch"

payload = {
    "projectId": "{{projectId}}",
    "pattern": "string",
    "questionId": ["questionId", "questionId2"],
    "wordType": "string",
    "sentiment": ["vpos", "pos", "neu", "neg", "vneg"],
    "conceptTestsDisplayed": []
}
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: '{{projectId}}',
    pattern: 'string',
    questionId: ['questionId', 'questionId2'],
    wordType: 'string',
    sentiment: ['vpos', 'pos', 'neu', 'neg', 'vneg'],
    conceptTestsDisplayed: []
  })
};

fetch('https://elasticsearch-api.sightx.io/elasticsearch-api/textSearch', 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://elasticsearch-api.sightx.io/elasticsearch-api/textSearch",
  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' => '{{projectId}}',
    'pattern' => 'string',
    'questionId' => [
        'questionId',
        'questionId2'
    ],
    'wordType' => 'string',
    'sentiment' => [
        'vpos',
        'pos',
        'neu',
        'neg',
        'vneg'
    ],
    'conceptTestsDisplayed' => [
        
    ]
  ]),
  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://elasticsearch-api.sightx.io/elasticsearch-api/textSearch"

	payload := strings.NewReader("{\n  \"projectId\": \"{{projectId}}\",\n  \"pattern\": \"string\",\n  \"questionId\": [\n    \"questionId\",\n    \"questionId2\"\n  ],\n  \"wordType\": \"string\",\n  \"sentiment\": [\n    \"vpos\",\n    \"pos\",\n    \"neu\",\n    \"neg\",\n    \"vneg\"\n  ],\n  \"conceptTestsDisplayed\": []\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://elasticsearch-api.sightx.io/elasticsearch-api/textSearch")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"{{projectId}}\",\n  \"pattern\": \"string\",\n  \"questionId\": [\n    \"questionId\",\n    \"questionId2\"\n  ],\n  \"wordType\": \"string\",\n  \"sentiment\": [\n    \"vpos\",\n    \"pos\",\n    \"neu\",\n    \"neg\",\n    \"vneg\"\n  ],\n  \"conceptTestsDisplayed\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://elasticsearch-api.sightx.io/elasticsearch-api/textSearch")

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\": \"{{projectId}}\",\n  \"pattern\": \"string\",\n  \"questionId\": [\n    \"questionId\",\n    \"questionId2\"\n  ],\n  \"wordType\": \"string\",\n  \"sentiment\": [\n    \"vpos\",\n    \"pos\",\n    \"neu\",\n    \"neg\",\n    \"vneg\"\n  ],\n  \"conceptTestsDisplayed\": []\n}"

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

Description

Query text responses given a pattern and optional sentiment filters. Optionally find synonyms or antonyms.

Payload

{
    "projectId": string,
    "pattern": string,
    "questionId": [string],
    "wordType": string,
    "sentiment": [
        "vpos",
        "pos",
        "neu",
        "neg",
        "vneg"
    ],
    "conceptTestsDisplayed": array
}

where:

projectId: unique identifier of the project. (Required).
pattern: term to query responses for. (Required).
questionId: single element array containing the unique identifier of the text question. (Required).
wordType: can be “none”, “synonym”, or “antonym”. “none” searches for the provided pattern, “synonym” searches for synonyms of the pattern, and “antonym” searches for antonyms of the pattern. If not specified, this will be treated as “none”. (Optional).
sentiment: an array containing any of the following elements: “vpos”, “pos”, “neu”, “neg”, and “vneg”. “vpos” is very positive, “pos” is positive, “neu” is neutral, “neg” is negative, and “vneg” is very negative. The service queries only responses with the selected sentiment parameters. (Required).
conceptTestsDisplayed: an array describing which responses within concept tests to query. (Optional).

Responses

200 OK

{
    "result": [
        {
            "matches": [
                "string"
            ],
            "fullText": "string",
            "sentiment": "string",
            "questionId": "string",
            "responseId": "string",
            "_score": "float"
        }
    ]
}

where:

result: array of objects, where each object is of the following structure:
- object:
  - matches: string array consisting of matches wrapped in html <em> tags.
  - fullText: full response text of the found match
  - sentiment: sentiment tag of the response of the found match (vpos, pos, neu, neg, vneg).
  - questionId: unique identifier of the text question.
  - responseId: unique identifier of the response of the found match.
  - _score: calculated score of the found match as a floating point number.

401 Unauthorized

Invalid authorization.

500 Internal Server Error

An error occurred processing the request.

502 Bad Gateway

Invalid or missing parameters, or other internal error.

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

Body

application/json

The body is of type object.

Response

Successful response

Get Table By Id Frecuency disttribution for question

⌘I

​Description

​Payload

​Responses

​200 OK

​401 Unauthorized

​500 Internal Server Error

​502 Bad Gateway

Authorizations

Headers

Body

Response

Description

Payload

Responses

200 OK

401 Unauthorized

500 Internal Server Error

502 Bad Gateway