Fetch Analysis Trend
Analysis / Trend
Fetch Analysis Trend
Description
Get trend analysis data for questions.
Payload
{
"fromDate": string,
"toDate": string,
"filter": array,
"groups": object,
"type": string,
"excludeQuestions": array
}
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 Test or Question Loops. Optional.type: Type of trend data to get the analysis data. It can be one of the following:hourly,daily,monthlyandyearly. Required.excludeQuestions: Array of question ids. Questions specified in this array belong to a Contact Info item, specifically the country and state questions that should be excluded from analysis. Optional.
Response
200 OK
{
"projectId": string,
"fromDate": string,
"toDate": string,
"filter": array,
"dateFilter": {
"startDate": string,
"endDate": string
},
"responses": {
"qQuestionId": 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.dateFilter: Object of date filters used for querying the responses.filter: Array of filters sent in the request.responses: object mapping unique question identifiers to trend analysis data for every question.
400 Bad Request
Missing or invalid
type/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 Trend
Description
Get trend analysis data for 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 Test or Question Loops. Optional.type: Type of trend data to get the analysis data. It can be one of the following:hourly,daily,monthlyandyearly. Required.excludeQuestions: Array of question ids. Questions specified in this array belong to a Contact Info item, specifically the country and state questions that should be excluded from analysis. 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.dateFilter: Object of date filters used for querying the responses.filter: Array of filters sent in the request.responses: object mapping unique question identifiers to trend analysis data for every question.
400 Bad Request
Missing or invalidtype/projectId/fromDate/toDatefields.
401 Unauthorized
Invalid authorization.
404 Not Found
Resource not found.
500 Internal Server Error
Error occurred in the service.