diff --git a/lib/plausible/stats/custom_props.ex b/lib/plausible/stats/custom_props.ex index d37a0dffb..73e7a402f 100644 --- a/lib/plausible/stats/custom_props.ex +++ b/lib/plausible/stats/custom_props.ex @@ -34,7 +34,7 @@ defmodule Plausible.Stats.CustomProps do end end - defp fetch_prop_names(site, query) do + def fetch_prop_names(site, query) do case Query.get_filter_by_prefix(query, "event:props:") do {"event:props:" <> key, _} -> [key] diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index a40b90ba4..4188cc029 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -1189,7 +1189,33 @@ defmodule PlausibleWeb.Api.StatsController do props end - json(conn, props) + if params["csv"] do + props + else + json(conn, props) + end + end + + def all_custom_prop_values(conn, params) do + site = conn.assigns[:site] + query = Query.from(site, params) |> Filters.add_prefix() + + prop_names = Plausible.Stats.CustomProps.fetch_prop_names(site, query) + + values = + prop_names + |> Enum.map(fn prop_key -> + custom_prop_values(conn, Map.put(params, "prop_key", prop_key)) + |> Enum.map(&Map.put(&1, :property, prop_key)) + |> transform_keys(%{:name => :value}) + end) + |> Enum.concat() + + percent_or_cr = if query.filters["event:goal"], + do: :conversion_rate, + else: :percentage + + to_csv(values, [:property, :value, :visitors, :events, percent_or_cr]) end def prop_breakdown(conn, params) do diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex index ea4cf908d..180ac0d3e 100644 --- a/lib/plausible_web/controllers/stats_controller.ex +++ b/lib/plausible_web/controllers/stats_controller.ex @@ -148,6 +148,15 @@ defmodule PlausibleWeb.StatsController do 'prop_breakdown.csv' => fn -> Api.StatsController.all_props_breakdown(conn, params) end } + csvs = + if FunWithFlags.enabled?(:props) do + Map.put(csvs, 'custom_props.csv', fn -> + Api.StatsController.all_custom_prop_values(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/custom_props.csv b/test/plausible_web/controllers/CSVs/30d-filter-goal/custom_props.csv new file mode 100644 index 000000000..0a7292eeb --- /dev/null +++ b/test/plausible_web/controllers/CSVs/30d-filter-goal/custom_props.csv @@ -0,0 +1,2 @@ +property,value,visitors,events,conversion_rate +variant,A,1,1,25.0 diff --git a/test/plausible_web/controllers/CSVs/30d-filter-path/custom_props.csv b/test/plausible_web/controllers/CSVs/30d-filter-path/custom_props.csv new file mode 100644 index 000000000..ccda36445 --- /dev/null +++ b/test/plausible_web/controllers/CSVs/30d-filter-path/custom_props.csv @@ -0,0 +1 @@ +property,value,visitors,events,percentage diff --git a/test/plausible_web/controllers/CSVs/30d/custom_props.csv b/test/plausible_web/controllers/CSVs/30d/custom_props.csv new file mode 100644 index 000000000..22ccc27a4 --- /dev/null +++ b/test/plausible_web/controllers/CSVs/30d/custom_props.csv @@ -0,0 +1,3 @@ +property,value,visitors,events,percentage +variant,(none),3,4,75.0 +variant,A,1,1,25.0 diff --git a/test/plausible_web/controllers/CSVs/6m/custom_props.csv b/test/plausible_web/controllers/CSVs/6m/custom_props.csv new file mode 100644 index 000000000..46a4e35d1 --- /dev/null +++ b/test/plausible_web/controllers/CSVs/6m/custom_props.csv @@ -0,0 +1,3 @@ +property,value,visitors,events,percentage +variant,(none),4,5,80.0 +variant,A,1,1,20.0 diff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exs index 18768f7e1..314ea7f55 100644 --- a/test/plausible_web/controllers/stats_controller_test.exs +++ b/test/plausible_web/controllers/stats_controller_test.exs @@ -139,6 +139,37 @@ defmodule PlausibleWeb.StatsControllerTest do |> response(400) end + test "exports allowed event props", %{conn: conn, site: site} do + site = Plausible.Sites.set_allowed_event_props(site, ["author", "logged_in"]) + + populate_stats(site, [ + build(:pageview, "meta.key": ["author"], "meta.value": ["uku"]), + build(:pageview, "meta.key": ["author"], "meta.value": ["uku"]), + build(:event, "meta.key": ["author"], "meta.value": ["marko"], name: "Newsletter Signup"), + build(:pageview, user_id: 999, "meta.key": ["logged_in"], "meta.value": ["true"]), + build(:pageview, user_id: 999, "meta.key": ["logged_in"], "meta.value": ["true"]), + build(:pageview, "meta.key": ["disallowed"], "meta.value": ["whatever"]), + build(:pageview) + ]) + + conn = get(conn, "/" <> site.domain <> "/export?period=day") + assert response = response(conn, 200) + {:ok, zip} = :zip.unzip(response, [:memory]) + + {_filename, result} = + Enum.find(zip, fn {filename, _data} -> filename == 'custom_props.csv' end) + + assert parse_csv(result) == [ + ["property", "value", "visitors", "events", "percentage"], + ["author", "(none)", "3", "4", "50.0"], + ["author", "uku", "2", "2", "33.3"], + ["author", "marko", "1", "1", "16.7"], + ["logged_in", "(none)", "5", "5", "83.3"], + ["logged_in", "true", "1", "2", "16.7"], + [""] + ] + end + test "exports data grouped by interval", %{conn: conn, site: site} do populate_exported_stats(site) conn = get(conn, "/" <> site.domain <> "/export?date=2021-10-20&period=30d&interval=week") diff --git a/test/test_helper.exs b/test/test_helper.exs index eac352c8d..72fb0e84e 100644 --- a/test/test_helper.exs +++ b/test/test_helper.exs @@ -2,5 +2,6 @@ Mox.defmock(Plausible.HTTPClient.Mock, for: Plausible.HTTPClient.Interface) Application.ensure_all_started(:double) FunWithFlags.enable(:funnels) +FunWithFlags.enable(:props) Ecto.Adapters.SQL.Sandbox.mode(Plausible.Repo, :manual) ExUnit.configure(exclude: [:slow])