Frecuency disttribution for question
Analysis / Text Dashboard
Frecuency disttribution for question
Description
Query frecuency distributions for open text questions of project.
Payload
{
"projectId": string,
"questionId": [string],
"combination": string,
"fromDate": string,
"toDate": string,
"filter": array,
"selectedQuestionId": string,
"selectedOption": [number]
}
where:
projectId: unique identifier of the project. (Required).questionId: unique identifier of the text question. (Required).combination: determines what combination of lemmatization and stop words are applied. (Required).fromDate: start date of responses to query. (Required iftoDateis present).toDate: end date of responses to query. (Required iffromDateis present).filter: list of questions to filter responses by. (Optional).selectedQuestionId: unique identifier of the text question selected for comparison. (Required ifselectedOptionis present).selectedOption: single element array containing which option is selected for comparison. (Required ifselectedQuestionIdis present).
Responses
200 OK
{
"combination": "string",
"frequencies": {
"adjectives": {
"adjective1": "integer",
"adjectiveN": "integer"
},
"nouns": {
"noun1": "integer",
"nounN": "integer"
},
"verbs": {
"verb1": "integer",
"verbN": "integer"
},
"others": {
"other1": "integer",
"otherN": "integer"
}
},
"sentiments": {
"neu": "integer",
"pos": "integer",
"neg": "integer",
"vpos": "integer",
"vneg": "integer"
}
}
where:
combination: determines what combination of lemmatization and stop words are applied.frequencies: object containing:adjectives: object containing adjectives mapped to frequencies.nouns: object containing nouns mapped to frequencies.others: object containing other words mapped to frequencies.verbs: object containing verbs mapped to frequencies.
sentiments: object containing:neu: number of neutral words.pos: number of positive words.neg: number of negative words.vpos: number of very positive words.vneg: number of very negative words.
400 Bad Request
Missing or invalid required fields.
401 Unauthorized
Invalid authorization.
500 Internal Server Error
Error occurred in freq-dist-api microservice.
POST
Frecuency disttribution for question
Description
Query frecuency distributions for open text questions of project.Payload
projectId: unique identifier of the project. (Required).questionId: unique identifier of the text question. (Required).combination: determines what combination of lemmatization and stop words are applied. (Required).fromDate: start date of responses to query. (Required iftoDateis present).toDate: end date of responses to query. (Required iffromDateis present).filter: list of questions to filter responses by. (Optional).selectedQuestionId: unique identifier of the text question selected for comparison. (Required ifselectedOptionis present).selectedOption: single element array containing which option is selected for comparison. (Required ifselectedQuestionIdis present).
Responses
200 OK
combination: determines what combination of lemmatization and stop words are applied.frequencies: object containing:adjectives: object containing adjectives mapped to frequencies.nouns: object containing nouns mapped to frequencies.others: object containing other words mapped to frequencies.verbs: object containing verbs mapped to frequencies.
sentiments: object containing:neu: number of neutral words.pos: number of positive words.neg: number of negative words.vpos: number of very positive words.vneg: number of very negative words.
400 Bad Request
Missing or invalid required fields.
401 Unauthorized
Invalid authorization.
500 Internal Server Error
Error occurred in freq-dist-api microservice.