Skip to content

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

Discard sessions switching hostnames for UTM/referrer breakdowns (#4000)

hq1378d3bc6f568
diff --git a/lib/plausible/stats/breakdown.ex b/lib/plausible/stats/breakdown.ex
index 3b5976d224..c110a4b625 100644
--- a/lib/plausible/stats/breakdown.ex
+++ b/lib/plausible/stats/breakdown.ex
@@ -213,11 +213,18 @@ defmodule Plausible.Stats.Breakdown do
end
end
- defp maybe_update_breakdown_filters("visit:source", query) do
- update_hostname(query, "visit:entry_page_hostname")
- end
-
- defp maybe_update_breakdown_filters("visit:entry_page", query) do
+ defp maybe_update_breakdown_filters(visit_entry_prop, query)
+ when visit_entry_prop in [
+ "visit:source",
+ "visit:entry_page",
+ "visit:utm_medium",
+ "visit:utm_source",
+ "visit:utm_campaign",
+ "visit:utm_content",
+ "visit:utm_term",
+ "visit:entry_page",
+ "visit:referrer"
+ ] do
update_hostname(query, "visit:entry_page_hostname")
end
diff --git a/test/plausible_web/controllers/api/stats_controller/sources_test.exs b/test/plausible_web/controllers/api/stats_controller/sources_test.exs
index 50f8600f4d..8304732ee9 100644
--- a/test/plausible_web/controllers/api/stats_controller/sources_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/sources_test.exs
@@ -497,6 +497,52 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do
end
end
+ describe "UTM parameters with hostname filter" do
+ setup [:create_user, :log_in, :create_new_site]
+
+ for {resource, attr} <- [
+ utm_campaigns: :utm_campaign,
+ utm_sources: :utm_source,
+ utm_terms: :utm_term,
+ utm_contents: :utm_content
+ ] do
+ test "returns #{resource} when filtered by hostname", %{conn: conn, site: site} do
+ populate_stats(site, [
+ # session starts at two.example.com with utm_param=ad
+ build(
+ :pageview,
+ [
+ {unquote(attr), "ad"},
+ {:user_id, @user_id},
+ {:hostname, "two.example.com"},
+ {:timestamp, ~N[2021-01-01 00:00:00]}
+ ]
+ ),
+ # session continues on one.example.com without any utm_params
+ build(
+ :pageview,
+ [
+ {:user_id, @user_id},
+ {:hostname, "one.example.com"},
+ {:timestamp, ~N[2021-01-01 00:15:00]}
+ ]
+ )
+ ])
+
+ filters = Jason.encode!(%{hostname: "one.example.com"})
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/#{unquote(resource)}?period=day&date=2021-01-01&filters=#{filters}"
+ )
+
+ # nobody landed on one.example.com from utm_param=ad
+ assert json_response(conn, 200) == []
+ end
+ end
+ end
+
describe "GET /api/stats/:domain/utm_mediums" do
setup [:create_user, :log_in, :create_new_site, :add_imported_data]
@@ -1473,6 +1519,51 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do
]
end
+ test "returns top referrers for a particular source filtered by hostname", %{
+ conn: conn,
+ site: site
+ } do
+ populate_stats(site, [
+ build(:pageview,
+ referrer_source: "example",
+ referrer: "example.com",
+ hostname: "two.example.com"
+ ),
+ build(:pageview,
+ referrer_source: "example",
+ referrer: "example.com",
+ hostname: "two.example.com",
+ user_id: @user_id
+ ),
+ build(:pageview,
+ hostname: "one.example.com",
+ user_id: @user_id
+ ),
+ build(:pageview,
+ referrer_source: "example",
+ referrer: "example.com/page1",
+ hostname: "one.example.com"
+ ),
+ build(:pageview,
+ referrer_source: "ignored",
+ referrer: "ignored",
+ hostname: "two.example.com"
+ )
+ ])
+
+ filters = Jason.encode!(%{hostname: "one.example.com"})
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/referrers/example?period=day&filters=#{filters}"
+ )
+
+ assert json_response(conn, 200) == [
+ %{"name" => "example.com/page1", "visitors" => 1}
+ ]
+ end
+
test "calculates bounce rate and visit duration for referrer urls", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,