Skip to content

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

Add cities and regions to exported CSV data (#1485)

Matt Colligan8148d41e4207
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex
index 58175f01ce..5eeb7b4da8 100644
--- a/lib/plausible_web/controllers/api/stats_controller.ex
+++ b/lib/plausible_web/controllers/api/stats_controller.ex
@@ -585,7 +585,7 @@ defmodule PlausibleWeb.Api.StatsController do
query = Query.from(site.timezone, params) |> Filters.add_prefix()
pagination = parse_pagination(params)
- countries =
+ regions =
Stats.breakdown(site, query, "visit:region", ["visitors"], pagination)
|> transform_keys(%{"region" => "code"})
|> Enum.map(fn region ->
@@ -594,7 +594,17 @@ defmodule PlausibleWeb.Api.StatsController do
Map.merge(region, %{"name" => region_entry.name, "country_flag" => country_entry.flag})
end)
- json(conn, countries)
+ if params["csv"] do
+ if Map.has_key?(query.filters, "event:goal") do
+ regions
+ |> transform_keys(%{"visitors" => "conversions"})
+ |> to_csv(["name", "conversions", "conversion_rate"])
+ else
+ regions |> to_csv(["name", "visitors"])
+ end
+ else
+ json(conn, regions)
+ end
end
def cities(conn, params) do
@@ -620,7 +630,17 @@ defmodule PlausibleWeb.Api.StatsController do
end
end)
- json(conn, cities)
+ if params["csv"] do
+ if Map.has_key?(query.filters, "event:goal") do
+ cities
+ |> transform_keys(%{"visitors" => "conversions"})
+ |> to_csv(["name", "conversions", "conversion_rate"])
+ else
+ cities |> to_csv(["name", "visitors"])
+ end
+ else
+ json(conn, cities)
+ end
end
def browsers(conn, params) do
diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex
index 192d6f4652..f0d2b35730 100644
--- a/lib/plausible_web/controllers/stats_controller.ex
+++ b/lib/plausible_web/controllers/stats_controller.ex
@@ -76,6 +76,8 @@ defmodule PlausibleWeb.StatsController do
{'entry_pages.csv', fn -> Api.StatsController.entry_pages(conn, params) end},
{'exit_pages.csv', fn -> Api.StatsController.exit_pages(conn, limited_params) end},
{'countries.csv', fn -> Api.StatsController.countries(conn, params) end},
+ {'regions.csv', fn -> Api.StatsController.regions(conn, params) end},
+ {'cities.csv', fn -> Api.StatsController.cities(conn, params) end},
{'browsers.csv', fn -> Api.StatsController.browsers(conn, params) end},
{'operating_systems.csv', fn -> Api.StatsController.operating_systems(conn, params) end},
{'devices.csv', fn -> Api.StatsController.screen_sizes(conn, params) end},
diff --git a/test/plausible_web/controllers/CSVs/30d-filter-goal/cities.csv b/test/plausible_web/controllers/CSVs/30d-filter-goal/cities.csv
new file mode 100644
index 0000000000..854a70d52f
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filter-goal/cities.csv
@@ -0,0 +1 @@
+name,conversions,conversion_rate
diff --git a/test/plausible_web/controllers/CSVs/30d-filter-goal/regions.csv b/test/plausible_web/controllers/CSVs/30d-filter-goal/regions.csv
new file mode 100644
index 0000000000..854a70d52f
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filter-goal/regions.csv
@@ -0,0 +1 @@
+name,conversions,conversion_rate
diff --git a/test/plausible_web/controllers/CSVs/30d-filter-path/cities.csv b/test/plausible_web/controllers/CSVs/30d-filter-path/cities.csv
new file mode 100644
index 0000000000..9816303bc6
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filter-path/cities.csv
@@ -0,0 +1,2 @@
+name,visitors
+Tallinn,1
diff --git a/test/plausible_web/controllers/CSVs/30d-filter-path/regions.csv b/test/plausible_web/controllers/CSVs/30d-filter-path/regions.csv
new file mode 100644
index 0000000000..94104deeb5
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filter-path/regions.csv
@@ -0,0 +1,2 @@
+name,visitors
+Harjumaa,1
diff --git a/test/plausible_web/controllers/CSVs/30d/cities.csv b/test/plausible_web/controllers/CSVs/30d/cities.csv
new file mode 100644
index 0000000000..9816303bc6
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d/cities.csv
@@ -0,0 +1,2 @@
+name,visitors
+Tallinn,1
diff --git a/test/plausible_web/controllers/CSVs/30d/regions.csv b/test/plausible_web/controllers/CSVs/30d/regions.csv
new file mode 100644
index 0000000000..94104deeb5
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d/regions.csv
@@ -0,0 +1,2 @@
+name,visitors
+Harjumaa,1
diff --git a/test/plausible_web/controllers/CSVs/6m/cities.csv b/test/plausible_web/controllers/CSVs/6m/cities.csv
new file mode 100644
index 0000000000..9816303bc6
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/6m/cities.csv
@@ -0,0 +1,2 @@
+name,visitors
+Tallinn,1
diff --git a/test/plausible_web/controllers/CSVs/6m/regions.csv b/test/plausible_web/controllers/CSVs/6m/regions.csv
new file mode 100644
index 0000000000..94104deeb5
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/6m/regions.csv
@@ -0,0 +1,2 @@
+name,visitors
+Harjumaa,1
diff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exs
index 0905f1e49f..4cbb2a6959 100644
--- a/test/plausible_web/controllers/stats_controller_test.exs
+++ b/test/plausible_web/controllers/stats_controller_test.exs
@@ -112,6 +112,8 @@ defmodule PlausibleWeb.StatsControllerTest do
populate_stats(site, [
build(:pageview,
country_code: "EE",
+ subdivision1_code: "EE-37",
+ city_geoname_id: 588_409,
pathname: "/",
timestamp: Timex.shift(~N[2021-10-20 12:00:00], minutes: -1),
referrer_source: "Google",
@@ -119,6 +121,8 @@ defmodule PlausibleWeb.StatsControllerTest do
),
build(:pageview,
country_code: "EE",
+ subdivision1_code: "EE-37",
+ city_geoname_id: 588_409,
pathname: "/some-other-page",
timestamp: Timex.shift(~N[2021-10-20 12:00:00], minutes: -2),
referrer_source: "Google",