Update Pivot Table

curl --request POST \
  --url https://pivot-table.sightx.io/v1/pivotTable/update/{pivotTableId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_id": "{{pivotTableId}}",
  "projectId": "{{projectId}}",
  "name": "",
  "selectedChart": "",
  "rows": [
    {
      "frontendId": 1,
      "questionId": ""
    }
  ],
  "columns": [
    {
      "frontendId": 1,
      "questionId": ""
    }
  ],
  "values": [
    {
      "frontendId": 1,
      "aggregationType": 1,
      "valueType": "",
      "formatType": "",
      "color": ""
    }
  ],
  "alphaValue": 1,
  "displayNullData": true
}
'

import requests

url = "https://pivot-table.sightx.io/v1/pivotTable/update/{pivotTableId}"

payload = {
    "_id": "{{pivotTableId}}",
    "projectId": "{{projectId}}",
    "name": "",
    "selectedChart": "",
    "rows": [
        {
            "frontendId": 1,
            "questionId": ""
        }
    ],
    "columns": [
        {
            "frontendId": 1,
            "questionId": ""
        }
    ],
    "values": [
        {
            "frontendId": 1,
            "aggregationType": 1,
            "valueType": "",
            "formatType": "",
            "color": ""
        }
    ],
    "alphaValue": 1,
    "displayNullData": True
}
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({
    _id: '{{pivotTableId}}',
    projectId: '{{projectId}}',
    name: '',
    selectedChart: '',
    rows: [{frontendId: 1, questionId: ''}],
    columns: [{frontendId: 1, questionId: ''}],
    values: [{frontendId: 1, aggregationType: 1, valueType: '', formatType: '', color: ''}],
    alphaValue: 1,
    displayNullData: true
  })
};

