Forms

Capture Form Preview

Queue a screenshot of this form on one page it was actually seen on.

ASYNCHRONOUS: poll GET /forms/{form_key}/preview/{preview_id}. A page the form was never observed on is a 404 - it captures real placements only.

post/forms/{form_key}/preview

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/forms/{form_key}/preview
  • Auth: HTTP bearer

Path parameters

form_keystring required

The form's form_key (the id from GET /forms).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

source_idstring required

The site (write key) the form is installed on.

page_urlstring required

A page the form was actually seen on.

Response

Successful Response

dataFormsAdminPayload required

One forms object, or one handler response.

Open-shaped: the submission, mapping, group and audit payloads grow with the product, and a closed model here would silently drop what it does not name.

Changes

No recorded changes to this operation across all 2 revisions of this API.