Skip to main content
POST
Fetch Analysis (heatmap)

Description

Get heatmap question reactions points.

Payload

where:
  • fromDate: start date in ISO format. (Required).
  • toDate: end date in ISO format. (Required).
  • filter: array of filters to filter the responses. (Optional).
  • projectId: project unique identifier. Only used in case projectId is missing as query param(Optional).

Response

200 OK

where:
  • fromDate: Starting date to filter responses.
  • toDate: End date to filter responses.
  • filter: List of filters used to apply to the constant sum answers.
  • projectId: Id of the project this analysis belongs to.
  • responses: An object indexed by question id prefixed with q.
  • responses.qQuestionID: An object indexed by reaction position associated with an array containing objects with the x and y coordinate for that reaction.
  • responsesByQuestion: An object indexed by question id prefixed with q associated with the number of responses for it.

401 Unauthorized

Invalid authorization.

404 Not Found

Resource not found.

500 Internal Server Error

Error occurred in the service.
Query Parameters

Authorizations

Authorization
string
header
required

Access token obtained from the m2m-token endpoint.

Headers

Authorization
string
required

Authorization token

Query Parameters

projectId
string

Body

application/json

The body is of type object.

Response

Successful response