Surveys

Save click-test regions

Saves the whole set of regions for a click-test question's current image as a new revision, and returns it with unfiltered first-click counts. Allowed on draft, live and completed surveys for users who can edit the survey; requires an API key with write permission.

Send the imagePublicId and revision the GET returned (revision 0 when there is none). Regions are fractions of the image (x, y, w, h in 0 to 1), at most 50, with unique keys; they may share an edge but not overlap. Saving regions equal to the current ones creates no revision.

Errors

  • 409 CLICK_REGIONS_IMAGE_CHANGED: the question's image was replaced since the GET. Reload and draw the regions again.
  • 409 CLICK_REGIONS_STALE_REVISION: someone saved since the GET, or a concurrent save won. Reload and reapply.
  • Both carry current: { imagePublicId, revision }.
  • 422 CLICK_REGIONS_INVALID: the message names each region to fix (overlap, out of bounds, zero size, duplicate key).
put/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

Request body

imagePublicIdstring required

The image the regions were drawn on: imagePublicId from the GET. A save for any other image is refused with 409 CLICK_REGIONS_IMAGE_CHANGED.

revisioninteger required

The revision being edited: revision from the GET, 0 when there is none yet. A save against an older revision is refused with 409 CLICK_REGIONS_STALE_REVISION.

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.