Get form report

Get aggregated performance statistics for a single form within a date range. The response contains
statistics (totals across all devices) and statisticsByDevice, the same counters split into the
desktop, mobile, and tablet buckets. Device buckets with no activity in the range are omitted.

Metrics:

  • views — times the form was displayed to a visitor. This is the denominator for conversion rates.
  • interactions — views where the visitor engaged with the form (for example focusing a field or
    clicking a button) without necessarily completing it.
  • submits — times the form was successfully submitted.
  • signups — contacts gained from those submissions. Signups can differ from submits: a submission by an
    already known contact, or a multi-step form counted once per step reached, means the two counters are
    related but not interchangeable.

Each metric is a subset of the previous one in the funnel: views ≥ interactions ≥ submits.

The date range is required and is interpreted in the brand's timezone. Use
GET /forms/{formID}/report/periodic instead when a time series (per hour, day, week, month, or year) is
needed rather than a single total.

Scopes:
forms.read

Rate Limiting:
This endpoint is rate limited to 400 requests per minute.

Path Params
string
required

Form ID (24 character hexadecimal)

Query Params
string
required

Start of the date range, inclusive (RFC3339, e.g. 2024-01-01T00:00:00Z)

string
required

End of the date range, inclusive (RFC3339, e.g. 2024-01-31T23:59:59Z)

Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json