Create Funnel
Create a new conversion funnel.
Create Funnel
Creates a new multi-step conversion funnel for a site. Requires member role or higher.
Endpoint
POST /api/v1/organizations/:orgId/sites/:siteId/funnels
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Funnel name |
description | string | No | Funnel description |
steps | array | Yes | Array of funnel steps (min 2) |
Each step requires:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Step label |
order | number | Yes | Step position (1-indexed) |
type | string | No | pageview (default) or custom_event |
pattern | string | Yes | Page path or event name to match |
match_type | string | No | exact, contains (default), regex |
Analyze Funnel
Once created, analyze funnel performance:
GET /api/v1/organizations/:orgId/sites/:siteId/funnels/:funnelId/analyze
Returns per-step stats with:
| Field | Type | Description |
|---|---|---|
step_id | string | Step ID |
name | string | Step name |
order | number | Step position |
visitors | number | Visitors who reached this step |
dropoff_rate | number | % lost from previous step |
conversion_rate | number | % retained from previous step |
revenue | number | Revenue attributed to visitors at step |
top_sources | array | Top 3 traffic sources at step |
top_countries | array | Top 3 countries at step |