Skip to main content
POST
Frecuency disttribution for question

Description

Query frecuency distributions for open text questions of project.

Payload

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 if toDate is present).
  • toDate: end date of responses to query. (Required if fromDate is present).
  • filter: list of questions to filter responses by. (Optional).
  • selectedQuestionId: unique identifier of the text question selected for comparison. (Required if selectedOption is present).
  • selectedOption: single element array containing which option is selected for comparison. (Required if selectedQuestionId is present).

Responses

200 OK

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.

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

Successful response