Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Channels in dashboard CSV export (#4787)
Uku Taht98bc3e755436
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.exindex 8794ea7500..92345e5362 100644--- a/lib/plausible_web/controllers/api/stats_controller.ex+++ b/lib/plausible_web/controllers/api/stats_controller.ex@@ -495,11 +495,21 @@ defmodule PlausibleWeb.Api.StatsController doStats.breakdown(site, query, metrics, pagination)|> transform_keys(%{channel: :name})- json(conn, %{- results: res,- meta: Stats.Breakdown.formatted_date_ranges(query),- skip_imported_reason: query.skip_imported_reason- })+ if params["csv"] do+ if Filters.filtering_on_dimension?(query, "event:goal") do+ res+ |> transform_keys(%{visitors: :conversions})+ |> to_csv([:name, :conversions, :conversion_rate])+ else+ res |> to_csv([:name, :visitors, :bounce_rate, :visit_duration])+ end+ else+ json(conn, %{+ results: res,+ meta: Stats.Breakdown.formatted_date_ranges(query),+ skip_imported_reason: query.skip_imported_reason+ })+ endendon_ee dodiff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.exindex 56968e7a97..df89b56cc5 100644--- a/lib/plausible_web/controllers/stats_controller.ex+++ b/lib/plausible_web/controllers/stats_controller.ex@@ -144,6 +144,15 @@ defmodule PlausibleWeb.StatsController do~c"custom_props.csv" => fn -> Api.StatsController.all_custom_prop_values(conn, params) end}+ # credo:disable-for-lines:7+ csvs =+ if FunWithFlags.enabled?(:channels, for: site) ||+ FunWithFlags.enabled?(:channels, for: conn.assigns[:current_user]) do+ Map.put(csvs, ~c"channels.csv", fn -> Api.StatsController.channels(conn, params) end)+ else+ csvs+ end+csv_values =Map.values(csvs)|> Plausible.ClickhouseRepo.parallel_tasks()diff --git a/test/plausible_web/controllers/CSVs/30d-filter-goal/channels.csv b/test/plausible_web/controllers/CSVs/30d-filter-goal/channels.csvnew file mode 100644index 0000000000..ef51cc3873--- /dev/null+++ b/test/plausible_web/controllers/CSVs/30d-filter-goal/channels.csv@@ -0,0 +1,2 @@+name,conversions,conversion_rate+Direct,1,50.0diff --git a/test/plausible_web/controllers/CSVs/30d-filter-path/channels.csv b/test/plausible_web/controllers/CSVs/30d-filter-path/channels.csvnew file mode 100644index 0000000000..2a5bdece04--- /dev/null+++ b/test/plausible_web/controllers/CSVs/30d-filter-path/channels.csv@@ -0,0 +1,2 @@+name,visitors,bounce_rate,visit_duration+Organic Search,1,0,60diff --git a/test/plausible_web/controllers/CSVs/30d/channels.csv b/test/plausible_web/controllers/CSVs/30d/channels.csvnew file mode 100644index 0000000000..cb64270814--- /dev/null+++ b/test/plausible_web/controllers/CSVs/30d/channels.csv@@ -0,0 +1,4 @@+name,visitors,bounce_rate,visit_duration+Direct,2,50,30+Organic Search,1,0,60+Paid Search,1,100,0diff --git a/test/plausible_web/controllers/CSVs/6m/channels.csv b/test/plausible_web/controllers/CSVs/6m/channels.csvnew file mode 100644index 0000000000..1158469940--- /dev/null+++ b/test/plausible_web/controllers/CSVs/6m/channels.csv@@ -0,0 +1,4 @@+name,visitors,bounce_rate,visit_duration+Direct,2,50,30+Paid Search,2,100,0+Organic Search,1,0,60diff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exsindex a8831c8a70..7608cca931 100644--- a/test/plausible_web/controllers/stats_controller_test.exs+++ b/test/plausible_web/controllers/stats_controller_test.exs@@ -208,6 +208,7 @@ defmodule PlausibleWeb.StatsControllerTest doassert ~c"pages.csv" in zipassert ~c"regions.csv" in zipassert ~c"sources.csv" in zip+ assert ~c"channels.csv" in zipassert ~c"utm_campaigns.csv" in zipassert ~c"utm_contents.csv" in zipassert ~c"utm_mediums.csv" in zip@@ -423,6 +424,7 @@ defmodule PlausibleWeb.StatsControllerTest doexpected_filenames = ["visitors.csv","sources.csv",+ "channels.csv","utm_mediums.csv","utm_sources.csv","utm_campaigns.csv",@@ -471,6 +473,13 @@ defmodule PlausibleWeb.StatsControllerTest do[""]]+ # Dummy - imported data is not actually included in exported CSVs yet+ {~c"channels.csv", data} ->+ assert parse_csv(data) == [+ ["name", "visitors", "bounce_rate", "visit_duration"],+ [""]+ ]+{~c"utm_mediums.csv", data} ->assert parse_csv(data) == [["name", "visitors", "bounce_rate", "visit_duration"],@@ -685,7 +694,8 @@ defmodule PlausibleWeb.StatsControllerTest docountry_code: "EE",subdivision1_code: "EE-37",city_geoname_id: 588_409,- referrer_source: "Google"+ referrer_source: "Google",+ channel: "Organic Search"),build(:pageview,user_id: 123,@@ -695,7 +705,8 @@ defmodule PlausibleWeb.StatsControllerTest docountry_code: "EE",subdivision1_code: "EE-37",city_geoname_id: 588_409,- referrer_source: "Google"+ referrer_source: "Google",+ channel: "Organic Search"),build(:pageview,pathname: "/",@@ -706,6 +717,7 @@ defmodule PlausibleWeb.StatsControllerTest doutm_source: "google",utm_content: "content",utm_term: "term",+ channel: "Paid Search",browser: "Firefox",browser_version: "120",operating_system: "Mac",@@ -726,6 +738,7 @@ defmodule PlausibleWeb.StatsControllerTest doutm_campaign: "ads",country_code: "EE",referrer_source: "Google",+ channel: "Paid Search",browser: "FirefoxNoVersion",operating_system: "MacNoVersion"),diff --git a/test/test_helper.exs b/test/test_helper.exsindex 963a846083..c2115df9ca 100644--- a/test/test_helper.exs+++ b/test/test_helper.exs@@ -6,6 +6,7 @@ endMox.defmock(Plausible.HTTPClient.Mock, for: Plausible.HTTPClient.Interface)Application.ensure_all_started(:double)+FunWithFlags.enable(:channels)# Temporary flag to test `read_team_schemas` flag on all tests.if System.get_env("TEST_READ_TEAM_SCHEMAS") == "1" doFunWithFlags.enable(:read_team_schemas)