Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Include time on page and bounce rate in top stats with page filter and imported data (#6073)

RobertJoonasd56f06724836
diff --git a/assets/js/dashboard/stats/graph/top-stats.js b/assets/js/dashboard/stats/graph/top-stats.js
index 87e8a6e14f..eff64a5bb2 100644
--- a/assets/js/dashboard/stats/graph/top-stats.js
+++ b/assets/js/dashboard/stats/graph/top-stats.js
@@ -81,6 +81,13 @@ export default function TopStats({
return null
}
+ if (
+ metric === 'bounce_rate' &&
+ warning.code === 'no_imported_bounce_rate'
+ ) {
+ return 'Does not include imported data'
+ }
+
if (
metric === 'scroll_depth' &&
warning.code === 'no_imported_scroll_depth'
diff --git a/assets/js/dashboard/stats/modals/breakdown-modal.tsx b/assets/js/dashboard/stats/modals/breakdown-modal.tsx
index ea18a68177..b2ab4f6cae 100644
--- a/assets/js/dashboard/stats/modals/breakdown-modal.tsx
+++ b/assets/js/dashboard/stats/modals/breakdown-modal.tsx
@@ -257,6 +257,9 @@ const getMetricWarning = (metric: Metric, meta: BreakdownResultMeta | null) => {
if (warnings && warnings[metric.key]) {
const { code, message } = warnings[metric.key]
+ if (metric.key == 'bounce_rate' && code == 'no_imported_bounce_rate') {
+ return 'Does not include imported data'
+ }
if (metric.key == 'scroll_depth' && code == 'no_imported_scroll_depth') {
return 'Does not include imported data'
}
diff --git a/lib/plausible/stats/imported/imported.ex b/lib/plausible/stats/imported/imported.ex
index a88080902d..2c077fa2b8 100644
--- a/lib/plausible/stats/imported/imported.ex
+++ b/lib/plausible/stats/imported/imported.ex
@@ -352,6 +352,7 @@ defmodule Plausible.Stats.Imported do
:exit_rate,
:scroll_depth,
:percentage,
+ :bounce_rate,
:conversion_rate,
:group_conversion_rate,
:time_on_page
diff --git a/lib/plausible/stats/imported/sql/expression.ex b/lib/plausible/stats/imported/sql/expression.ex
index 1c1f27280f..a69825fe87 100644
--- a/lib/plausible/stats/imported/sql/expression.ex
+++ b/lib/plausible/stats/imported/sql/expression.ex
@@ -72,7 +72,7 @@ defmodule Plausible.Stats.Imported.SQL.Expression do
end
defp select_metric(:bounce_rate, "imported_pages", _query) do
- wrap_alias([i], %{bounces: 0, __internal_visits: 0})
+ wrap_alias([i], %{bounces: fragment("any(0)"), __internal_visits: fragment("any(0)")})
end
defp select_metric(:bounce_rate, "imported_exit_pages", _query) do
@@ -92,31 +92,61 @@ defmodule Plausible.Stats.Imported.SQL.Expression do
end
defp select_metric(:visit_duration, "imported_pages", _query) do
- wrap_alias([i], %{visit_duration: 0})
+ wrap_alias([i], %{visit_duration: 0, total_visit_duration: 0})
end
defp select_metric(:visit_duration, "imported_exit_pages", _query) do
- wrap_alias([i], %{visit_duration: sum(i.visit_duration), __internal_visits: sum(i.exits)})
+ wrap_alias([i], %{
+ visit_duration:
+ fragment("ifNotFinite(round(? / ?), 0)", sum(i.visit_duration), sum(i.exits)),
+ total_visit_duration: sum(i.visit_duration),
+ __internal_visits: sum(i.exits)
+ })
end
defp select_metric(:visit_duration, "imported_entry_pages", _query) do
- wrap_alias([i], %{visit_duration: sum(i.visit_duration), __internal_visits: sum(i.entrances)})
+ wrap_alias([i], %{
+ visit_duration:
+ fragment("ifNotFinite(round(? / ?), 0)", sum(i.visit_duration), sum(i.entrances)),
+ total_visit_duration: sum(i.visit_duration),
+ __internal_visits: sum(i.entrances)
+ })
end
defp select_metric(:visit_duration, _table, _query) do
- wrap_alias([i], %{visit_duration: sum(i.visit_duration), __internal_visits: sum(i.visits)})
+ wrap_alias([i], %{
+ visit_duration:
+ fragment("ifNotFinite(round(? / ?), 0)", sum(i.visit_duration), sum(i.visits)),
+ total_visit_duration: sum(i.visit_duration),
+ __internal_visits: sum(i.visits)
+ })
end
defp select_metric(:views_per_visit, "imported_exit_pages", _query) do
- wrap_alias([i], %{pageviews: sum(i.pageviews), __internal_visits: sum(i.exits)})
+ wrap_alias([i], %{
+ views_per_visit:
+ fragment("ifNotFinite(round(? / ?, 2), 0)", sum(i.pageviews), sum(i.exits)),
+ pageviews: sum(i.pageviews),
+ __internal_visits: sum(i.exits)
+ })
end
defp select_metric(:views_per_visit, "imported_entry_pages", _query) do
- wrap_alias([i], %{pageviews: sum(i.pageviews), __internal_visits: sum(i.entrances)})
+ wrap_alias([i], %{
+ views_per_visit:
+ fragment("ifNotFinite(round(? / ?, 2), 0)", sum(i.pageviews), sum(i.entrances)),
+ pageviews: sum(i.pageviews),
+ __internal_visits: sum(i.entrances)
+ })
end
defp select_metric(:views_per_visit, _table, _query) do
- wrap_alias([i], %{pageviews: sum(i.pageviews), __internal_visits: sum(i.visits)})
+ wrap_alias([i], %{
+ views_per_visit:
+ fragment("ifNotFinite(round(? / ?, 2), 0)", sum(i.pageviews), sum(i.visits)),
+ pageviews: sum(i.pageviews),
+ __internal_visits: sum(i.visits)
+ })
end
defp select_metric(:scroll_depth, "imported_pages", _query) do
@@ -373,7 +403,7 @@ defmodule Plausible.Stats.Imported.SQL.Expression do
""",
s.__internal_visits,
i.__internal_visits,
- i.visit_duration,
+ i.total_visit_duration,
s.visit_duration,
s.__internal_visits,
s.__internal_visits,
diff --git a/lib/plausible/stats/query_result.ex b/lib/plausible/stats/query_result.ex
index 46b8088421..a38588188d 100644
--- a/lib/plausible/stats/query_result.ex
+++ b/lib/plausible/stats/query_result.ex
@@ -8,7 +8,7 @@ defmodule Plausible.Stats.QueryResult do
"""
use Plausible
- alias Plausible.Stats.{Query, QueryRunner, QueryInclude}
+ alias Plausible.Stats.{Query, QueryRunner, QueryInclude, Filters}
defstruct results: [],
meta: %{},
@@ -31,6 +31,13 @@ defmodule Plausible.Stats.QueryResult do
def no_imported_scroll_depth_warning(), do: @no_imported_scroll_depth_warning
+ @no_imported_bounce_rate_warning %{
+ code: :no_imported_bounce_rate,
+ warning: "imported bounce_rate is not available when using a page filter"
+ }
+
+ def no_imported_bounce_rate_warning(), do: @no_imported_bounce_rate_warning
+
@doc """
Builds full JSON-serializable query response.
@@ -100,7 +107,7 @@ defmodule Plausible.Stats.QueryResult do
defp add_dashboard_metric_labels(meta, query) do
context = %{
goal_filter?:
- Plausible.Stats.Filters.filtering_on_dimension?(query, "event:goal",
+ Filters.filtering_on_dimension?(query, "event:goal",
max_depth: 0,
behavioral_filters: :ignore
),
@@ -201,6 +208,20 @@ defmodule Plausible.Stats.QueryResult do
end
end
+ # Native queries (i.e. ones that don't include imported data) allow querying bounce rate
+ # with an `event:page` filter or dimension. In those cases, an `event:page` gets treated
+ # as `visit:entry_page`. While theoretically possible, this behaviour does not yet exist
+ # for imported data, which is why we're returning a metric warning here.
+ defp metric_warning(:bounce_rate, %Query{} = query) do
+ page_filter_or_dimension? =
+ Filters.filtering_on_dimension?(query, "event:page", behavioral_filters: :ignore) or
+ "event:page" in query.dimensions
+
+ if query.include_imported and page_filter_or_dimension? do
+ @no_imported_bounce_rate_warning
+ end
+ end
+
defp metric_warning(_metric, _query), do: nil
defp to_iso8601(datetime, timezone) do
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex
index ed3b7f930f..f38ed623fd 100644
--- a/lib/plausible_web/controllers/api/stats_controller.ex
+++ b/lib/plausible_web/controllers/api/stats_controller.ex
@@ -402,8 +402,8 @@ defmodule PlausibleWeb.Api.StatsController do
metrics =
cond do
- page_filter? && query.include_imported ->
- metrics ++ [:scroll_depth]
+ page_filter? and query.include_imported ->
+ metrics ++ [:bounce_rate, :scroll_depth]
page_filter? ->
metrics ++ [:bounce_rate, :scroll_depth, :time_on_page]
diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_imported_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_imported_test.exs
index 71e1627233..3073dd537b 100644
--- a/test/plausible_web/controllers/api/external_stats_controller/query_imported_test.exs
+++ b/test/plausible_web/controllers/api/external_stats_controller/query_imported_test.exs
@@ -1296,11 +1296,12 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryImportedTest do
end
end
- describe "scroll depth metric warnings" do
- test "returns warning when a site_import without scroll depth is in queried range", %{
- conn: conn,
- site: site
- } do
+ describe "metric warnings" do
+ test "returns scroll_depth warning when a site_import without scroll depth is in queried range",
+ %{
+ conn: conn,
+ site: site
+ } do
site_import =
insert(:site_import, site: site, start_date: ~D[2021-02-01], end_date: ~D[2021-02-28])
@@ -1336,7 +1337,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryImportedTest do
}
end
- test "does not return warning when imports requested but rejected", %{
+ test "does not return scroll depth warning when imports requested but rejected", %{
conn: conn,
site: site
} do
@@ -1372,7 +1373,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryImportedTest do
refute meta["metric_warnings"]["scroll_depth"]
end
- test "does not return warning when imports without scroll depth exist but outside the queried range",
+ test "does not return scroll_depth warning when imports without scroll depth exist but outside the queried range",
%{
conn: conn,
site: site
@@ -1404,7 +1405,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryImportedTest do
refute meta["metric_warnings"]["scroll_depth"]
end
- test "does not return warning when imported scroll depth exists", %{
+ test "does not return scroll_depth warning when imported scroll depth exists", %{
conn: conn,
site: site
} do
@@ -1449,6 +1450,192 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryImportedTest do
assert meta["imports_included"]
refute meta["metric_warnings"]["scroll_depth"]
end
+
+ test "returns bounce_rate warning when query includes imported and page filter used", %{
+ conn: conn,
+ site: site
+ } do
+ site_import =
+ insert(:site_import, site: site, start_date: ~D[2021-02-01], end_date: ~D[2021-02-28])
+
+ populate_stats(site, site_import.id, [
+ build(:pageview, user_id: 123, pathname: "/", timestamp: ~N[2021-02-01 00:00:00]),
+ build(:pageview, user_id: 123, pathname: "/next", timestamp: ~N[2021-02-01 00:10:00]),
+ build(:pageview, pathname: "/", timestamp: ~N[2021-02-01 00:00:00]),
+ build(:imported_pages, page: "/", date: ~D[2021-02-01]),
+ build(:imported_pages, pageviews: 3, page: "/", date: ~D[2021-02-02]),
+ build(:imported_visitors, date: ~D[2021-02-01]),
+ build(:imported_visitors, pageviews: 3, date: ~D[2021-02-02])
+ ])
+
+ conn =
+ post(conn, "/api/v2/query", %{
+ "site_id" => site.domain,
+ "metrics" => ["visitors", "pageviews", "bounce_rate"],
+ "date_range" => "all",
+ "filters" => [["is", "event:page", ["/"]]],
+ "include" => %{"imports" => true}
+ })
+
+ assert %{"results" => results, "meta" => meta} = json_response(conn, 200)
+
+ assert results == [%{"dimensions" => [], "metrics" => [4, 6, 50.0]}]
+
+ assert meta["imports_included"] == true
+
+ assert bounce_rate_warning = meta["metric_warnings"]["bounce_rate"]
+
+ expected_warning = Plausible.Stats.QueryResult.no_imported_bounce_rate_warning()
+ assert bounce_rate_warning["code"] == to_string(expected_warning.code)
+ assert bounce_rate_warning["warning"] == expected_warning.warning
+ end
+
+ test "returns bounce_rate warning when query includes imported and page dimension used", %{
+ conn: conn,
+ site: site
+ } do
+ site_import =
+ insert(:site_import, site: site, start_date: ~D[2021-02-01], end_date: ~D[2021-02-28])
+
+ populate_stats(site, site_import.id, [
+ build(:pageview, user_id: 123, pathname: "/", timestamp: ~N[2021-02-01 00:00:00]),
+ build(:pageview, user_id: 123, pathname: "/next", timestamp: ~N[2021-02-01 00:10:00]),
+ build(:pageview, pathname: "/", timestamp: ~N[2021-02-01 00:00:00]),
+ build(:imported_pages, page: "/", date: ~D[2021-02-01]),
+ build(:imported_pages, pageviews: 3, page: "/", date: ~D[2021-02-02]),
+ build(:imported_visitors, date: ~D[2021-02-01]),
+ build(:imported_visitors, pageviews: 3, date: ~D[2021-02-02])
+ ])
+
+ conn =
+ post(conn, "/api/v2/query", %{
+ "site_id" => site.domain,
+ "metrics" => ["visitors", "pageviews", "bounce_rate"],
+ "date_range" => "all",
+ "dimensions" => ["event:page"],
+ "include" => %{"imports" => true}
+ })
+
+ assert %{"results" => results, "meta" => meta} = json_response(conn, 200)
+
+ assert results == [
+ %{"dimensions" => ["/"], "metrics" => [4, 6, 50.0]},
+ %{"dimensions" => ["/next"], "metrics" => [1, 1, 0.0]}
+ ]
+
+ assert meta["imports_included"] == true
+
+ assert bounce_rate_warning = meta["metric_warnings"]["bounce_rate"]
+
+ expected_warning = Plausible.Stats.QueryResult.no_imported_bounce_rate_warning()
+ assert bounce_rate_warning["code"] == to_string(expected_warning.code)
+ assert bounce_rate_warning["warning"] == expected_warning.warning
+ end
+ end
+
+ describe "order_by" do
+ test "bounce_rate", %{site: site, conn: conn} do
+ site_import =
+ insert(:site_import, site: site, start_date: ~D[2021-01-01], end_date: ~D[2021-02-28])
+
+ populate_stats(site, site_import.id, [
+ build(:pageview, user_id: 123, pathname: "/a", timestamp: ~N[2021-01-01 00:00:00]),
+ build(:imported_entry_pages,
+ entry_page: "/a",
+ entrances: 2,
+ bounces: 1,
+ date: ~D[2021-01-01]
+ ),
+ build(:imported_entry_pages,
+ entry_page: "/b",
+ entrances: 4,
+ bounces: 1,
+ date: ~D[2021-01-01]
+ )
+ ])
+
+ conn =
+ post(conn, "/api/v2/query", %{
+ "site_id" => site.domain,
+ "metrics" => ["bounce_rate"],
+ "order_by" => [["bounce_rate", "asc"]],
+ "date_range" => "all",
+ "dimensions" => ["visit:entry_page"],
+ "include" => %{"imports" => true}
+ })
+
+ response = json_response(conn, 200)
+
+ assert [
+ %{"dimensions" => ["/b"], "metrics" => [25.0]},
+ %{"dimensions" => ["/a"], "metrics" => [67.0]}
+ ] = response["results"]
+ end
+
+ test "visit_duration", %{site: site, conn: conn} do
+ site_import =
+ insert(:site_import, site: site, start_date: ~D[2021-01-01], end_date: ~D[2021-02-28])
+
+ populate_stats(site, site_import.id, [
+ build(:pageview, user_id: 123, pathname: "/a", timestamp: ~N[2021-01-01 00:00:00]),
+ build(:imported_exit_pages,
+ exit_page: "/a",
+ exits: 2,
+ visit_duration: 90,
+ date: ~D[2021-01-01]
+ ),
+ build(:imported_exit_pages,
+ exit_page: "/b",
+ exits: 4,
+ visit_duration: 400,
+ date: ~D[2021-01-01]
+ )
+ ])
+
+ conn =
+ post(conn, "/api/v2/query", %{
+ "site_id" => site.domain,
+ "metrics" => ["visit_duration"],
+ "order_by" => [["visit_duration", "desc"]],
+ "dimensions" => ["visit:exit_page"],
+ "date_range" => "all",
+ "include" => %{"imports" => true}
+ })
+
+ response = json_response(conn, 200)
+
+ assert [
+ %{"dimensions" => ["/b"], "metrics" => [100.0]},
+ %{"dimensions" => ["/a"], "metrics" => [30.0]}
+ ] = response["results"]
+ end
+
+ test "views_per_visit", %{site: site, conn: conn} do
+ site_import =
+ insert(:site_import, site: site, start_date: ~D[2021-01-01], end_date: ~D[2021-02-28])
+
+ populate_stats(site, site_import.id, [
+ build(:pageview, user_id: 123, pathname: "/a", timestamp: ~N[2021-01-01 00:00:00]),
+ build(:imported_visitors,
+ visits: 1,
+ pageviews: 3,
+ date: ~D[2021-01-01]
+ )
+ ])
+
+ conn =
+ post(conn, "/api/v2/query", %{
+ "site_id" => site.domain,
+ "metrics" => ["views_per_visit"],
+ "order_by" => [["views_per_visit", "asc"]],
+ "date_range" => "all",
+ "include" => %{"imports" => true}
+ })
+
+ response = json_response(conn, 200)
+
+ assert [%{"dimensions" => [], "metrics" => [2.0]}] = response["results"]
+ end
end
describe "page scroll goals" do
diff --git a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs
index 04dbfdc1fa..229955eb24 100644
--- a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs
@@ -656,10 +656,11 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
]
end
- test ":is filter on page returns only visitors, visits, pageviews and scroll_depth", %{
- conn: conn,
- site: site
- } do
+ test ":is filter on page returns visitors, visits, pageviews bounce_rate, time_on_page and scroll_depth",
+ %{
+ conn: conn,
+ site: site
+ } do
site_import =
insert(:site_import, site: site, start_date: ~D[2021-01-01], has_scroll_depth: true)
@@ -695,6 +696,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
%{"name" => "Unique visitors", "value" => 2, "graph_metric" => "visitors"},
%{"name" => "Total visits", "value" => 4, "graph_metric" => "visits"},
%{"name" => "Total pageviews", "value" => 36, "graph_metric" => "pageviews"},
+ %{"name" => "Bounce rate", "value" => 0, "graph_metric" => "bounce_rate"},
%{"name" => "Scroll depth", "value" => nil, "graph_metric" => "scroll_depth"}
]
end