Merge pull request #573 from plausible/metmarkosaric-patch-26

scroll depth

Author: RobertJoonas

docs/google-analytics-import.md

@@ -92,7 +92,11 @@ We can import your traffic split between the different browsers but you can't dr
 
 ### Exit pages
 
-Google Analytics 4 API does not expose this information so you cannot see the Exit Pages report for imported data. 
+Google Analytics API does not expose this information so you cannot see the Exit Pages report for imported data. 
+
+### Scroll Depth
+
+Google Analytics API does not expose this information so you cannot see the scroll depth metric for imported data. 
 
 ### Day view graph
 

docs/guided-tour.md

@@ -62,7 +62,7 @@ You can also use the "**Filter**" button on the top of your dashboard which give
 
 ## Detailed metrics and Sorting
 
-You can click the "**Details**" button at the bottom of any report to get an expanded view and see the full list with additional metrics such as Visitors, Bounce Rate, Visit Duration, Uniques, Total, CR (Conversion Rate), etc., depending upon the type of the report.
+You can click the "**Details**" button at the bottom of any report to get an expanded view and see the full list with additional metrics such as "**Visitors**", "**Bounce Rate**", "**Visit Duration**", "**Scroll Depth**", "**Unique Conversions**", "**Total Conversions**", "**Conversion Rate**" and more all depending upon the type of the report.
 
 You can sort any report by such performance metrics by clicking on any metric heading to sort and arrange your data in ascending or descending order.
 
@@ -78,7 +78,7 @@ Note that the referral sources including UTM and other query parameters are coun
 
 ## Top Pages
 
-See all the most visited pages on your site ranked by the number of unique visitors. You can click on the "**details**" button to see the full list with additional metrics. The number of pageviews, bounce rate, and time on page for the individual pages are included too.
+See all the most visited pages on your site ranked by the number of unique visitors. You can click on the "**details**" button to see the full list with additional metrics. The number of pageviews, bounce rate, time on page and scroll depth for the individual pages are included too.
 
 You can also get insights into the visitor flow by looking at the "**Entry pages**" and "**Exit pages**". Click on the "**details**" button to see the full list with additional metrics. For "**Entry pages**" details include visit duration for visits that started on a specific page and for "**Exit pages**" details include the exit rate percentage. [Read more here](top-pages.md).
 

docs/metrics-definitions.md

@@ -87,6 +87,10 @@ You can click on any source to drill-down and view the individual pages linking
 
 Shows the devices used by your visitors. Devices are categorized into desktop, mobile or tablet. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. Metrics are shown as the total number of unique visitors and as a percentage of all visitors.
 
