Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Scroll depth: hide total conversions metric on dashboard (#5059)
Karl-Aksel Puulmanna7ff6faf0098
diff --git a/assets/js/dashboard/stats/graph/top-stats.js b/assets/js/dashboard/stats/graph/top-stats.jsindex 45b9ca3576..cbbb7d39c3 100644--- a/assets/js/dashboard/stats/graph/top-stats.js+++ b/assets/js/dashboard/stats/graph/top-stats.js@@ -188,7 +188,8 @@ export default function TopStats({ data, onMetricUpdate, tooltipBoundary }) {)}- const stats = data && data.top_stats.map(renderStat)+ const stats =+ data && data.top_stats.filter((stat) => stat.value !== null).map(renderStat)if (stats && query.period === 'realtime') {stats.push(blinkingDot())diff --git a/assets/js/dashboard/stats/reports/metric-formatter.ts b/assets/js/dashboard/stats/reports/metric-formatter.tsindex a9c5413d87..d43ae20085 100644--- a/assets/js/dashboard/stats/reports/metric-formatter.ts+++ b/assets/js/dashboard/stats/reports/metric-formatter.ts@@ -6,7 +6,8 @@ import {numberShortFormatter,durationFormatter,percentageFormatter,- numberLongFormatter+ numberLongFormatter,+ nullable} from '../../util/number-formatter'export type FormattableMetric =@@ -23,7 +24,7 @@ export const MetricFormatterShort: Record<FormattableMetric,(value: ValueType) => string> = {- events: numberShortFormatter,+ events: nullable(numberShortFormatter),pageviews: numberShortFormatter,total_visitors: numberShortFormatter,current_visitors: numberShortFormatter,@@ -51,7 +52,7 @@ export const MetricFormatterLong: Record<FormattableMetric,(value: ValueType) => string> = {- events: numberLongFormatter,+ events: nullable(numberLongFormatter),pageviews: numberLongFormatter,total_visitors: numberLongFormatter,current_visitors: numberShortFormatter,diff --git a/assets/js/dashboard/util/number-formatter.ts b/assets/js/dashboard/util/number-formatter.tsindex 9dfc4fd94a..b322b98921 100644--- a/assets/js/dashboard/util/number-formatter.ts+++ b/assets/js/dashboard/util/number-formatter.ts@@ -39,6 +39,15 @@ export function numberLongFormatter(num: number): string {return numberFormat.format(num)}+export function nullable<T>(formatter: (num: T) => string): (num: T | null) => string {+ return (num: T | null): string => {+ if (num === null) {+ return '-'+ }+ return formatter(num)+ }+}+function pad(num: number, size: number): string {return ('000' + num).slice(size * -1);}diff --git a/lib/plausible/stats/goals.ex b/lib/plausible/stats/goals.exindex 641adcf915..13660abf26 100644--- a/lib/plausible/stats/goals.ex+++ b/lib/plausible/stats/goals.ex@@ -104,6 +104,20 @@ defmodule Plausible.Stats.Goals do}end+ def toplevel_scroll_goal_filters?(query) do+ goal_filters? =+ Enum.any?(query.filters, fn+ [_, "event:goal", _] -> true+ _ -> false+ end)++ any_scroll_goals_preloaded? =+ query.preloaded_goals.matching_toplevel_filters+ |> Enum.any?(fn goal -> Plausible.Goal.type(goal) == :scroll end)++ goal_filters? and any_scroll_goals_preloaded?+ end+defp filter_preloaded(goals, filter, clause) doEnum.filter(goals, fn goal -> matches?(goal, filter, clause) end)enddiff --git a/lib/plausible/stats/query_runner.ex b/lib/plausible/stats/query_runner.exindex 99f3c60c25..6fdd7dacf9 100644--- a/lib/plausible/stats/query_runner.ex+++ b/lib/plausible/stats/query_runner.ex@@ -126,20 +126,18 @@ defmodule Plausible.Stats.QueryRunner dodefp build_from_ch(ch_results, query, time_on_page) doch_results|> Enum.map(fn entry ->- dimensions = Enum.map(query.dimensions, &dimension_label(&1, entry, query))+ dimension_labels = Enum.map(query.dimensions, &dimension_label(&1, entry, query))%{- dimensions: dimensions,- metrics: Enum.map(query.metrics, &get_metric(entry, &1, dimensions, query, time_on_page))+ dimensions: dimension_labels,+ metrics:+ Enum.map(query.metrics, &get_metric(entry, &1, dimension_labels, query, time_on_page))}end)enddefp dimension_label("event:goal", entry, query) do- goal_index = Map.get(entry, Util.shortname(query, "event:goal"))-- query.preloaded_goals.matching_toplevel_filters- |> Enum.at(goal_index - 1)+ get_dimension_goal(entry, query)|> Plausible.Goal.display_name()end@@ -165,8 +163,35 @@ defmodule Plausible.Stats.QueryRunner dodefp get_metric(_entry, :time_on_page, dimensions, _query, time_on_page),do: Map.get(time_on_page, dimensions)+ defp get_metric(entry, :events, _dimensions, query, _time_on_page) do+ cond do+ "event:goal" in query.dimensions ->+ goal = get_dimension_goal(entry, query)++ if Plausible.Goal.type(goal) != :scroll do+ Map.get(entry, :events)+ else+ nil+ end++ # Cannot show aggregate when there are at least some scroll goal filters+ Plausible.Stats.Goals.toplevel_scroll_goal_filters?(query) ->+ nil++ true ->+ Map.get(entry, :events)+ end+ end+defp get_metric(entry, metric, _dimensions, _query, _time_on_page), do: Map.get(entry, metric)+ defp get_dimension_goal(entry, query) do+ goal_index = Map.get(entry, Util.shortname(query, "event:goal"))++ query.preloaded_goals.matching_toplevel_filters+ |> Enum.at(goal_index - 1)+ end+# Special case: If comparison and single time dimension, add 0 rows - otherwise# comparisons would not be shown for timeseries with 0 values.defp add_empty_timeseries_rows(results_list, %__MODULE__{main_query: query})diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_goal_dimension_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_goal_dimension_test.exsindex 2ecac1589d..9c5ec14a4a 100644--- a/test/plausible_web/controllers/api/external_stats_controller/query_goal_dimension_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/query_goal_dimension_test.exs@@ -242,7 +242,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryGoalDimensionTest doassert json_response(conn, 200)["results"] == [%{"dimensions" => ["Visit /blog"], "metrics" => [2, 2, 100.0]},- %{"dimensions" => ["Scroll /blog 25"], "metrics" => [1, 0, 50.0]}+ %{"dimensions" => ["Scroll /blog 25"], "metrics" => [1, nil, 50.0]}]end@@ -321,10 +321,10 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryGoalDimensionTest do})assert json_response(conn, 200)["results"] == [- %{"dimensions" => ["Scroll /blog 25", "jane"], "metrics" => [2, 0, 50.0]},- %{"dimensions" => ["Scroll /blog 50", "jane"], "metrics" => [2, 0, 50.0]},- %{"dimensions" => ["Scroll /blog 25", "john"], "metrics" => [1, 0, 25.0]},- %{"dimensions" => ["Scroll /blog 75", "jane"], "metrics" => [1, 0, 25.0]}+ %{"dimensions" => ["Scroll /blog 25", "jane"], "metrics" => [2, nil, 50.0]},+ %{"dimensions" => ["Scroll /blog 50", "jane"], "metrics" => [2, nil, 50.0]},+ %{"dimensions" => ["Scroll /blog 25", "john"], "metrics" => [1, nil, 25.0]},+ %{"dimensions" => ["Scroll /blog 75", "jane"], "metrics" => [1, nil, 25.0]}]end@@ -379,7 +379,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryGoalDimensionTest do})assert json_response(conn, 200)["results"] == [- %{"dimensions" => ["Twitter"], "metrics" => [1, 0, 50.0]}+ %{"dimensions" => ["Twitter"], "metrics" => [1, nil, 50.0]}]end@@ -459,8 +459,8 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryGoalDimensionTest do})assert json_response(conn, 200)["results"] == [- %{"dimensions" => ["jane"], "metrics" => [2, 0, 50.0]},- %{"dimensions" => ["john"], "metrics" => [1, 0, 25.0]}+ %{"dimensions" => ["jane"], "metrics" => [2, nil, 50.0]},+ %{"dimensions" => ["john"], "metrics" => [1, nil, 25.0]}]end@@ -540,9 +540,60 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryGoalDimensionTest do})assert json_response(conn, 200)["results"] == [- %{"dimensions" => ["Scroll /blog 25"], "metrics" => [2, 0, 50.0]},- %{"dimensions" => ["Scroll /blog 50"], "metrics" => [2, 0, 50.0]},- %{"dimensions" => ["Scroll /blog 75"], "metrics" => [1, 0, 25.0]}+ %{"dimensions" => ["Scroll /blog 25"], "metrics" => [2, nil, 50.0]},+ %{"dimensions" => ["Scroll /blog 50"], "metrics" => [2, nil, 50.0]},+ %{"dimensions" => ["Scroll /blog 75"], "metrics" => [1, nil, 25.0]}+ ]+ end++ test "breakdown by event:goal with goal filters", %{conn: conn, site: site} do+ insert(:goal,+ site: site,+ page_path: "/blog",+ scroll_threshold: 50,+ display_name: "Scroll /blog 50"+ )++ insert(:goal, site: site, page_path: "/blog", display_name: "Visit /blog")++ populate_stats(site, [+ build(:pageview, user_id: 1, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),+ build(:engagement,+ user_id: 1,+ pathname: "/blog",+ scroll_depth: 20,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview, user_id: 2, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),+ build(:engagement,+ user_id: 2,+ pathname: "/blog",+ scroll_depth: 70,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview, user_id: 3, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),+ build(:engagement,+ user_id: 3,+ pathname: "/blog",+ scroll_depth: 50,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview, user_id: 4, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 4, pathname: "/blog", timestamp: ~N[2021-01-01 00:01:00])+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["visitors", "events", "conversion_rate"],+ "date_range" => "all",+ "filters" => [["is", "event:goal", ["Scroll /blog 50", "Visit /blog"]]],+ "dimensions" => ["event:goal"]+ })++ assert json_response(conn, 200)["results"] == [+ %{"dimensions" => ["Visit /blog"], "metrics" => [4, 5, 100.0]},+ %{"dimensions" => ["Scroll /blog 50"], "metrics" => [2, nil, 50.0]}]endenddiff --git a/test/plausible_web/controllers/api/external_stats_controller/query_imported_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_imported_test.exsindex f3e09454e9..b15c3251dc 100644--- a/test/plausible_web/controllers/api/external_stats_controller/query_imported_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/query_imported_test.exs@@ -1621,7 +1621,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryImportedTest do}} = json_response(conn, 200)- assert results == [%{"dimensions" => [], "metrics" => [1, 0, 100.0]}]+ assert results == [%{"dimensions" => [], "metrics" => [1, nil, 100.0]}]endtest "rejects imported data with warning when page scroll goal is filtered by (IN filter)", %{@@ -1671,7 +1671,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryImportedTest do}} = json_response(conn, 200)- assert results == [%{"dimensions" => [], "metrics" => [1, 1, 100.0]}]+ assert results == [%{"dimensions" => [], "metrics" => [1, nil, 100.0]}]endtest "ignores imported data for page scroll goal conversions in goal breakdown", %{@@ -1720,7 +1720,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryImportedTest doassert results == [%{"dimensions" => ["Visit /blog**"], "metrics" => [2, 2, 100.0]},- %{"dimensions" => ["Scroll /blog 50"], "metrics" => [1, 0, 50.0]}+ %{"dimensions" => ["Scroll /blog 50"], "metrics" => [1, nil, 50.0]}]endenddiff --git a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs b/test/plausible_web/controllers/api/stats_controller/conversions_test.exsindex 48cc3059f0..afb2003589 100644--- a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/conversions_test.exs@@ -133,13 +133,13 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do%{"name" => "Scroll 50 /blog/**","visitors" => 2,- "events" => 0,+ "events" => nil,"conversion_rate" => 100.0},%{"name" => "Scroll 75 /blog/posts/1","visitors" => 1,- "events" => 0,+ "events" => nil,"conversion_rate" => 50.0}]diff --git a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exsindex 46c251daf8..43c3c97c3c 100644--- a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs@@ -1800,7 +1800,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest doassert [unique_conversions, total_conversions, conversion_rate] = top_statsassert %{"name" => "Unique conversions", "value" => 1} = unique_conversions- assert %{"name" => "Total conversions", "value" => 0} = total_conversions+ assert %{"name" => "Total conversions", "value" => nil} = total_conversionsassert %{"name" => "Conversion rate", "value" => 50.0} = conversion_rateend@@ -1847,7 +1847,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest doassert [unique_conversions, total_conversions, conversion_rate] = top_statsassert %{"name" => "Unique conversions", "value" => 3} = unique_conversions- assert %{"name" => "Total conversions", "value" => 2} = total_conversions+ assert %{"name" => "Total conversions", "value" => nil} = total_conversionsassert %{"name" => "Conversion rate", "value" => 60.0} = conversion_rateend@@ -1886,7 +1886,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest doassert [unique_conversions, total_conversions, conversion_rate] = top_statsassert %{"name" => "Unique conversions", "value" => 2} = unique_conversions- assert %{"name" => "Total conversions", "value" => 2} = total_conversions+ assert %{"name" => "Total conversions", "value" => nil} = total_conversionsassert %{"name" => "Conversion rate", "value" => 66.7} = conversion_rateendend