Skip to content

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

Add UTM content and term to CSV export

Uku Taht4ea0e296201e
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex
index 62e38798f1..58175f01ce 100644
--- a/lib/plausible_web/controllers/api/stats_controller.ex
+++ b/lib/plausible_web/controllers/api/stats_controller.ex
@@ -301,9 +301,19 @@ defmodule PlausibleWeb.Api.StatsController do
res =
Stats.breakdown(site, query, "visit:utm_content", metrics, pagination)
|> maybe_add_cr(site, query, pagination, "utm_content", "visit:utm_content")
- |> transform_keys(%{"utm_content" => "name", "visitors" => "count"})
+ |> transform_keys(%{"utm_content" => "name"})
- json(conn, res)
+ if params["csv"] do
+ if Map.has_key?(query.filters, "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, res)
+ end
end
def utm_terms(conn, params) do
@@ -320,9 +330,19 @@ defmodule PlausibleWeb.Api.StatsController do
res =
Stats.breakdown(site, query, "visit:utm_term", metrics, pagination)
|> maybe_add_cr(site, query, pagination, "utm_term", "visit:utm_term")
- |> transform_keys(%{"utm_term" => "name", "visitors" => "count"})
+ |> transform_keys(%{"utm_term" => "name"})
- json(conn, res)
+ if params["csv"] do
+ if Map.has_key?(query.filters, "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, res)
+ end
end
def utm_sources(conn, params) do
diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex
index 7641e20d31..192d6f4652 100644
--- a/lib/plausible_web/controllers/stats_controller.ex
+++ b/lib/plausible_web/controllers/stats_controller.ex
@@ -70,6 +70,8 @@ defmodule PlausibleWeb.StatsController do
{'utm_mediums.csv', fn -> Api.StatsController.utm_mediums(conn, params) end},
{'utm_sources.csv', fn -> Api.StatsController.utm_sources(conn, params) end},
{'utm_campaigns.csv', fn -> Api.StatsController.utm_campaigns(conn, params) end},
+ {'utm_contents.csv', fn -> Api.StatsController.utm_contents(conn, params) end},
+ {'utm_terms.csv', fn -> Api.StatsController.utm_terms(conn, params) end},
{'pages.csv', fn -> Api.StatsController.pages(conn, limited_params) end},
{'entry_pages.csv', fn -> Api.StatsController.entry_pages(conn, params) end},
{'exit_pages.csv', fn -> Api.StatsController.exit_pages(conn, limited_params) end},
diff --git a/test/plausible_web/controllers/CSVs/30d-filter-goal/utm_contents.csv b/test/plausible_web/controllers/CSVs/30d-filter-goal/utm_contents.csv
new file mode 100644
index 0000000000..854a70d52f
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filter-goal/utm_contents.csv
@@ -0,0 +1 @@
+name,conversions,conversion_rate
diff --git a/test/plausible_web/controllers/CSVs/30d-filter-goal/utm_terms.csv b/test/plausible_web/controllers/CSVs/30d-filter-goal/utm_terms.csv
new file mode 100644
index 0000000000..854a70d52f
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filter-goal/utm_terms.csv
@@ -0,0 +1 @@
+name,conversions,conversion_rate
diff --git a/test/plausible_web/controllers/CSVs/30d-filter-path/utm_contents.csv b/test/plausible_web/controllers/CSVs/30d-filter-path/utm_contents.csv
new file mode 100644
index 0000000000..773a58cf75
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filter-path/utm_contents.csv
@@ -0,0 +1 @@
+name,visitors,bounce_rate,visit_duration
diff --git a/test/plausible_web/controllers/CSVs/30d-filter-path/utm_terms.csv b/test/plausible_web/controllers/CSVs/30d-filter-path/utm_terms.csv
new file mode 100644
index 0000000000..773a58cf75
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filter-path/utm_terms.csv
@@ -0,0 +1 @@
+name,visitors,bounce_rate,visit_duration
diff --git a/test/plausible_web/controllers/CSVs/30d/utm_contents.csv b/test/plausible_web/controllers/CSVs/30d/utm_contents.csv
new file mode 100644
index 0000000000..6f8d1ba255
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d/utm_contents.csv
@@ -0,0 +1,2 @@
+name,visitors,bounce_rate,visit_duration
+content,1,100,0
diff --git a/test/plausible_web/controllers/CSVs/30d/utm_mediums.csv b/test/plausible_web/controllers/CSVs/30d/utm_mediums.csv
index 773a58cf75..1fe1c21a28 100644
--- a/test/plausible_web/controllers/CSVs/30d/utm_mediums.csv
+++ b/test/plausible_web/controllers/CSVs/30d/utm_mediums.csv
@@ -1 +1,2 @@
name,visitors,bounce_rate,visit_duration
+search,1,100,0
diff --git a/test/plausible_web/controllers/CSVs/30d/utm_sources.csv b/test/plausible_web/controllers/CSVs/30d/utm_sources.csv
index 773a58cf75..b32c9660a0 100644
--- a/test/plausible_web/controllers/CSVs/30d/utm_sources.csv
+++ b/test/plausible_web/controllers/CSVs/30d/utm_sources.csv
@@ -1 +1,2 @@
name,visitors,bounce_rate,visit_duration
+google,1,100,0
diff --git a/test/plausible_web/controllers/CSVs/30d/utm_terms.csv b/test/plausible_web/controllers/CSVs/30d/utm_terms.csv
new file mode 100644
index 0000000000..cbd3a7ce40
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d/utm_terms.csv
@@ -0,0 +1,2 @@
+name,visitors,bounce_rate,visit_duration
+term,1,100,0
diff --git a/test/plausible_web/controllers/CSVs/6m/utm_contents.csv b/test/plausible_web/controllers/CSVs/6m/utm_contents.csv
new file mode 100644
index 0000000000..6f8d1ba255
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/6m/utm_contents.csv
@@ -0,0 +1,2 @@
+name,visitors,bounce_rate,visit_duration
+content,1,100,0
diff --git a/test/plausible_web/controllers/CSVs/6m/utm_mediums.csv b/test/plausible_web/controllers/CSVs/6m/utm_mediums.csv
index 773a58cf75..1fe1c21a28 100644
--- a/test/plausible_web/controllers/CSVs/6m/utm_mediums.csv
+++ b/test/plausible_web/controllers/CSVs/6m/utm_mediums.csv
@@ -1 +1,2 @@
name,visitors,bounce_rate,visit_duration
+search,1,100,0
diff --git a/test/plausible_web/controllers/CSVs/6m/utm_sources.csv b/test/plausible_web/controllers/CSVs/6m/utm_sources.csv
index 773a58cf75..b32c9660a0 100644
--- a/test/plausible_web/controllers/CSVs/6m/utm_sources.csv
+++ b/test/plausible_web/controllers/CSVs/6m/utm_sources.csv
@@ -1 +1,2 @@
name,visitors,bounce_rate,visit_duration
+google,1,100,0
diff --git a/test/plausible_web/controllers/CSVs/6m/utm_terms.csv b/test/plausible_web/controllers/CSVs/6m/utm_terms.csv
new file mode 100644
index 0000000000..cbd3a7ce40
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/6m/utm_terms.csv
@@ -0,0 +1,2 @@
+name,visitors,bounce_rate,visit_duration
+term,1,100,0
diff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exs
index 207dea8885..0905f1e49f 100644
--- a/test/plausible_web/controllers/stats_controller_test.exs
+++ b/test/plausible_web/controllers/stats_controller_test.exs
@@ -104,7 +104,8 @@ defmodule PlausibleWeb.StatsControllerTest do
file = Path.expand(file, folder)
{:ok, content} = File.read(file)
- assert downloaded == content
+ msg = "CSV file comparison failed (#{file})"
+ assert downloaded == content, message: msg, left: downloaded, right: content
end
defp populate_exported_stats(site) do
@@ -125,7 +126,11 @@ defmodule PlausibleWeb.StatsControllerTest do
),
build(:pageview,
pathname: "/",
+ utm_medium: "search",
utm_campaign: "ads",
+ utm_source: "google",
+ utm_content: "content",
+ utm_term: "term",
timestamp: Timex.shift(~N[2021-10-20 12:00:00], days: -1),
browser: "ABrowserName"
),