Funnels

Funnels let you analyze ordered steps and manage saved funnel definitions for a website.

Step concepts

The CLI supports simple ordered steps for analysis and saved-funnel creation. Step types are:

Saved funnels accept simple page and goal steps. They can also accept the dashboard-shaped step fields used by the Faurya dashboard: order, id, name, type, condition, and value.

Analyze an unsaved funnel

funnels analyze is read-only and requires structured input with steps.

faurya funnels analyze <websiteId> --input '{"steps":[{"type":"page","value":"/"},{"type":"goal","value":"signup"}]}'

Optional fields include period, dimensions, and limit.

faurya funnels analyze <websiteId> --input '{"steps":[{"type":"page","value":"/pricing"},{"type":"event","value":"checkout_started"}],"limit":100}'

List saved funnels

faurya funnels list <websiteId>

faurya funnels list <websiteId> --limit 50

If more results are available, continue explicitly with --cursor.

faurya funnels list <websiteId> --limit 50 --cursor <cursor>

Get a saved funnel

faurya funnels get <websiteId> <funnelId>

Create a saved funnel

Creates a saved funnel. Required fields are name and steps.

faurya funnels create <websiteId> --input '{"name":"Signup","steps":[{"type":"page","value":"/"},{"type":"goal","value":"signup"}]}'

For larger definitions, use a file.

faurya funnels create <websiteId> --input-file ./funnel.json

Update a saved funnel

Updates the name, steps, or both. At least one field must be supplied.

faurya funnels update <websiteId> <funnelId> --input '{"name":"Signup v2"}'

faurya funnels update <websiteId> <funnelId> --input-file ./funnel-update.json

Delete a saved funnel

Deleting a funnel is destructive. In an interactive terminal, the CLI asks for confirmation. In scripts and non-interactive contexts, pass --yes only after checking the website and funnel ID.

faurya funnels delete <websiteId> <funnelId>

faurya funnels delete <websiteId> <funnelId> --yes