+## Scroll Depth
+
+Measures how far visitors scroll down a webpage. It represents the percentage of a page’s total height that visitors have reached on average. You can learn how we calculate it [here](http://plausible.io/docs/scroll-depth).```
+
 ## Source
 
 See all referral sources that are sending you traffic. A source is reported when a person clicks through to your site from another site.

docs/pageview-goals.md

@@ -14,13 +14,15 @@ To get started with "**Pageview Goals**", go to [your website's settings](websit
 
 <img alt="Add your first goal" src={useBaseUrl('img/goal-conversions.png')} />
 
-Click on the "**+ Add goal**" button to go to the goal creation form.
+Click the "**+ Add goal**" button to go to the goal creation form.
 
-Select `Pageview` as the goal trigger and enter the pathname of the page you would like your visitors to hit. The pathname must match the page path you can see in your Plausible Analytics dashboard.
+Select `Pageview` as the goal trigger and enter the pathname of the page you would like your visitors to hit, or select the same from the dropdown. The pathname must match the page path you can see in your Plausible Analytics dashboard.
 
 <img alt="Add your pageview goal" src={useBaseUrl('img/add-pageview-goal.png')} />
 
-Next, click on the "**Add goal**" button and you’ll be taken back to the goals page. When you navigate back to your Plausible Analytics dashboard, you should see the number of visitors who reached the specified page or group of pages. Goal conversions are listed at the very bottom of the dashboard.
+Next, you'll see the Display Name which gets self-populated. You can optionally edit it. You can also edit this later at any time. 
+
+Then click the "**Add goal**" button and you’ll be taken back to the goals page. When you navigate back to your Plausible Analytics dashboard, you should see the number of visitors who reached the specified page or group of pages. Goal conversions are listed at the very bottom of the dashboard.
 
 ## How to group your pages
 
@@ -44,4 +46,4 @@ You can also give it a new display name, say, if the original name of the goal i
 
 <img alt="Edit pageview goal popup" src={useBaseUrl('img/edit-pageview-goal-popup.png')} />
 
-Once you’ve made the necessary changes, simply click "Update goal," and your updated settings will be applied immediately. The changes will be reflected in your Plausible Analytics dashboard, with the goal now tracking based on the new settings you’ve configured.
+Once you’ve made the necessary changes, simply click "Update goal" and your updated settings will be applied immediately. The changes will be reflected in your Plausible Analytics dashboard, with the goal now tracking based on the new settings you’ve configured.

docs/scroll-depth.md

@@ -0,0 +1,45 @@
+---
+title: Scroll depth tracking
+---
+
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+Scroll depth tracking is built into Plausible Analytics by default, allowing you to measure how far visitors scroll down your pages, expressed as a percentage.
+
+This data provides insights into user engagement and helps optimize content placement, calls-to-action (CTAs) and page layouts.
+
+## Scroll Depth percentage for your pages
+
+You can find scroll depth data in:
+
+1.  **The top row of metrics** when a page filter is applied. Click on it to see trends over time.
+
+2.  **The expanded Top Pages report**, where pages can be sorted by scroll depth for deeper analysis.
+
+<img alt="Scroll depth metric in Plausible" src={useBaseUrl('img/scroll-depth.png')} />
+
+If there's insufficient data, scroll depth will display as "-" until more traffic is recorded.
+
+You can also use [the Filters feature](filters-segments.md) to group similar pages and analyze their average scroll depth. For example, filter URLs containing "blog" to see average engagement for blog posts.
+
+Plausible tracks scrolling at all percentages (1% to 100%), unlike many other tools that limit tracking to specific points such as 25%, 50%, and 75%. If you also want to track a specific scroll depth threshold for some of your pages, you can set up scroll depth goals.
+
+## Scroll Depth goals
+
+You can also set up a Scroll Depth goal with a specific scroll depth percentage threshold to see how many visitors scroll to and beyond your desired scroll depth mark.
+
+To get started with "**Scroll Depth Goals**", go to [your website's settings](website-settings.md) in Plausible Analytics and visit the "**Goals**" section. You should see an empty list with a prompt to add a goal.
+
+Click on the "**+ Add goal**" button to go to the goal creation form.
+
+Select `Scroll Depth` as the goal trigger, select the scroll depth percentage threshold (from 1% to 100%) and enter the pathname of the page you would like to track. The pathname must match the page path you can see in your Plausible Analytics dashboard.
+
+Do you want to analyze the scroll depth for a specific section of your site? You can use an asterisk (`*`) to match patterns in your page path URLs. Asterisks can be placed on either end or in the middle of any page path URL.
+
+You can for instance group all of your blog posts by using `/blog*` (if your blog subdirectory is named `blog`) or your Woocommerce checkout pages by using `/checkout/order-received/*`. 
+
+Next, click on the "**Add goal**" button to return to the goals page. When you navigate back to your Plausible Analytics dashboard, you should see the number of visitors who reached the particular scroll depth on the specified pages. Goal conversions are listed at the bottom of the dashboard.
+
+Scroll Depth goals only display the "Uniques" and "CR (conversion rate)" metrics, and not the "Total" metric like the pageview goals and custom event goals do. This is because scrolling is an action that gets measured continuously during a pageview and it's not possible to count the total number of "scroll depth events" that occurred.
+
+If you'd like to learn more about what scroll depth is, what's a good metric to have, and more, you can check out our blog post [here](https://plausible.io/blog/scroll-depth-tracking).

docs/stats-api.md

@@ -86,7 +86,8 @@ Valid metrics are:
 | `bounce_rate` | `float` | Bounce rate percentage | |
 | `visit_duration` | `int` | Visit duration in seconds | |
 | `events` | `int` | The number of events (pageviews + custom events). When filtering by a goal, this metric corresponds to "Total Conversions" in the dashboard. | |
-| `percentage` | `float` | The percentage of visitors of total who fall into this category: Requires: dimension list | Requires non-empty `dimensions` |
+| `scroll_depth` | `int` | Page scroll depth averaged per session | Requires `event:page` filter or dimension being set |
+| `percentage` | `float` | The percentage of visitors of total who fall into this category | Requires non-empty `dimensions` |
 | `conversion_rate` | `float` | The percentage of visitors who completed the goal. | Requires non-empty `dimensions`, `event:goal` filter or dimension being set |
 | `group_conversion_rate` | `float` | The percentage of visitors who completed the goal with the same dimension. Requires: dimension list passed, an event:goal filter or event:goal dimension | Requires non-empty `dimensions`, event:goal filter or dimension being set |
 | `average_revenue` | `Revenue` or null | Average revenue per revenue goal conversion | Requires [revenue goals](docs/ecommerce-revenue-tracking.md), `event:goal` filter or dimension for a relevant revenue goal. |

docs/top-pages.md

@@ -4,7 +4,7 @@ title: Top content, landing pages and exit pages
 
 import useBaseUrl from '@docusaurus/useBaseUrl';
 
-Your "**Top Pages**" report shows which pages your visitors are visiting the most often. You can use it to identify the most popular content on your site. Click on any page to segment your audience by those who visited that particular page. You can also click the "**Details**" button to see the full list of pages with additional metrics. The number of pageviews, bounce rate, and time on page for the individual pages are included too. Click on any metric heading to sort and arrange your data in ascending or descending order.
+Your "**Top Pages**" report shows which pages your visitors are visiting the most often. You can use it to identify the most popular content on your site. Click on any page to segment your audience by those who visited that particular page. You can also click the "**Details**" button to see the full list of pages with additional metrics. The number of pageviews, bounce rate, time on page and scroll depth for the individual pages are included too. Click on any metric heading to sort and arrange your data in ascending or descending order.
 
 You can also see the traffic flow by looking at the "**Entry Pages**" and "**Exit Pages**" reports. You can click the "**Details**" button to see the full list with additional details. For entry pages, details include visit duration for visits that started on a specific page and for exit pages, details include the exit rate percentage. Click on any metric heading to sort and arrange your data in ascending or descending order.
 

sidebars.js

@@ -37,6 +37,7 @@ module.exports = {
       'top-pages',
       'countries',
       'devices',
+      'scroll-depth',
       'subdomain-hostname-filter',
       'metrics-definitions',
       'keyboard-shortcuts',