Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Add new keys for goals and funnels in meta.json to enhance documentation structure

Bill Yangd56d2dd44caa
diff --git a/docs/content/docs/funnels.mdx b/docs/content/docs/funnels.mdx
new file mode 100644
index 000000000..e8a6bf8c4
--- /dev/null
+++ b/docs/content/docs/funnels.mdx
@@ -0,0 +1,74 @@
+---
+title: Funnels
+description: Analyze conversion through multi-step user journeys
+---
+
+![Funnels Dashboard](/docs/funnels/1.png)
+
+Funnels let you define a sequence of steps β€” page visits or custom events β€” and measure how many users progress through each stage. You can see where users convert, where they drop off, and drill into the sessions at each step to understand why.
+
+## Creating a Funnel
+
+![Creating a Funnel](/docs/funnels/2.png)
+
+Click **Create Funnel** to open the funnel builder. Each funnel has:
+
+- **Name** β€” A label for the funnel (e.g., "Signup Flow", "Checkout Process")
+- **Steps** β€” Two or more sequential steps, each tracking a page visit or custom event
+
+### Page Steps
+
+Page steps match pageview events by URL path.
+
+- Enter a URL path starting with `/`
+- Wildcards are supported:
+ - `*` matches a single path segment β€” `/products/*` matches `/products/shoes`
+ - `**` matches multiple segments β€” `/docs/**` matches `/docs/api/v2/intro`
+
+### Event Steps
+
+Event steps match custom events by name (e.g., `add_to_cart`, `purchase_completed`).
+
+Events must be tracked using the Rybbit tracking script. See [Track Events](/docs/track-events) for setup instructions.
+
+### Step Options
+
+![Step Options](/docs/funnels/4.png)
+
+Each step has additional configuration options:
+
+- **Label** (optional) β€” A friendly display name for the step
+- **Hostname** (optional) β€” Restrict matching to a specific domain, useful for multi-domain sites
+- **Property Filters** (optional) β€” Filter by URL parameters (for page steps) or event properties (for event steps). Multiple filters can be added per step, and all must match.
+
+## Reading Funnel Results
+
+The funnel visualization updates in real time as you configure steps. For each step, you'll see:
+
+- **Sessions** β€” How many sessions reached this step
+- **Conversion Rate** β€” Percentage of the first step's sessions that reached this step
+- **Dropped** β€” How many sessions completed the previous step but not this one
+- **Dropoff Rate** β€” Percentage of the previous step's sessions lost at this point
+
+The horizontal bar for each step shows two layers:
+- **Solid bar** β€” Overall conversion from the first step
+- **Striped overlay** β€” Conversion from the immediately previous step
+
+Steps are evaluated sequentially β€” each step must occur after the previous one within the same session.
+
+## Viewing Sessions
+
+![Viewing Sessions](/docs/funnels/3.png)
+
+Click any step to expand it and view the sessions associated with that step:
+
+- **Reached** tab β€” Sessions that completed this step
+- **Dropped Off** tab β€” Sessions that reached the previous step but didn't make it to this one (available for step 2 and beyond)
+
+Each session shows entry/exit pages, duration, location, device info, referrer, UTM parameters, and user ID if identified. Sessions are paginated.
+
+---
+
+**Related Documentation:**
+- [Goals](/docs/goals) β€” Track single-action conversions
+- [Track Events](/docs/track-events) β€” Set up custom event tracking
diff --git a/docs/content/docs/goals.mdx b/docs/content/docs/goals.mdx
new file mode 100644
index 000000000..58f6579a6
--- /dev/null
+++ b/docs/content/docs/goals.mdx
@@ -0,0 +1,72 @@
+---
+title: Goals
+description: Track conversions by monitoring page visits and custom events
+---
+
+Goals let you define specific actions β€” visiting a page or triggering an event β€” and measure how often your visitors complete them. Each goal tracks a conversion rate against total sessions, giving you a clear picture of how effectively your site drives key outcomes.
+
+## Creating a Goal
+
+Click **Create Goal** to open the goal form. Every goal has:
+
+- **Name** (optional) β€” A friendly label like "Completed Checkout" or "Signed Up"
+- **Type** β€” Either **Page Goal** or **Event Goal**
+- **Value** β€” The path pattern (for page goals) or event name (for event goals)
+
+<Callout type="warn" title="Goal type is permanent">
+You cannot change a goal's type after creation. If you need a different type, create a new goal.
+</Callout>
+
+### Page Goals
+
+Page goals track when a user visits a URL matching a given path pattern.
+
+- The value must be a path starting with `/` (not a full URL)
+- Wildcards are supported:
+ - `*` matches a single path segment β€” `/blog/*` matches `/blog/my-post`
+ - `**` matches multiple segments β€” `/docs/**` matches `/docs/api/v2/intro`
+
+The form provides autocomplete suggestions based on actual paths seen on your site.
+
+### Event Goals
+
+Event goals track when a custom event with a specific name is fired. The value is the event name (e.g., `signup_clicked`, `purchase_completed`).
+
+Events must be tracked using the Rybbit tracking script. See [Track Events](/docs/track-events) for setup instructions.
+
+### Property Filters
+
+You can narrow a goal to only count conversions when specific properties match:
+
+- **Page goals** β€” Filter by URL parameters (e.g., only count visits where `utm_source=adwords`)
+- **Event goals** β€” Filter by event properties (e.g., only count events where `plan=premium`)
+
+Toggle **Match specific URL parameters** or **Match specific event properties** to add filters. You can add multiple filters per goal β€” all filters must match for a session to count as a conversion.
+
+## Goal Metrics
+
+Each goal card displays:
+
+- **Total Conversions** β€” The number of distinct sessions that completed the goal
+- **Conversion Rate** β€” Conversions divided by total sessions in the selected time period, shown as a percentage with a visual progress bar
+
+Goals respect the global date range and filters (country, device, browser, etc.) applied on the page.
+
+## Viewing Converted Sessions
+
+Click a goal card to expand it and see the sessions that converted. Each session shows:
+
+- Entry and exit pages
+- Session duration
+- Location (country, region, city)
+- Device, browser, and OS
+- Referrer, channel, and UTM parameters
+- User ID (if identified)
+
+Sessions are sorted by most recent first and paginated.
+
+---
+
+**Related Documentation:**
+- [Track Events](/docs/track-events) β€” Set up custom event tracking
+- [Funnels](/docs/funnels) β€” Analyze multi-step conversion paths
diff --git a/docs/content/docs/meta.json b/docs/content/docs/meta.json
index aadfe6bb6..dc4973289 100644
--- a/docs/content/docs/meta.json
+++ b/docs/content/docs/meta.json
@@ -17,6 +17,8 @@
"api",
"hiding-own-traffic",
"filter-traffic",
+ "goals",
+ "funnels",
"---User Guide---",
"web-analytics",
"behavior-analytics",
diff --git a/docs/public/docs/funnels/1.png b/docs/public/docs/funnels/1.png
new file mode 100644
index 000000000..b0f166a7f
Binary files /dev/null and b/docs/public/docs/funnels/1.png differ
diff --git a/docs/public/docs/funnels/2.png b/docs/public/docs/funnels/2.png
new file mode 100644
index 000000000..a8edd1c88
Binary files /dev/null and b/docs/public/docs/funnels/2.png differ
diff --git a/docs/public/docs/funnels/3.png b/docs/public/docs/funnels/3.png
new file mode 100644
index 000000000..1532962fc
Binary files /dev/null and b/docs/public/docs/funnels/3.png differ
diff --git a/docs/public/docs/funnels/4.png b/docs/public/docs/funnels/4.png
new file mode 100644
index 000000000..2186d5127
Binary files /dev/null and b/docs/public/docs/funnels/4.png differ