Skip to content

Capture Form Preview

POST
/forms/{form_key}/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.

Authorizations

Parameters

Path Parameters

form_key
required

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

string

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

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Which observed placement to capture. Mirrors PlacementPreviewRequest.

object
page_url
required

A page the form was actually seen on.

string
>= 8 characters <= 4096 characters
source_id
required

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

string
>= 1 characters <= 500 characters

Responses

202

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string