Surveys

Get click-test heatmap

Returns a permanent CDN URL to a rendered heatmap PNG image for a click-test question. The heatmap composites all click data onto the original question image. Results are cached in Cloudinary — subsequent requests for the same click data return instantly. regions carries the click regions saved for the current image, with first-click counts from the same clicks, or null when the image has none.

Prerequisites

  • Question must be a click-test type
  • Question must have at least one click response
  • Returns 422 for non-click-test questions or questions with zero clicks
get/surveys/{id}/questions/{questionId}/heatmap

Request

  • Base URL: https://api.pickfu.com/v1
  • URL: https://api.pickfu.com/v1/surveys/{id}/questions/{questionId}/heatmap
  • Auth: HTTP bearer

Path parameters

idstring required

Survey GUID

questionIdstring required

Question GUID within the survey

Response

Default Response

heatmapUrlstring

Signed URL to the rendered heatmap PNG image

Changes

No recorded changes to this operation across all 1 revision of this API.