fetch('https://pivot-table.sightx.io/v1/pivotTable/update/{pivotTableId}', 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/update/{pivotTableId}",
  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([
    '_id' => '{{pivotTableId}}',
    'projectId' => '{{projectId}}',
    'name' => '',
    'selectedChart' => '',
    'rows' => [
        [
                'frontendId' => 1,
                'questionId' => ''
        ]
    ],
    'columns' => [
        [
                'frontendId' => 1,
                'questionId' => ''
        ]
    ],
    'values' => [
        [
                'frontendId' => 1,
                'aggregationType' => 1,
                'valueType' => '',
                'formatType' => '',
                'color' => ''
        ]
    ],
    'alphaValue' => 1,
    'displayNullData' => true
  ]),
  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/update/{pivotTableId}"

	payload := strings.NewReader("{\n  \"_id\": \"{{pivotTableId}}\",\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"\",\n  \"selectedChart\": \"\",\n  \"rows\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"columns\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"values\": [\n    {\n      \"frontendId\": 1,\n      \"aggregationType\": 1,\n      \"valueType\": \"\",\n      \"formatType\": \"\",\n      \"color\": \"\"\n    }\n  ],\n  \"alphaValue\": 1,\n  \"displayNullData\": true\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/update/{pivotTableId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"_id\": \"{{pivotTableId}}\",\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"\",\n  \"selectedChart\": \"\",\n  \"rows\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"columns\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"values\": [\n    {\n      \"frontendId\": 1,\n      \"aggregationType\": 1,\n      \"valueType\": \"\",\n      \"formatType\": \"\",\n      \"color\": \"\"\n    }\n  ],\n  \"alphaValue\": 1,\n  \"displayNullData\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pivot-table.sightx.io/v1/pivotTable/update/{pivotTableId}")

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  \"_id\": \"{{pivotTableId}}\",\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"\",\n  \"selectedChart\": \"\",\n  \"rows\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"columns\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"values\": [\n    {\n      \"frontendId\": 1,\n      \"aggregationType\": 1,\n      \"valueType\": \"\",\n      \"formatType\": \"\",\n      \"color\": \"\"\n    }\n  ],\n  \"alphaValue\": 1,\n  \"displayNullData\": true\n}"

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

{
  "n": 1,
  "nModified": 1,
  "opTime": {
    "ts": "7005328587351916545",
    "t": 41
  },
  "electionId": "7fffffff0000000000000029",
  "ok": 1,
  "operationTime": "7005328587351916545",
  "$clusterTime": {
    "clusterTime": "7005328587351916545",
    "signature": {
      "hash": "JZUvHcXyDqv1ebSOmtluGvL/6EI=",
      "keyId": "6972714809024315400"
    }
  }
}

Analysis / Pivot table

Update Pivot Table

Description

Update a pivot table

Payload

{
    "_id": string,
    "projectId": string,
    "name": string,
    "selectedChart": string,
    "rows": array,
    "columns": array,
    "values": array,
    "alphaValue": number,
    "displayNullData": boolean
}

where:

_id: Id of the table to update (Required).
projectId: Project identifier to which the pivot table was created. (Required).
name: Selected name for the pivot table.
selectedChart: Type of table selected.
rows: Array of objects, each one representing a question selected as row for the table.
columns: Array of objects, each one representing a question selected as column for the table.
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.
displayNullData: Whether to display or hide null data from the table

Rows

Array of objects, each one representing a question selected as row for the table. Has the following structure:

{
  "frontendId": number,
  "questionId": string
}

where:

frontendId: An id to identify the question in the frontend
questionId: Id of the question in the server

Columns

Array of objects, each one representing a question selected as column for the table. Has the following structure:

{
  "frontendId": number,
  "questionId": string
}

where:

frontendId: An id to identify the question in the frontend
questionId: Id of the question in the server

Values

Array of objects, each one representing a value format to present in each cell in the table Has 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

{
    "nModified": number,
}

where:

nModified: Number of records modified.

401 Unauthorized

Invalid authorization.

404 Not Found

Resource not found.

500 Internal Server Error

Error occurred in the service.

POST

pivotTable

update

{pivotTableId}

Update Pivot Table

curl --request POST \
  --url https://pivot-table.sightx.io/v1/pivotTable/update/{pivotTableId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_id": "{{pivotTableId}}",
  "projectId": "{{projectId}}",
  "name": "",
  "selectedChart": "",
  "rows": [
    {
      "frontendId": 1,
      "questionId": ""
    }
  ],
  "columns": [
    {
      "frontendId": 1,
      "questionId": ""
    }
  ],
  "values": [
    {
      "frontendId": 1,
      "aggregationType": 1,
      "valueType": "",
      "formatType": "",
      "color": ""
    }
  ],
  "alphaValue": 1,
  "displayNullData": true
}
'

import requests

url = "https://pivot-table.sightx.io/v1/pivotTable/update/{pivotTableId}"

payload = {
    "_id": "{{pivotTableId}}",
    "projectId": "{{projectId}}",
    "name": "",
    "selectedChart": "",
    "rows": [
        {
            "frontendId": 1,
            "questionId": ""
        }
    ],
    "columns": [
        {
            "frontendId": 1,
            "questionId": ""
        }
    ],
    "values": [
        {
            "frontendId": 1,
            "aggregationType": 1,
            "valueType": "",
            "formatType": "",
            "color": ""
        }
    ],
    "alphaValue": 1,
    "displayNullData": True
}
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({
    _id: '{{pivotTableId}}',
    projectId: '{{projectId}}',
    name: '',
    selectedChart: '',
    rows: [{frontendId: 1, questionId: ''}],
    columns: [{frontendId: 1, questionId: ''}],
    values: [{frontendId: 1, aggregationType: 1, valueType: '', formatType: '', color: ''}],
    alphaValue: 1,
    displayNullData: true
  })
};

