Get the lead → appointment → sale funnel
GET/api/reports/conversions/funnel
The period's leads followed to their appointments and sales (doc 105 §4.7).
A lead is the FIRST, per person and period, of: a form submission that is
not spam and not a form handed to someone already known (personal link,
kiosk); an ad-platform lead form; a conversation an ad click opened or
reopened (Click-to-WhatsApp/Messenger, or the website's WhatsApp link with
its ref code). lead_sources narrows which of the three may count.
A cohort report: the period picks the leads, their later steps count
whenever they happened. booked = a booking created at or after the lead
(any status); attended = such a booking not cancelled, no-show or moved
whose start has passed; won / lost = a deal closed at or after the lead.
Revenue is every won deal of the cohort, per currency — never summed across
currencies. Days are read in the workspace's timezone (Settings → Company).
Needs analytics.view and the conversion_reports plan feature.
Request
Responses
- 200
- 401
- 403
- 404
- 422
The funnel.
Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).
Authenticated but not allowed.
The conversion_reports feature is off for this workspace.
The request failed validation.