Create Table

curl --request POST \
  --url https://pivot-table.sightx.io/v1/pivotTable/create \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "{{projectId}}",
  "name": "Test",
  "selectedChart": "BANNER_CROSSTAB",
  "rows": [],
  "columns": [],
  "values": [
    {
      "frontendId": 1628716597272,
      "aggregationType": 1,
      "valueType": "count",
      "formatType": "both",
      "color": "black"
    }
  ],
  "alphaValue": 5
}
'

import requests

url = "https://pivot-table.sightx.io/v1/pivotTable/create"

payload = {
    "projectId": "{{projectId}}",
    "name": "Test",
    "selectedChart": "BANNER_CROSSTAB",
    "rows": [],
    "columns": [],
    "values": [
        {
            "frontendId": 1628716597272,
            "aggregationType": 1,
            "valueType": "count",
            "formatType": "both",
            "color": "black"
        }
    ],
    "alphaValue": 5
}
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}}',
    name: 'Test',
    selectedChart: 'BANNER_CROSSTAB',
    rows: [],
    columns: [],
    values: [
      {
        frontendId: 1628716597272,
        aggregationType: 1,
        valueType: 'count',
        formatType: 'both',
        color: 'black'
      }
    ],
    alphaValue: 5
  })
};

fetch('https://pivot-table.sightx.io/v1/pivotTable/create', 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://pivot-table.sightx.io/v1/pivotTable/create",
  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}}',
    'name' => 'Test',
    'selectedChart' => 'BANNER_CROSSTAB',
    'rows' => [
        
    ],
    'columns' => [
        
    ],
    'values' => [
        [
                'frontendId' => 1628716597272,
                'aggregationType' => 1,
                'valueType' => 'count',
                'formatType' => 'both',
                'color' => 'black'
        ]
    ],
    'alphaValue' => 5
  ]),
  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://pivot-table.sightx.io/v1/pivotTable/create"

	payload := strings.NewReader("{\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"Test\",\n  \"selectedChart\": \"BANNER_CROSSTAB\",\n  \"rows\": [],\n  \"columns\": [],\n  \"values\": [\n    {\n      \"frontendId\": 1628716597272,\n      \"aggregationType\": 1,\n      \"valueType\": \"count\",\n      \"formatType\": \"both\",\n      \"color\": \"black\"\n    }\n  ],\n  \"alphaValue\": 5\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://pivot-table.sightx.io/v1/pivotTable/create")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"Test\",\n  \"selectedChart\": \"BANNER_CROSSTAB\",\n  \"rows\": [],\n  \"columns\": [],\n  \"values\": [\n    {\n      \"frontendId\": 1628716597272,\n      \"aggregationType\": 1,\n      \"valueType\": \"count\",\n      \"formatType\": \"both\",\n      \"color\": \"black\"\n    }\n  ],\n  \"alphaValue\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pivot-table.sightx.io/v1/pivotTable/create")

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  \"name\": \"Test\",\n  \"selectedChart\": \"BANNER_CROSSTAB\",\n  \"rows\": [],\n  \"columns\": [],\n  \"values\": [\n    {\n      \"frontendId\": 1628716597272,\n      \"aggregationType\": 1,\n      \"valueType\": \"count\",\n      \"formatType\": \"both\",\n      \"color\": \"black\"\n    }\n  ],\n  \"alphaValue\": 5\n}"

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

{
  "_id": "6137ecaa37cb8f00aebb13cd",
  "projectId": "60de2ba329a7230061e209f6",
  "name": "Test",
  "selectedChart": "BANNER_CROSSTAB",
  "rows": [],
  "columns": [],
  "values": [
    {
      "frontendId": 1628716597272,
      "aggregationType": 1,
      "valueType": "count",
      "formatType": "both",
      "color": "black"
    }
  ],
  "alphaValue": 5,
  "updatedAt": "2021-09-07T22:50:18.655Z",
  "createdAt": "2021-09-07T22:50:18.655Z",
  "createdBy": "5e1155a9091833000f274bbd",
  "updatedBy": "5e1155a9091833000f274bbd",
  "__v": 0
}

Analysis / Pivot table

Create Table

Description

Create a new pivot table

Payload

{
    "projectId": string,
    "name": string,
    "selectedChart": string,
    "values": array,
    "alphaValue": number
}

where:

projectId: Project identifier. (Required).
name: Selected name for the pivot table.
selectedChart: Type of table selected.
values: Array of objects, each one representing a value format to present in each cell in the table.
alphaValue: Alpha value used for significance testing.

Values

Array of objects, each one representing a value format to present in each cell in the table. They have the following structure:

{
  "frontendId": number,
  "aggregationType": number,
  "valueType": string,
  "formatType": string,
  "color": string
}

where:

frontendId: An id to identify the question in the frontend
aggregationType: Type of aggregator format for the value. Could be:
- 1: count
- 2: min
- 3: max
- 4: sum
- 5: average
valueType: Could be count or byQuestion
formatType: Represents the format in which the value will be presented on the table. Could be:
- frecuency
- percentage
- both
color: Color of the value on the table.

Response

200 OK

{
  "_id": string,
  "projectId": string,
  "name": string,
  "selectedChart": string,
  "rows": array,
  "columns": array,
  "values": array,
  "alphaValue": number,
  "updatedAt": string,
  "createdAt": string,
  "createdBy": string,
  "updatedBy": string,
}

401 Unauthorized

Invalid authorization.

404 Not Found

Resource not found.

500 Internal Server Error

Error occurred in the service.

POST

pivotTable

create

Create Table

