---
title: "Capture Form Preview"
method: POST
path: "/forms/{form_key}/preview"
tags: ["Forms"]
---

# Capture Form Preview

`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

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.

## Path parameters

- `form_key` string, required: The form's `form_key` (the `id` from `GET /forms`).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- FormPlacementPreviewRequest: Which observed placement to capture. Mirrors `PlacementPreviewRequest`.
  - `source_id` string, required: The site (write key) the form is installed on.
  - `page_url` string, required: A page the form was actually seen on.

## Response `202`

Successful Response

- ApiResponseFormsAdminPayload
  - `data` FormsAdminPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)