Skip to main content
POST
Track form submission
Required scopes: analytics.manage

Authorizations

Authorization
string
header
required

Use Authorization: Bearer rk_live_....

Headers

Idempotency-Key
string
required

A unique value for each new request, such as a UUID. Send the same value to retry a request safely. The same key and payload replay the first response with Idempotency-Replayed: true.

Required string length: 1 - 160

Body

application/json
external_event_id
string
required
Required string length: 1 - 200
session_id
string
required
Required string length: 1 - 500
page_url
string<uri> | null
referrer_url
string<uri> | null
user_agent
string | null
Maximum string length: 512
occurred_at
string<date-time>

ISO 8601 date-time with Z or a ±HH:MM offset. Stored as UTC.

submitted_at
string<date-time>

ISO 8601 date-time with Z or a ±HH:MM offset. Stored as UTC.

form_id
string | null
Maximum string length: 200
form_name
string | null
Maximum string length: 200
form_selector
string | null
Maximum string length: 500
contact_name
string | null
Maximum string length: 200
contact_email
string<email> | null
contact_phone
string | null

US-only phone. Invalid or non-US values return VALIDATION_ERROR.

property_address
string | null

Optional property address. Empty, explicit US country, or US state + ZIP formats are accepted; clearly non-US values return VALIDATION_ERROR.

Maximum string length: 500
form_data
object

Arbitrary submitted fields. Refused consent removes known top-level tracking keys. Free-text values are not scanned.

attribution_params
object
Available options:
implicit,
required

Response

Submission duplicate or idempotent replay returned.

event
object | null
required
duplicate
boolean
required
analytics_only
boolean
required
recorded_analytics
boolean
required
lead_id
string | null
required
created
boolean
required