Fetch Analysis (grid, maxdiff basic, nps)
Analysis / Question Dashboard
Fetch Analysis (grid, maxdiff basic, nps)
Description
Ranking analysis data for rank questions.
Payload
{
"fromDate": string,
"toDate": string,
"filter": array,
"groups": object
"aggregateOptions": object
}
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 aqas prefix. Every key has assigned an array with the question ids withqprefix that are the same question through different concepts inside a concept test. Only needed for project with Concept Tests or Question Loops (Optional). Some keys are post indexed with_1,_2, etc. These represent groups for each row of the grid question. Optional.aggregateOptions: Buckets to create. Optional.
Response
200 OK
{
"projectId": string,
"fromDate": string,
"toDate": string,
"filter": array,
"dateFilters": [
{
"collection": string,
"start": string,
"end": string
}
],
"responses": object,
"naResponses": object,
"responsesCounter": number,
"responsesCounters": {
"qQuestionId": {
"rowPosition": number,
"question": number
}
},
"transposedResponses": object,
"transposedNaResponses": 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.naResponses: Has the same format asresponses. It contains data for questions that have an N/A column.responsesCounters: Integer representing the number of responses per question for the given filter.transposedNaResponses: Transposed data for questions that have an N/A column.transposedResponses: Transposed object mapping unique question identifiers to analysis data for every question.
400 Bad Request
Missing or invalid
projectId/fromDate/toDatefields.
401 Unauthorized
Invalid authorization.
404 Not Found
Resource not found.
500 Internal Server Error
Error occurred in the service.
POST
Fetch Analysis (grid, maxdiff basic, nps)
Description
Ranking analysis data for rank questions.Payload
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 aqas prefix. Every key has assigned an array with the question ids withqprefix that are the same question through different concepts inside a concept test. Only needed for project with Concept Tests or Question Loops (Optional). Some keys are post indexed with_1,_2, etc. These represent groups for each row of the grid question. Optional.aggregateOptions: Buckets to create. Optional.
Response
200 OK
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.naResponses: Has the same format asresponses. It contains data for questions that have an N/A column.responsesCounters: Integer representing the number of responses per question for the given filter.transposedNaResponses: Transposed data for questions that have an N/A column.transposedResponses: Transposed object mapping unique question identifiers to analysis data for every question.
400 Bad Request
Missing or invalidprojectId/fromDate/toDatefields.
401 Unauthorized
Invalid authorization.
404 Not Found
Resource not found.
500 Internal Server Error
Error occurred in the service.