Skip to content

Record a client-observed funnel event

POST
/api/funnel/event

Accepts importer-opened, wizard-completed and share-link-copied observations. Server-derived funnel steps are recorded by their owning routes and rejected here.

object
event
required
string
Allowed values: import_opened wizard_completed share_link_copied signup_completed
meta
object
key
additional properties
Any of:
string
<= 100 characters

Event accepted

object
ok
required
boolean
data
required
object
accepted
required
boolean

Invalid event

object
ok
required
boolean
error
required
string
code
string

Unauthenticated

object
ok
required
boolean
error
required
string
code
string

Not a member of the requested band

object
ok
required
boolean
error
required
string
code
string