Skip to content

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

Add a special goal: "WP Form Completions" (#5013)

RobertJoonas9ba6df7b3c76
diff --git a/assets/js/dashboard/stats/behaviours/goal-conversions.js b/assets/js/dashboard/stats/behaviours/goal-conversions.js
index 5be1569a54..f5abc5fbba 100644
--- a/assets/js/dashboard/stats/behaviours/goal-conversions.js
+++ b/assets/js/dashboard/stats/behaviours/goal-conversions.js
@@ -15,6 +15,7 @@ export const SPECIAL_GOALS = {
'Cloaked Link: Click': { title: 'Cloaked Links', prop: 'url' },
'File Download': { title: 'File Downloads', prop: 'url' },
'WP Search Queries': { title: 'WordPress Search Queries', prop: 'search_query' },
+ 'WP Form Completions': { title: 'WordPress Form Completions', prop: 'path' },
}
function getSpecialGoal(query) {
diff --git a/lib/plausible/imported.ex b/lib/plausible/imported.ex
index 14a758be92..6ae034e7ae 100644
--- a/lib/plausible/imported.ex
+++ b/lib/plausible/imported.ex
@@ -36,7 +36,7 @@ defmodule Plausible.Imported do
# Goals which can be filtered by url property
@goals_with_url ["Outbound Link: Click", "Cloaked Link: Click", "File Download"]
# Goals which can be filtered by path property
- @goals_with_path ["404"]
+ @goals_with_path ["404", "WP Form Completions"]
@spec schemas() :: [module()]
def schemas, do: @tables
diff --git a/test/plausible/props_test.exs b/test/plausible/props_test.exs
index 0d83a3f50b..20bacfedd0 100644
--- a/test/plausible/props_test.exs
+++ b/test/plausible/props_test.exs
@@ -275,6 +275,11 @@ defmodule Plausible.PropsTest do
name: "WP Search Queries",
"meta.key": ["search_query", "result_count"],
"meta.value": ["something", "12"]
+ ),
+ build(:event,
+ name: "WP Form Completions",
+ "meta.key": ["path"],
+ "meta.value": ["/contact"]
)
])
diff --git a/test/plausible_web/controllers/api/stats_controller/custom_prop_breakdown_test.exs b/test/plausible_web/controllers/api/stats_controller/custom_prop_breakdown_test.exs
index d25228b293..445a28c34c 100644
--- a/test/plausible_web/controllers/api/stats_controller/custom_prop_breakdown_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/custom_prop_breakdown_test.exs
@@ -1179,31 +1179,31 @@ defmodule PlausibleWeb.Api.StatsController.CustomPropBreakdownTest do
describe "GET /api/stats/:domain/custom-prop-values/:prop_key - for a Growth subscription" do
setup [:create_user, :log_in, :create_site]
- setup %{user: user, site: site} do
+ setup %{user: user} do
subscribe_to_growth_plan(user)
-
- populate_stats(site, [
- build(:pageview,
- "meta.key": ["url", "path", "author"],
- "meta.value": ["one", "two", "three"]
- )
- ])
-
:ok
end
- test "returns breakdown for internally used prop keys", %{conn: conn, site: site} do
- [%{"visitors" => 1, "name" => "one"}] =
- conn
- |> get("/api/stats/#{site.domain}/custom-prop-values/url?period=day")
- |> json_response(200)
- |> Map.get("results")
+ for special_prop <- Plausible.Props.internal_keys() do
+ test "returns breakdown for the internally used #{special_prop} prop key", %{
+ site: site,
+ conn: conn
+ } do
+ populate_stats(site, [
+ build(:pageview,
+ "meta.key": [unquote(special_prop)],
+ "meta.value": ["some_value"]
+ )
+ ])
- [%{"visitors" => 1, "name" => "two"}] =
- conn
- |> get("/api/stats/#{site.domain}/custom-prop-values/path?period=day")
- |> json_response(200)
- |> Map.get("results")
+ assert [%{"visitors" => 1, "name" => "some_value"}] =
+ conn
+ |> get(
+ "/api/stats/#{site.domain}/custom-prop-values/#{unquote(special_prop)}?period=day"
+ )
+ |> json_response(200)
+ |> Map.get("results")
+ end
end
test "returns 402 'upgrade required' for any other prop key", %{conn: conn, site: site} do
@@ -1261,64 +1261,66 @@ defmodule PlausibleWeb.Api.StatsController.CustomPropBreakdownTest do
]
end
- test "returns path breakdown for 404 goal", %{conn: conn, site: site} do
- insert(:goal, event_name: "404", site: site)
- site_import = insert(:site_import, site: site)
-
- populate_stats(site, site_import.id, [
- build(:event,
- name: "404",
- "meta.key": ["path"],
- "meta.value": ["/some/path/first.bin"]
- ),
- build(:imported_custom_events,
- name: "404",
- visitors: 2,
- events: 5,
- path: "/some/path/first.bin"
- ),
- build(:imported_custom_events,
- name: "404",
- visitors: 5,
- events: 10,
- path: "/some/path/second.bin"
- ),
- build(:imported_custom_events,
- name: "view_search_results",
- visitors: 100,
- events: 200
- ),
- build(:imported_visitors, visitors: 9)
- ])
+ for goal_name <- Plausible.Imported.goals_with_path() do
+ test "returns path breakdown for #{goal_name} goal", %{conn: conn, site: site} do
+ insert(:goal, event_name: unquote(goal_name), site: site)
+ site_import = insert(:site_import, site: site)
- filters =
- Jason.encode!([
- [:is, "event:goal", ["404"]]
+ populate_stats(site, site_import.id, [
+ build(:event,
+ name: unquote(goal_name),
+ "meta.key": ["path"],
+ "meta.value": ["/some/path/first.bin"]
+ ),
+ build(:imported_custom_events,
+ name: unquote(goal_name),
+ visitors: 2,
+ events: 5,
+ path: "/some/path/first.bin"
+ ),
+ build(:imported_custom_events,
+ name: unquote(goal_name),
+ visitors: 5,
+ events: 10,
+ path: "/some/path/second.bin"
+ ),
+ build(:imported_custom_events,
+ name: "view_search_results",
+ visitors: 100,
+ events: 200
+ ),
+ build(:imported_visitors, visitors: 9)
])
- conn =
- get(
- conn,
- "/api/stats/#{site.domain}/custom-prop-values/path?period=day&with_imported=true&filters=#{filters}"
- )
+ filters =
+ Jason.encode!([
+ [:is, "event:goal", [unquote(goal_name)]]
+ ])
- assert json_response(conn, 200)["results"] == [
- %{
- "visitors" => 5,
- "name" => "/some/path/second.bin",
- "events" => 10,
- "conversion_rate" => 50.0
- },
- %{
- "visitors" => 3,
- "name" => "/some/path/first.bin",
- "events" => 6,
- "conversion_rate" => 30.0
- }
- ]
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/custom-prop-values/path?period=day&with_imported=true&filters=#{filters}"
+ )
+
+ assert json_response(conn, 200)["results"] == [
+ %{
+ "visitors" => 5,
+ "name" => "/some/path/second.bin",
+ "events" => 10,
+ "conversion_rate" => 50.0
+ },
+ %{
+ "visitors" => 3,
+ "name" => "/some/path/first.bin",
+ "events" => 6,
+ "conversion_rate" => 30.0
+ }
+ ]
+ end
end
- for goal_name <- ["Outbound Link: Click", "File Download", "Cloaked Link: Click"] do
+ for goal_name <- Plausible.Imported.goals_with_url() do
test "returns url breakdown for #{goal_name} goal", %{conn: conn, site: site} do
insert(:goal, event_name: unquote(goal_name), site: site)
site_import = insert(:site_import, site: site)