Skip to content

Get Form Overview

GET
/forms/{form_key}/overview

Per-form operational detail: health, submission metrics, destination.

source_id is required and comes from a list_forms result — a form id is only unique within its source.

Authorizations

Parameters

Path Parameters

form_key
required

The form’s HTML tag id / group key (from list_forms).

string

The form’s HTML tag id / group key (from list_forms).

Query Parameters

source_id
required

Write key / site the form belongs to (from list_forms).

string

Write key / site the form belongs to (from list_forms).

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Per-form operational detail (health, metrics, destination).

Mirrors the scalar fields of the in-app GET /forms/{form_key}/overview response. The config-oriented route / permissions blocks from the internal payload are intentionally omitted — an agent describing a form does not need route-editing internals.

object
activation_health
Any of:
string
capture_health
Any of:
string
delivery_health
Any of:
string
display_name
Any of:
string
form_key
required
string
identity_state
Any of:
string
last_destination_verified_at
Any of:
string format: date-time
metrics
object
key
additional properties
any
owner_id
Any of:
string
placement_count
integer
recommended_action
Any of:
string
source_id
required
string
technical_form_id
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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