fetch('https://pivot-table.sightx.io/v1/pivotTable/update/{pivotTableId}', 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/update/{pivotTableId}",
  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([
    '_id' => '{{pivotTableId}}',
    'projectId' => '{{projectId}}',
    'name' => '',
    'selectedChart' => '',
    'rows' => [
        [
                'frontendId' => 1,
                'questionId' => ''
        ]
    ],
    'columns' => [
        [
                'frontendId' => 1,
                'questionId' => ''
        ]
    ],
    'values' => [
        [
                'frontendId' => 1,
                'aggregationType' => 1,
                'valueType' => '',
                'formatType' => '',
                'color' => ''
        ]
    ],
    'alphaValue' => 1,
    'displayNullData' => true
  ]),
  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/update/{pivotTableId}"

	payload := strings.NewReader("{\n  \"_id\": \"{{pivotTableId}}\",\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"\",\n  \"selectedChart\": \"\",\n  \"rows\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"columns\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"values\": [\n    {\n      \"frontendId\": 1,\n      \"aggregationType\": 1,\n      \"valueType\": \"\",\n      \"formatType\": \"\",\n      \"color\": \"\"\n    }\n  ],\n  \"alphaValue\": 1,\n  \"displayNullData\": true\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/update/{pivotTableId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"_id\": \"{{pivotTableId}}\",\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"\",\n  \"selectedChart\": \"\",\n  \"rows\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"columns\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"values\": [\n    {\n      \"frontendId\": 1,\n      \"aggregationType\": 1,\n      \"valueType\": \"\",\n      \"formatType\": \"\",\n      \"color\": \"\"\n    }\n  ],\n  \"alphaValue\": 1,\n  \"displayNullData\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pivot-table.sightx.io/v1/pivotTable/update/{pivotTableId}")

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  \"_id\": \"{{pivotTableId}}\",\n  \"projectId\": \"{{projectId}}\",\n  \"name\": \"\",\n  \"selectedChart\": \"\",\n  \"rows\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"columns\": [\n    {\n      \"frontendId\": 1,\n      \"questionId\": \"\"\n    }\n  ],\n  \"values\": [\n    {\n      \"frontendId\": 1,\n      \"aggregationType\": 1,\n      \"valueType\": \"\",\n      \"formatType\": \"\",\n      \"color\": \"\"\n    }\n  ],\n  \"alphaValue\": 1,\n  \"displayNullData\": true\n}"

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

{
  "n": 1,
  "nModified": 1,
  "opTime": {
    "ts": "7005328587351916545",
    "t": 41
  },
  "electionId": "7fffffff0000000000000029",
  "ok": 1,
  "operationTime": "7005328587351916545",
  "$clusterTime": {
    "clusterTime": "7005328587351916545",
    "signature": {
      "hash": "JZUvHcXyDqv1ebSOmtluGvL/6EI=",
      "keyId": "6972714809024315400"
    }
  }
}

Description

Update a pivot table

Payload

{
    "_id": string,
    "projectId": string,
    "name": string,
    "selectedChart": string,
    "rows": array,
    "columns": array,
    "values": array,
    "alphaValue": number,
    "displayNullData": boolean
}

where:

_id: Id of the table to update (Required).
projectId: Project identifier to which the pivot table was created. (Required).
name: Selected name for the pivot table.
selectedChart: Type of table selected.
rows: Array of objects, each one representing a question selected as row for the table.
columns: Array of objects, each one representing a question selected as column for the table.
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.
displayNullData: Whether to display or hide null data from the table

Rows

Array of objects, each one representing a question selected as row for the table. Has the following structure:

{
  "frontendId": number,
  "questionId": string
}

where:

frontendId: An id to identify the question in the frontend
questionId: Id of the question in the server

Columns

Array of objects, each one representing a question selected as column for the table. Has the following structure:

{
  "frontendId": number,
  "questionId": string
}

where:

frontendId: An id to identify the question in the frontend
questionId: Id of the question in the server

Values

Array of objects, each one representing a value format to present in each cell in the table Has 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

{
    "nModified": number,
}

where:

nModified: Number of records modified.

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

Update Pivot Table

The response is of type object.

Fetch Data Create Table

⌘I

​Description

​Payload

​Rows

​Columns

​Values

​Response

​200 OK

​401 Unauthorized

​404 Not Found

​500 Internal Server Error

Authorizations

Headers

Body

Response

Description

Payload

Rows

Columns

Values

Response

200 OK

401 Unauthorized

404 Not Found

500 Internal Server Error