Skip to main content
POST
Fetch heatmap answers by project

Description

Get heatmap question reactions points for the question passed in url or request body.

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).
  • questionId: Identifier to get all answers related to that question. Only used if there is no questionId on requested url (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.
  • questionId: Question Identifier used to get the answers.
  • responses: An array of reaction data containing an object.
  • responses[]: An object with the questionId, value and coordinates of the reaction.

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