diff --git a/lib/plausible/stats/breakdown.ex b/lib/plausible/stats/breakdown.ex index ad04d0604..4716a9049 100644 --- a/lib/plausible/stats/breakdown.ex +++ b/lib/plausible/stats/breakdown.ex @@ -130,9 +130,15 @@ defmodule Plausible.Stats.Breakdown do breakdown_events(site, query, property, metrics, pagination) end - def breakdown(site, query, "visit:source", metrics, pagination) do + def breakdown(site, query, property, metrics, pagination) + when property in [ + "visit:source", + "visit:utm_medium", + "visit:utm_source", + "visit:utm_campaign" + ] do query = Query.treat_page_filter_as_entry_page(query) - breakdown_sessions(site, query, "visit:source", metrics, pagination) + breakdown_sessions(site, query, property, metrics, pagination) end def breakdown(site, query, property, metrics, pagination) do diff --git a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs index c9bc52a6a..9b7e20e1a 100644 --- a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs +++ b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs @@ -814,6 +814,9 @@ defmodule PlausibleWeb.Api.ExternalStatsController.BreakdownTest do build(:pageview, pathname: "/ignore", referrer_source: "Should not show up", + utm_medium: "Should not show up", + utm_source: "Should not show up", + utm_campaign: "Should not show up", user_id: @user_id ), build(:pageview, @@ -822,23 +825,28 @@ defmodule PlausibleWeb.Api.ExternalStatsController.BreakdownTest do ), build(:pageview, pathname: "/plausible.io", - referrer_source: "Google" + referrer_source: "Google", + utm_medium: "Google", + utm_source: "Google", + utm_campaign: "Google" ) ]) - conn = - get(conn, "/api/v1/stats/breakdown", %{ - "site_id" => site.domain, - "period" => "day", - "property" => "visit:source", - "filters" => "event:page==/plausible.io" - }) - - assert json_response(conn, 200) == %{ - "results" => [ - %{"source" => "Google", "visitors" => 1} - ] - } + for property <- ["source", "utm_medium", "utm_source", "utm_campaign"] do + conn = + get(conn, "/api/v1/stats/breakdown", %{ + "site_id" => site.domain, + "period" => "day", + "property" => "visit:" <> property, + "filters" => "event:page==/plausible.io" + }) + + assert json_response(conn, 200) == %{ + "results" => [ + %{property => "Google", "visitors" => 1} + ] + } + end end test "event:goal pageview filter for breakdown by visit source", %{conn: conn, site: site} do