Get All By Project
Analysis / Pivot table
Get All By Project
Description
Get a list of all pivot tables related to the selected project.
Payload
{
"projectId": string
}
where:
projectId: Project identifier to search for its pivot tables. (Required).
Response
200 OK
{
"docs": array,
"total": number,
"limit": number,
"page": number,
"pages": number
}
where:
docs: Array of objects, each representing a pivot table instance.total: Total amount of pivot tables the project has.limit: Number of pivot tables shown per page.page: Current page for fetching the pivot tables.pages: Total number of pages.
Docs
Array of objects, each one represents an instance of a pivot table with the following structure:
{
"_id": string,
"projectId": string,
"name": string,
"selectedChart": string,
"rows": array,
"columns": array,
"values": array,
"alphaValue": number,
"updatedAt": string,
"createdAt": string,
"createdBy": string,
"updatedBy": string,
}
where:
_id: Id of the pivot table.projectId: Id of the project this pivot table instance belongs to.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.updatedAt: Date of the last update.createdAt: Date of creation of the pivot table.createdBy: Id of the user who created the table.updatedBy: Id of the last user to update 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 frontendquestionId: 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 frontendquestionId: 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 frontendaggregationType: Type of aggregator format for the value. Could be:- 1: count
- 2: min
- 3: max
- 4: sum
- 5: average
valueType: Could be count or byQuestionformatType: 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.
401 Unauthorized
Invalid authorization.
404 Not Found
Resource not found.
500 Internal Server Error
Error occurred in the service.
POST
Get All By Project
Description
Get a list of all pivot tables related to the selected project.Payload
projectId: Project identifier to search for its pivot tables. (Required).
Response
200 OK
docs: Array of objects, each representing a pivot table instance.total: Total amount of pivot tables the project has.limit: Number of pivot tables shown per page.page: Current page for fetching the pivot tables.pages: Total number of pages.
Docs
Array of objects, each one represents an instance of a pivot table with the following structure:_id: Id of the pivot table.projectId: Id of the project this pivot table instance belongs to.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.updatedAt: Date of the last update.createdAt: Date of creation of the pivot table.createdBy: Id of the user who created the table.updatedBy: Id of the last user to update the table.
Rows
Array of objects, each one representing a question selected as row for the table. Has the following structure:frontendId: An id to identify the question in the frontendquestionId: 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: An id to identify the question in the frontendquestionId: 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: An id to identify the question in the frontendaggregationType: Type of aggregator format for the value. Could be:- 1: count
- 2: min
- 3: max
- 4: sum
- 5: average
valueType: Could be count or byQuestionformatType: 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.
401 Unauthorized
Invalid authorization.
404 Not Found
Resource not found.
500 Internal Server Error
Error occurred in the service.