Skip to main content
GET
Get form funnel metrics

Authorizations

X-API-Key
string
header
required

A scoped key with the of_live_ prefix, generated from Profile > API keys.

Path Parameters

formId
string
required
Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439011"

Query Parameters

period
enum<string>
default:30d
Available options:
today,
yesterday,
24h,
7d,
30d,
3m,
6m,
12m,
all

Response

Aggregate funnel metrics.

period
string
required
estimated
boolean
required

True when legacy lifetime counters were used because event-level data is unavailable.

views
integer
required
Required range: x >= 0
starts
integer
required
Required range: x >= 0
submissions
integer
required
Required range: x >= 0
completion_rate
number
required
Required range: x >= 0