get_form_analytics
Completion rate per form and — the key signal — which field visitors were on when they abandoned.
When to use it
When a signup or contact flow underperforms, or when the funnel shows a drop at a step that involves a form. The fix is usually to remove, reorder or relax validation on one named field.
Ask for it like this
You do not name the tool. These are questions that make an assistant reach for it:
Which form field is losing people?
Why does nobody finish my newsletter signup?
How to read the result
- topAbandonField plus its share of all abandons is the finding. abandonmentByField is the supporting detail.
- Per-field, avgTouches and revisitedWithoutChange are the fingerprint of a confusing or rejecting input — bad validation, unclear format, an unexpected required field.
- Covers every theme form: newsletter signup, contact, login, address entry.
What will make you wrong
Caveats
- Field values are never collected anywhere in the pipeline. Names, types and timings only. Password inputs report under the generic key (password).
Parameters
formKey
Restrict to one form, by the name, id or action returned in formKey.
pageUrl
Restrict to forms on pages containing this string.
Shared parameters it accepts
Documented in full on the tool reference index.
Date window — defaults to the last 30 days.
dateFrom
Start of the window, YYYY-MM-DD. Inclusive.
dateTo
End of the window, YYYY-MM-DD. Inclusive.
Every tool also accepts merchantId, which resolves from your connection. You never pass it.
What comes back
JSON. These are the top-level keys; date-scoped tools additionally carry a _meta block with the server date and the data coverage envelope.
forms
Per form: starts, submits, completion with a confidence interval and sample verdict, topAbandonField, abandonmentByField, and per-field avgDwellMs, avgTouches and revisitedWithoutChange.
note
The privacy guarantee, restated on every response.