curl --request POST \
  --url https://pivot-table.sightx.io/v1/pivotTable/create \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "{{projectId}}",
  "name": "Test",
  "selectedChart": "BANNER_CROSSTAB",
  "rows": [],
  "columns": [],
  "values": [
    {
      "frontendId": 1628716597272,
      "aggregationType": 1,
      "valueType": "count",
      "formatType": "both",
      "color": "black"
    }
  ],
  "alphaValue": 5
}
'

import requests

url = "https://pivot-table.sightx.io/v1/pivotTable/create"

payload = {
    "projectId": "{{projectId}}",
    "name": "Test",
    "selectedChart": "BANNER_CROSSTAB",
    "rows": [],
    "columns": [],
    "values": [
        {
            "frontendId": 1628716597272,
            "aggregationType": 1,
            "valueType": "count",
            "formatType": "both",
            "color": "black"
        }
    ],
    "alphaValue": 5
}
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}}',
    name: 'Test',
    selectedChart: 'BANNER_CROSSTAB',
    rows: [],
    columns: [],
    values: [
      {
        frontendId: 1628716597272,
        aggregationType: 1,
        valueType: 'count',
        formatType: 'both',
        color: 'black'
      }
    ],
    alphaValue: 5
  })
};

fetch('https://pivot-table.sightx.io/v1/pivotTable/create', 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://pivot-table.sightx.io/v1/pivotTable/create",
  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}}',
    'name' => 'Test',
    'selectedChart' => 'BANNER_CROSSTAB',
    'rows' => [
        
    ],
    'columns' => [
        
    ],
    'values' => [
        [
                'frontendId' => 1628716597272,
                'aggregationType' => 1,
                'valueType' => 'count',
                'formatType' => 'both',
                'color' => 'black'
        ]
    ],
    'alphaValue' => 5
  ]),
  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://pivot-table.sightx.io/v1/pivotTable/create"

	payload := strings.NewReader("{\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"Test\",\n  \"selectedChart\": \"BANNER_CROSSTAB\",\n  \"rows\": [],\n  \"columns\": [],\n  \"values\": [\n    {\n      \"frontendId\": 1628716597272,\n      \"aggregationType\": 1,\n      \"valueType\": \"count\",\n      \"formatType\": \"both\",\n      \"color\": \"black\"\n    }\n  ],\n  \"alphaValue\": 5\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://pivot-table.sightx.io/v1/pivotTable/create")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"Test\",\n  \"selectedChart\": \"BANNER_CROSSTAB\",\n  \"rows\": [],\n  \"columns\": [],\n  \"values\": [\n    {\n      \"frontendId\": 1628716597272,\n      \"aggregationType\": 1,\n      \"valueType\": \"count\",\n      \"formatType\": \"both\",\n      \"color\": \"black\"\n    }\n  ],\n  \"alphaValue\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pivot-table.sightx.io/v1/pivotTable/create")

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  \"name\": \"Test\",\n  \"selectedChart\": \"BANNER_CROSSTAB\",\n  \"rows\": [],\n  \"columns\": [],\n  \"values\": [\n    {\n      \"frontendId\": 1628716597272,\n      \"aggregationType\": 1,\n      \"valueType\": \"count\",\n      \"formatType\": \"both\",\n      \"color\": \"black\"\n    }\n  ],\n  \"alphaValue\": 5\n}"

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

{
  "_id": "6137ecaa37cb8f00aebb13cd",
  "projectId": "60de2ba329a7230061e209f6",
  "name": "Test",
  "selectedChart": "BANNER_CROSSTAB",
  "rows": [],
  "columns": [],
  "values": [
    {
      "frontendId": 1628716597272,
      "aggregationType": 1,
      "valueType": "count",
      "formatType": "both",
      "color": "black"
    }
  ],
  "alphaValue": 5,
  "updatedAt": "2021-09-07T22:50:18.655Z",
  "createdAt": "2021-09-07T22:50:18.655Z",
  "createdBy": "5e1155a9091833000f274bbd",
  "updatedBy": "5e1155a9091833000f274bbd",
  "__v": 0
}

Description

Create a new pivot table

Payload

{
    "projectId": string,
    "name": string,
    "selectedChart": string,
    "values": array,
    "alphaValue": number
}

where:

projectId: Project identifier. (Required).
name: Selected name for the pivot table.
selectedChart: Type of table selected.
values: Array of objects, each one representing a value format to present in each cell in the table.
alphaValue: Alpha value used for significance testing.

Values

Array of objects, each one representing a value format to present in each cell in the table. They have the following structure:

{
  "frontendId": number,
  "aggregationType": number,
  "valueType": string,
  "formatType": string,
  "color": string
}

where:

frontendId: An id to identify the question in the frontend
aggregationType: Type of aggregator format for the value. Could be:
- 1: count
- 2: min
- 3: max
- 4: sum
- 5: average
valueType: Could be count or byQuestion
formatType: Represents the format in which the value will be presented on the table. Could be:
- frecuency
- percentage
- both
color: Color of the value on the table.

Response

200 OK

{
  "_id": string,
  "projectId": string,
  "name": string,
  "selectedChart": string,
  "rows": array,
  "columns": array,
  "values": array,
  "alphaValue": number,
  "updatedAt": string,
  "createdAt": string,
  "createdBy": string,
  "updatedBy": string,
}

401 Unauthorized

Invalid authorization.

404 Not Found

Resource not found.

500 Internal Server Error

Error occurred in the service.

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

Create Table

The response is of type object.

Update Pivot Table Get Table By Id

⌘I

​Description

​Payload

​Values

​Response

​200 OK

​401 Unauthorized

​404 Not Found

​500 Internal Server Error

Authorizations

Headers

Body

Response

Description

Payload

Values

Response

200 OK

401 Unauthorized

404 Not Found

500 Internal Server Error