Surveys

Get click-test regions and counts

Returns the named boxes (regions) drawn on a click-test question's current image, and how respondents' clicks fall in them.

Counting

  • mode=first (default) counts each respondent's first click; mode=all counts every click.
  • Boxes are half-open: a click on an edge two regions share counts in the right or lower one. A box reaching the image's right or bottom edge includes it.
  • Each region and outside carry count, a whole-percent share (summing to 100) and, in first mode, a Wilson 95% interval ci95 in percent.
  • noClearWinner is a heuristic, not a significance test: true when the two most-clicked regions' intervals overlap, so no region should be called the winner yet.

Filters

  • traits: comma-separated trait value permalinks, as on the responses endpoint.
  • startX, startY, w, h: a drag box as fractions of the image (all four or none). Only respondents with any click inside it are counted.

Regions belong to an image: after the question's image is replaced, revision is 0 and regions is empty until regions are saved for the new image. A click test without clicks answers zero counts. Returns 422 for a question that is not a click test or has no image.

get/surveys/{id}/questions/{questionId}/click-regions

Request

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

Path parameters

idstring required

Survey GUID

questionIdstring required

Question GUID within the survey; the survey GUID for a single-question poll

Query parameters

mode'first' | 'all'

first (default) counts each respondent's first click; all counts every click.

startXnumber

Drag-box filter, left edge as a fraction. Send startX, startY, w and h together: only respondents with any click inside the box (edges included) are counted, by their own first click in first mode.

startYnumber

Drag-box filter, top edge as a fraction

wnumber

Drag-box filter, width; negative for a box dragged left

hnumber

Drag-box filter, height; negative for a box dragged up

traitsstring

Comma-separated trait value permalinks, as on GET /surveys/{id}/responses: only matching respondents are counted. Traits outside the poll's trait set are refused with 400.

Response

Default Response

imagePublicIdstring

The question's current image

revisioninteger

The current revision for that image; 0 when none

sourcestring nullable

template (seeded from a mockup template), detected or drawn; null when none

Changes

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