Skip to content

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

Apply existing filter to visitors.csv in export (#1454)

Matt Colligand7813018865b
diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex
index 9d84535f75..4e0469e7cd 100644
--- a/lib/plausible_web/controllers/stats_controller.ex
+++ b/lib/plausible_web/controllers/stats_controller.ex
@@ -2,7 +2,7 @@ defmodule PlausibleWeb.StatsController do
use PlausibleWeb, :controller
use Plausible.Repo
alias PlausibleWeb.Api
- alias Plausible.Stats.Query
+ alias Plausible.Stats.{Query, Filters}
plug PlausibleWeb.AuthorizeSiteAccess when action in [:stats, :csv_export]
@@ -42,17 +42,10 @@ defmodule PlausibleWeb.StatsController do
def csv_export(conn, params) do
site = conn.assigns[:site]
- query = Query.from(site.timezone, params)
-
- metrics =
- if query.filters["event:name"] do
- ["visitors", "pageviews"]
- else
- ["visitors", "pageviews", "bounce_rate", "visit_duration"]
- end
+ query = Query.from(site.timezone, params) |> Filters.add_prefix()
+ metrics = ["visitors", "pageviews", "bounce_rate", "visit_duration"]
graph = Plausible.Stats.timeseries(site, query, metrics)
-
headers = ["date" | metrics]
visitors =
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/browsers.csv b/test/plausible_web/controllers/CSVs/30d-filtered/browsers.csv
new file mode 100644
index 0000000000..7b062ae5bb
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/browsers.csv
@@ -0,0 +1,2 @@
+name,visitors
+,1
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/conversions.csv b/test/plausible_web/controllers/CSVs/30d-filtered/conversions.csv
new file mode 100644
index 0000000000..f61d3a75c9
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/conversions.csv
@@ -0,0 +1,2 @@
+name,unique_conversions,total_conversions
+Visit /some-other-page,1,1
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/countries.csv b/test/plausible_web/controllers/CSVs/30d-filtered/countries.csv
new file mode 100644
index 0000000000..7fd0fa6da7
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/countries.csv
@@ -0,0 +1,2 @@
+name,visitors
+Estonia,1
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/devices.csv b/test/plausible_web/controllers/CSVs/30d-filtered/devices.csv
new file mode 100644
index 0000000000..7b062ae5bb
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/devices.csv
@@ -0,0 +1,2 @@
+name,visitors
+,1
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/entry_pages.csv b/test/plausible_web/controllers/CSVs/30d-filtered/entry_pages.csv
new file mode 100644
index 0000000000..9ee95b1a87
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/entry_pages.csv
@@ -0,0 +1,2 @@
+name,unique_entrances,total_entrances,visit_duration
+/,1,1,60
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/exit_pages.csv b/test/plausible_web/controllers/CSVs/30d-filtered/exit_pages.csv
new file mode 100644
index 0000000000..8971817457
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/exit_pages.csv
@@ -0,0 +1,2 @@
+name,unique_exits,total_exits,exit_rate
+/some-other-page,1,1,100.0
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/operating_systems.csv b/test/plausible_web/controllers/CSVs/30d-filtered/operating_systems.csv
new file mode 100644
index 0000000000..7b062ae5bb
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/operating_systems.csv
@@ -0,0 +1,2 @@
+name,visitors
+,1
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/pages.csv b/test/plausible_web/controllers/CSVs/30d-filtered/pages.csv
new file mode 100644
index 0000000000..711f9fb0b6
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/pages.csv
@@ -0,0 +1,2 @@
+name,visitors,bounce_rate,time_on_page
+/some-other-page,1,,60.0
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/sources.csv b/test/plausible_web/controllers/CSVs/30d-filtered/sources.csv
new file mode 100644
index 0000000000..773a58cf75
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/sources.csv
@@ -0,0 +1 @@
+name,visitors,bounce_rate,visit_duration
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/utm_campaigns.csv b/test/plausible_web/controllers/CSVs/30d-filtered/utm_campaigns.csv
new file mode 100644
index 0000000000..773a58cf75
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/utm_campaigns.csv
@@ -0,0 +1 @@
+name,visitors,bounce_rate,visit_duration
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/utm_mediums.csv b/test/plausible_web/controllers/CSVs/30d-filtered/utm_mediums.csv
new file mode 100644
index 0000000000..773a58cf75
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/utm_mediums.csv
@@ -0,0 +1 @@
+name,visitors,bounce_rate,visit_duration
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/utm_sources.csv b/test/plausible_web/controllers/CSVs/30d-filtered/utm_sources.csv
new file mode 100644
index 0000000000..773a58cf75
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/utm_sources.csv
@@ -0,0 +1 @@
+name,visitors,bounce_rate,visit_duration
diff --git a/test/plausible_web/controllers/CSVs/30d-filtered/visitors.csv b/test/plausible_web/controllers/CSVs/30d-filtered/visitors.csv
new file mode 100644
index 0000000000..b79ea927f5
--- /dev/null
+++ b/test/plausible_web/controllers/CSVs/30d-filtered/visitors.csv
@@ -0,0 +1,32 @@
+date,visitors,pageviews,bounce_rate,visit_duration
+2021-09-20,0,0,,
+2021-09-21,0,0,,
+2021-09-22,0,0,,
+2021-09-23,0,0,,
+2021-09-24,0,0,,
+2021-09-25,0,0,,
+2021-09-26,0,0,,
+2021-09-27,0,0,,
+2021-09-28,0,0,,
+2021-09-29,0,0,,
+2021-09-30,0,0,,
+2021-10-01,0,0,,
+2021-10-02,0,0,,
+2021-10-03,0,0,,
+2021-10-04,0,0,,
+2021-10-05,0,0,,
+2021-10-06,0,0,,
+2021-10-07,0,0,,
+2021-10-08,0,0,,
+2021-10-09,0,0,,
+2021-10-10,0,0,,
+2021-10-11,0,0,,
+2021-10-12,0,0,,
+2021-10-13,0,0,,
+2021-10-14,0,0,,
+2021-10-15,0,0,,
+2021-10-16,0,0,,
+2021-10-17,0,0,,
+2021-10-18,0,0,,
+2021-10-19,0,0,,
+2021-10-20,1,1,,
diff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exs
index e81d2f4725..b488a49680 100644
--- a/test/plausible_web/controllers/stats_controller_test.exs
+++ b/test/plausible_web/controllers/stats_controller_test.exs
@@ -75,6 +75,18 @@ defmodule PlausibleWeb.StatsControllerTest do
end
end
+ describe "GET /:website/export - with path filter" do
+ setup [:create_user, :create_new_site, :log_in]
+
+ test "exports filtered data in zipped csvs", %{conn: conn, site: site} do
+ populate_exported_stats(site)
+
+ filters = Jason.encode!(%{page: "/some-other-page"})
+ conn = get(conn, "/#{site.domain}/export?date=2021-10-20&filters=#{filters}")
+ assert_zip(conn, "30d-filtered")
+ end
+ end
+
defp assert_zip(conn, folder) do
assert conn.status == 200