Skip to content

Commit 9620f00

Browse files
committed
add scroll depth as stats API v2 metric
1 parent a9b2878 commit 9620f00

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/stats-api.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ Valid metrics are:
8484
| `bounce_rate` | `float` | Bounce rate percentage | |
8585
| `visit_duration` | `int` | Visit duration in seconds | |
8686
| `events` | `int` | The number of events (pageviews + custom events). When filtering by a goal, this metric corresponds to "Total Conversions" in the dashboard. | |
87-
| `percentage` | `float` | The percentage of visitors of total who fall into this category: Requires: dimension list | Requires non-empty `dimensions` |
87+
| `scroll_depth` | `int` | Page scroll depth averaged per session | Requires `event:page` filter or dimension being set |
88+
| `percentage` | `float` | The percentage of visitors of total who fall into this category | Requires non-empty `dimensions` |
8889
| `conversion_rate` | `float` | The percentage of visitors who completed the goal. | Requires non-empty `dimensions`, `event:goal` filter or dimension being set |
8990
| `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 |
9091
| `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. |

0 commit comments

Comments
 (0)