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
Sort by exit rate (#5289)
RobertJoonas4eb4b68b99d4
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 4f77a272a0..a6497c8da5 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.## Unreleased### Added+- Ability to sort by and compare the `exit_rate` metric in the dashboard Exit Pages > Details report- Add top 3 pages into the traffic spike email- Two new shorthand time periods `28d` and `90d` available on both dashboard and in public API- Average scroll depth metric@@ -32,6 +33,7 @@ All notable changes to this project will be documented in this file.### Changed+- Increase decimal precision of the "Exit rate" metric from 0 to 1 (e.g. 67 -> 66.7)- Increase decimal precision of the "Conversion rate" metric from 1 to 2 (e.g. 16.7 -> 16.67)- The "Last 30 days" period is now "Last 28 days" on the dashboard and also the new default. Keyboard shortcut `T` still works for last 30 days.- Last `7d` and `30d` periods do not include today anymorediff --git a/assets/js/dashboard/stats/reports/metrics.js b/assets/js/dashboard/stats/reports/metrics.jsindex 1c3f414f41..38554065c3 100644--- a/assets/js/dashboard/stats/reports/metrics.js+++ b/assets/js/dashboard/stats/reports/metrics.js@@ -207,7 +207,7 @@ export const createExitRate = (props) => {...props,key: 'exit_rate',renderLabel,- sortable: false+ sortable: true})}diff --git a/assets/js/types/query-api.d.ts b/assets/js/types/query-api.d.tsindex 478a78bbcb..d9bf0ee646 100644--- a/assets/js/types/query-api.d.ts+++ b/assets/js/types/query-api.d.ts@@ -12,6 +12,7 @@ export type Metric =| "conversion_rate"| "group_conversion_rate"| "time_on_page"+ | "exit_rate"| "total_revenue"| "average_revenue"| "scroll_depth";diff --git a/lib/plausible/stats/compare.ex b/lib/plausible/stats/compare.exindex 7acb81985a..e492b5deb0 100644--- a/lib/plausible/stats/compare.ex+++ b/lib/plausible/stats/compare.ex@@ -3,6 +3,12 @@ defmodule Plausible.Stats.Compare doFloat.round(new_value - old_value, 1)end+ def calculate_change(:exit_rate, old_value, new_value) do+ if is_float(old_value) and is_float(new_value) do+ Float.round(new_value - old_value, 1)+ end+ end+def calculate_change(:bounce_rate, old_count, new_count) doif old_count > 0, do: new_count - old_countenddiff --git a/lib/plausible/stats/filters/query_parser.ex b/lib/plausible/stats/filters/query_parser.exindex 73188ea8bb..d499ff3feb 100644--- a/lib/plausible/stats/filters/query_parser.ex+++ b/lib/plausible/stats/filters/query_parser.ex@@ -629,6 +629,20 @@ defmodule Plausible.Stats.Filters.QueryParser doendend+ defp validate_metric(:exit_rate = metric, query) do+ case {query.dimensions, TableDecider.sessions_join_events?(query)} do+ {["visit:exit_page"], false} ->+ :ok++ {["visit:exit_page"], true} ->+ {:error, "Metric `#{metric}` cannot be queried when filtering on event dimensions."}++ _ ->+ {:error,+ "Metric `#{metric}` requires a `\"visit:exit_page\"` dimension. No other dimensions are allowed."}+ end+ end+defp validate_metric(:views_per_visit = metric, query) docond doFilters.filtering_on_dimension?(query, "event:page", behavioral_filters: :ignore) ->diff --git a/lib/plausible/stats/imported/imported.ex b/lib/plausible/stats/imported/imported.exindex 6948879252..9c76c32aa6 100644--- a/lib/plausible/stats/imported/imported.ex+++ b/lib/plausible/stats/imported/imported.ex@@ -357,6 +357,7 @@ defmodule Plausible.Stats.Imported doend@cannot_optimize_metrics [+ :exit_rate,:scroll_depth,:percentage,:conversion_rate,diff --git a/lib/plausible/stats/imported/sql/expression.ex b/lib/plausible/stats/imported/sql/expression.exindex b9719677dc..1c1f27280f 100644--- a/lib/plausible/stats/imported/sql/expression.ex+++ b/lib/plausible/stats/imported/sql/expression.ex@@ -87,6 +87,10 @@ defmodule Plausible.Stats.Imported.SQL.Expression dowrap_alias([i], %{bounces: sum(i.bounces), __internal_visits: sum(i.visits)})end+ defp select_metric(:exit_rate, "imported_exit_pages", _query) do+ wrap_alias([i], %{__internal_visits: sum(i.exits)})+ end+defp select_metric(:visit_duration, "imported_pages", _query) dowrap_alias([i], %{visit_duration: 0})end@@ -398,6 +402,12 @@ defmodule Plausible.Stats.Imported.SQL.Expression do|> Map.merge(time_on_page_metric(query))end+ defp joined_metric(:exit_rate, _query) do+ wrap_alias([s, i], %{+ __internal_visits: s.__internal_visits + i.__internal_visits+ })+ end+# Ignored as it's calculated separatelydefp joined_metric(metric, _query)when metric in [:conversion_rate, :group_conversion_rate, :percentage] dodiff --git a/lib/plausible/stats/metrics.ex b/lib/plausible/stats/metrics.exindex e9d250283c..c4673ae738 100644--- a/lib/plausible/stats/metrics.ex+++ b/lib/plausible/stats/metrics.ex@@ -11,6 +11,7 @@ defmodule Plausible.Stats.Metrics do:visitors,:visits,:pageviews,+ :exit_rate,:views_per_visit,:bounce_rate,:visit_duration,@@ -33,6 +34,7 @@ defmodule Plausible.Stats.Metrics doenddef default_value(:visit_duration, _query, _dimensions), do: nil+ def default_value(:exit_rate, _query, _dimensions), do: nildef default_value(:scroll_depth, _query, _dimensions), do: nildef default_value(:time_on_page, _query, _dimensions), do: nildiff --git a/lib/plausible/stats/sql/expression.ex b/lib/plausible/stats/sql/expression.exindex 3de6cc86b1..5f03022c4d 100644--- a/lib/plausible/stats/sql/expression.ex+++ b/lib/plausible/stats/sql/expression.ex@@ -332,6 +332,12 @@ defmodule Plausible.Stats.SQL.Expression do})end+ def session_metric(:exit_rate, _query) do+ wrap_alias([s], %{+ __internal_visits: fragment("toUInt32(sum(sign))")+ })+ end+def session_metric(:visits, _query) dowrap_alias([s], %{visits: scale_sample(fragment("sum(?)", s.sign))diff --git a/lib/plausible/stats/sql/special_metrics.ex b/lib/plausible/stats/sql/special_metrics.exindex 973c81694b..929037ec83 100644--- a/lib/plausible/stats/sql/special_metrics.ex+++ b/lib/plausible/stats/sql/special_metrics.ex@@ -11,74 +11,76 @@ defmodule Plausible.Stats.SQL.SpecialMetrics doimport Ecto.Queryimport Plausible.Stats.Util+ @special_metrics [+ :percentage,+ :conversion_rate,+ :group_conversion_rate,+ :scroll_depth,+ :exit_rate+ ]+def add(q, site, query) do- q- |> maybe_add_percentage_metric(site, query)- |> maybe_add_global_conversion_rate(site, query)- |> maybe_add_group_conversion_rate(site, query)- |> maybe_add_scroll_depth(query)+ Enum.reduce(@special_metrics, q, fn special_metric, q ->+ if special_metric in query.metrics do+ add_special_metric(q, special_metric, site, query)+ else+ q+ end+ end)end- defp maybe_add_percentage_metric(q, site, query) do- if :percentage in query.metrics do- total_query =- query- |> remove_filters_ignored_in_totals_query()- |> Query.set(- dimensions: [],- include_imported: query.include_imported,- pagination: nil- )+ defp add_special_metric(q, :percentage, site, query) do+ total_query =+ query+ |> remove_filters_ignored_in_totals_query()+ |> Query.set(+ dimensions: [],+ include_imported: query.include_imported,+ pagination: nil+ )- q- |> select_merge_as([], total_visitors_subquery(site, total_query, query.include_imported))- |> select_merge_as([], %{- percentage:- fragment(- "if(? > 0, round(? / ? * 100, 1), null)",- selected_as(:total_visitors),- selected_as(:visitors),- selected_as(:total_visitors)- )- })- else- q- end+ q+ |> select_merge_as([], total_visitors_subquery(site, total_query, query.include_imported))+ |> select_merge_as([], %{+ percentage:+ fragment(+ "if(? > 0, round(? / ? * 100, 1), null)",+ selected_as(:total_visitors),+ selected_as(:visitors),+ selected_as(:total_visitors)+ )+ })end# Adds conversion_rate metric to query, calculated as# X / Y where Y is the same breakdown value without goal or props# filters.- def maybe_add_global_conversion_rate(q, site, query) do- if :conversion_rate in query.metrics do- total_query =- query- |> Query.remove_top_level_filters(["event:goal", "event:props"])- |> remove_filters_ignored_in_totals_query()- |> Query.set(- dimensions: [],- include_imported: query.include_imported,- preloaded_goals: Map.put(query.preloaded_goals, :matching_toplevel_filters, []),- pagination: nil- )-- q- |> select_merge_as(- [],- total_visitors_subquery(site, total_query, query.include_imported)+ defp add_special_metric(q, :conversion_rate, site, query) do+ total_query =+ query+ |> Query.remove_top_level_filters(["event:goal", "event:props"])+ |> remove_filters_ignored_in_totals_query()+ |> Query.set(+ dimensions: [],+ include_imported: query.include_imported,+ preloaded_goals: Map.put(query.preloaded_goals, :matching_toplevel_filters, []),+ pagination: nil)- |> select_merge_as([e], %{- conversion_rate:- fragment(- "if(? > 0, round(? / ? * 100, 2), 0)",- selected_as(:total_visitors),- selected_as(:visitors),- selected_as(:total_visitors)- )- })- else- q- end++ q+ |> select_merge_as(+ [],+ total_visitors_subquery(site, total_query, query.include_imported)+ )+ |> select_merge_as([e], %{+ conversion_rate:+ fragment(+ "if(? > 0, round(? / ? * 100, 2), 0)",+ selected_as(:total_visitors),+ selected_as(:visitors),+ selected_as(:total_visitors)+ )+ })end# This function injects a group_conversion_rate metric into@@ -92,118 +94,159 @@ defmodule Plausible.Stats.SQL.SpecialMetrics do# * Y is the number of all visitors for this set of dimensions# result without the `event:goal` and `event:props:*`# filters.- def maybe_add_group_conversion_rate(q, site, query) do- if :group_conversion_rate in query.metrics do- group_totals_query =- query- |> Query.remove_top_level_filters(["event:goal", "event:props"])- |> remove_filters_ignored_in_totals_query()- |> Query.set(- metrics: [:visitors],- order_by: [],- include_imported: query.include_imported,- preloaded_goals: Map.put(query.preloaded_goals, :matching_toplevel_filters, []),- pagination: nil+ defp add_special_metric(q, :group_conversion_rate, site, query) do+ group_totals_query =+ query+ |> Query.remove_top_level_filters(["event:goal", "event:props"])+ |> remove_filters_ignored_in_totals_query()+ |> Query.set(+ metrics: [:visitors],+ order_by: [],+ include_imported: query.include_imported,+ preloaded_goals: Map.put(query.preloaded_goals, :matching_toplevel_filters, []),+ pagination: nil+ )++ from(e in subquery(q),+ left_join: c in subquery(SQL.QueryBuilder.build(group_totals_query, site)),+ on: ^SQL.QueryBuilder.build_group_by_join(query)+ )+ |> select_merge_as([e, c], %{+ total_visitors: c.visitors,+ group_conversion_rate:+ fragment(+ "if(? > 0, round(? / ? * 100, 2), 0)",+ c.visitors,+ e.visitors,+ c.visitors)+ })+ |> select_join_fields(query, query.dimensions, e)+ |> select_join_fields(query, List.delete(query.metrics, :group_conversion_rate), e)+ end- from(e in subquery(q),- left_join: c in subquery(SQL.QueryBuilder.build(group_totals_query, site)),- on: ^SQL.QueryBuilder.build_group_by_join(query)- )- |> select_merge_as([e, c], %{- total_visitors: c.visitors,- group_conversion_rate:+ defp add_special_metric(q, :scroll_depth, _site, query) do+ max_per_session_q =+ Base.base_event_query(query)+ |> where([e], e.name == "engagement" and e.scroll_depth <= 100)+ |> select([e], %{+ session_id: e.session_id,+ max_scroll_depth: max(e.scroll_depth)+ })+ |> SQL.QueryBuilder.build_group_by(:events, query)+ |> group_by([e], e.session_id)++ dim_shortnames = Enum.map(query.dimensions, fn dim -> shortname(query, dim) end)++ dim_select =+ dim_shortnames+ |> Enum.map(fn dim -> {dim, dynamic([p], field(p, ^dim))} end)+ |> Map.new()++ dim_group_by =+ dim_shortnames+ |> Enum.map(fn dim -> dynamic([p], field(p, ^dim)) end)++ total_scroll_depth_q =+ subquery(max_per_session_q)+ |> select([], %{})+ |> select_merge_as([p], %{+ # Note: No need to upscale sample size here since it would end up cancelling out due to the result being an average+ total_scroll_depth: fragment("sum(?)", p.max_scroll_depth),+ total_scroll_depth_visits: fragment("uniq(?)", p.session_id)+ })+ |> select_merge(^dim_select)+ |> group_by(^dim_group_by)++ join_on_dim_condition =+ if dim_shortnames == [] do+ true+ else+ dim_shortnames+ |> Enum.map(fn dim -> dynamic([_e, ..., s], selected_as(^dim) == field(s, ^dim)) end)+ # credo:disable-for-next-line Credo.Check.Refactor.Nesting+ |> Enum.reduce(fn condition, acc -> dynamic([], ^acc and ^condition) end)+ end++ joined_q =+ join(q, :left, [e], s in subquery(total_scroll_depth_q), on: ^join_on_dim_condition)++ if query.include_imported do+ joined_q+ |> select_merge_as([..., s], %{+ scroll_depth:fragment(- "if(? > 0, round(? / ? * 100, 2), 0)",- c.visitors,- e.visitors,- c.visitors+ """+ if(? + ? > 0, toInt8(round((? + ?) / (? + ?))), NULL)+ """,+ s.total_scroll_depth_visits,+ selected_as(:__imported_total_scroll_depth_visits),+ s.total_scroll_depth,+ selected_as(:__imported_total_scroll_depth),+ s.total_scroll_depth_visits,+ selected_as(:__imported_total_scroll_depth_visits))})- |> select_join_fields(query, query.dimensions, e)- |> select_join_fields(query, List.delete(query.metrics, :group_conversion_rate), e)else- q+ joined_q+ |> select_merge_as([..., s], %{+ scroll_depth:+ fragment(+ "if(any(?) > 0, toUInt8(round(any(?) / any(?))), NULL)",+ s.total_scroll_depth_visits,+ s.total_scroll_depth,+ s.total_scroll_depth_visits+ )+ })endend- def maybe_add_scroll_depth(q, query) do- if :scroll_depth in query.metrics do- max_per_session_q =- Base.base_event_query(query)- |> where([e], e.name == "engagement" and e.scroll_depth <= 100)- |> select([e], %{- session_id: e.session_id,- max_scroll_depth: max(e.scroll_depth)- })- |> SQL.QueryBuilder.build_group_by(:events, query)- |> group_by([e], e.session_id)-- dim_shortnames = Enum.map(query.dimensions, fn dim -> shortname(query, dim) end)-- dim_select =- dim_shortnames- |> Enum.map(fn dim -> {dim, dynamic([p], field(p, ^dim))} end)- |> Map.new()+ # Selects exit_rate into the query, calculated as X / Y, where X is the+ # total number of exits from a page (i.e. the number of sessions with a+ # specific exit page), and Y is the total pageviews on that page.+ defp add_special_metric(q, :exit_rate, site, query) do+ total_pageviews_query =+ query+ |> Query.remove_top_level_filters(["visit:exit_page"])+ |> remove_filters_ignored_in_totals_query()+ |> Query.set(+ pagination: nil,+ order_by: [],+ metrics: [:pageviews],+ include_imported: query.include_imported,+ dimensions: ["event:page"]+ )- dim_group_by =- dim_shortnames- |> Enum.map(fn dim -> dynamic([p], field(p, ^dim)) end)-- total_scroll_depth_q =- subquery(max_per_session_q)- |> select([], %{})- |> select_merge_as([p], %{- # Note: No need to upscale sample size here since it would end up cancelling out due to the result being an average- total_scroll_depth: fragment("sum(?)", p.max_scroll_depth),- total_scroll_depth_visits: fragment("uniq(?)", p.session_id)- })- |> select_merge(^dim_select)- |> group_by(^dim_group_by)-- join_on_dim_condition =- if dim_shortnames == [] do- true- else- dim_shortnames- |> Enum.map(fn dim -> dynamic([_e, ..., s], selected_as(^dim) == field(s, ^dim)) end)- # credo:disable-for-next-line Credo.Check.Refactor.Nesting- |> Enum.reduce(fn condition, acc -> dynamic([], ^acc and ^condition) end)- end-- joined_q =- join(q, :left, [e], s in subquery(total_scroll_depth_q), on: ^join_on_dim_condition)-- if query.include_imported do- joined_q- |> select_merge_as([..., s], %{- scroll_depth:- fragment(- """- if(? + ? > 0, toInt8(round((? + ?) / (? + ?))), NULL)- """,- s.total_scroll_depth_visits,- selected_as(:__imported_total_scroll_depth_visits),- s.total_scroll_depth,- selected_as(:__imported_total_scroll_depth),- s.total_scroll_depth_visits,- selected_as(:__imported_total_scroll_depth_visits)- )- })- else- joined_q- |> select_merge_as([..., s], %{- scroll_depth:- fragment(- "if(any(?) > 0, toUInt8(round(any(?) / any(?))), NULL)",- s.total_scroll_depth_visits,- s.total_scroll_depth,- s.total_scroll_depth_visits- )- })- end- else+ joined_q =q+ |> join(:left, [], p in subquery(SQL.QueryBuilder.build(total_pageviews_query, site)),+ on:+ selected_as(^shortname(query, "visit:exit_page")) ==+ field(p, ^shortname(total_pageviews_query, "event:page"))+ )++ if query.include_imported do+ joined_q+ |> select_merge_as([..., p], %{+ exit_rate:+ fragment(+ "if(? > 0, round(? / ? * 100, 1), NULL)",+ p.pageviews,+ selected_as(:__internal_visits),+ p.pageviews+ )+ })+ else+ joined_q+ |> select_merge_as([..., p], %{+ exit_rate:+ fragment(+ "if(? > 0, round(? / ? * 100, 1), NULL)",+ fragment("any(?)", p.pageviews),+ selected_as(:__internal_visits),+ fragment("any(?)", p.pageviews)+ )+ })endenddiff --git a/lib/plausible/stats/table_decider.ex b/lib/plausible/stats/table_decider.exindex 2873493c1b..8613c83aab 100644--- a/lib/plausible/stats/table_decider.ex+++ b/lib/plausible/stats/table_decider.ex@@ -149,6 +149,7 @@ defmodule Plausible.Stats.TableDecider dodefp metric_partitioner(_, :time_on_page), do: :eventdefp metric_partitioner(_, :visit_duration), do: :sessiondefp metric_partitioner(_, :views_per_visit), do: :session+ defp metric_partitioner(_, :exit_rate), do: :session# Calculated metrics - handled on callsite separately from other metrics.defp metric_partitioner(_, :total_visitors), do: :otherdiff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.exindex 387fd8f860..8d592a11c3 100644--- a/lib/plausible_web/controllers/api/stats_controller.ex+++ b/lib/plausible_web/controllers/api/stats_controller.ex@@ -933,13 +933,20 @@ defmodule PlausibleWeb.Api.StatsController doparams = Map.put(params, "property", "visit:exit_page")query = Query.from(site, params, debug_metadata(conn)){limit, page} = parse_pagination(params)- metrics = breakdown_metrics(query, [:visits])++ extra_metrics =+ if TableDecider.sessions_join_events?(query) do+ [:visits]+ else+ [:visits, :exit_rate]+ end++ metrics = breakdown_metrics(query, extra_metrics)%{results: results, meta: meta} = Stats.breakdown(site, query, metrics, {limit, page})exit_pages =results- |> add_exit_rate(site, query, limit)|> transform_keys(%{exit_page: :name})if params["csv"] do@@ -966,37 +973,6 @@ defmodule PlausibleWeb.Api.StatsController doendend- defp add_exit_rate(breakdown_results, site, query, limit) do- if TableDecider.sessions_join_events?(query) do- breakdown_results- else- pages = Enum.map(breakdown_results, & &1[:exit_page])-- total_pageviews_query =- query- |> struct!(order_by: [])- |> Query.remove_top_level_filters(["visit:exit_page"])- |> Query.add_filter([:is, "event:page", pages])- |> Query.set(dimensions: ["event:page"])-- %{results: total_pageviews} =- Stats.breakdown(site, total_pageviews_query, [:pageviews], {limit, 1})-- Enum.map(breakdown_results, fn result ->- exit_rate =- case Enum.find(total_pageviews, &(&1[:page] == result[:exit_page])) do- %{pageviews: pageviews} ->- Float.floor(result[:visits] / pageviews * 100)-- nil ->- nil- end-- Map.put(result, :exit_rate, exit_rate)- end)- end- end-def countries(conn, params) dosite = conn.assigns[:site]params = Map.put(params, "property", "visit:country")diff --git a/priv/json-schemas/query-api-schema.json b/priv/json-schemas/query-api-schema.jsonindex bdc36559d6..a9601a7f63 100644--- a/priv/json-schemas/query-api-schema.json+++ b/priv/json-schemas/query-api-schema.json@@ -268,6 +268,10 @@"const": "time_on_page","markdownDescription": "Average time spent on a given page in a visit in seconds. Requires: `event:page` filter or dimension."},+ {+ "const": "exit_rate",+ "$comment": "only :internal"+ },{"const": "total_revenue","markdownDescription": "Total revenue",diff --git a/test/plausible/stats/query_parser_test.exs b/test/plausible/stats/query_parser_test.exsindex a084a6752b..8c3f9affed 100644--- a/test/plausible/stats/query_parser_test.exs+++ b/test/plausible/stats/query_parser_test.exs@@ -1785,6 +1785,73 @@ defmodule Plausible.Stats.Filters.QueryParserTest doendend+ describe "exit_rate metric" do+ test "fails validation without visit:exit_page dimension", %{site: site} do+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "date_range" => "all"+ }+ |> check_error(+ site,+ "Metric `exit_rate` requires a `\"visit:exit_page\"` dimension. No other dimensions are allowed.",+ :internal+ )+ end++ test "fails validation with event only filters", %{site: site} do+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "dimensions" => ["visit:exit_page"],+ "filters" => [["is", "event:page", ["/"]]],+ "date_range" => "all"+ }+ |> check_error(+ site,+ "Metric `exit_rate` cannot be queried when filtering on event dimensions.",+ :internal+ )+ end++ test "fails validation with event metrics", %{site: site} do+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate", "pageviews"],+ "dimensions" => ["visit:exit_page"],+ "date_range" => "all"+ }+ |> check_error(+ site,+ "Event metric(s) `pageviews` cannot be queried along with session dimension(s) `visit:exit_page`",+ :internal+ )+ end++ test "passes validation", %{site: site} do+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "dimensions" => ["visit:exit_page"],+ "date_range" => "all"+ }+ |> check_success(+ site,+ %{+ metrics: [:exit_rate],+ utc_time_range: @date_range_day,+ filters: [],+ dimensions: ["visit:exit_page"],+ order_by: nil,+ timezone: site.timezone,+ include: @default_include,+ pagination: %{limit: 10_000, offset: 0}+ },+ :internal+ )+ end+ end+describe "scroll_depth metric" dotest "fails validation on its own", %{site: site} do%{diff --git a/test/plausible_web/controllers/CSVs/30d/exit_pages.csv b/test/plausible_web/controllers/CSVs/30d/exit_pages.csvindex 036337efed..9de24dc69b 100644--- a/test/plausible_web/controllers/CSVs/30d/exit_pages.csv+++ b/test/plausible_web/controllers/CSVs/30d/exit_pages.csv@@ -1,4 +1,4 @@name,unique_exits,total_exits,exit_rate-/,2,2,66.0+/,2,2,66.7/signup,1,1,100.0/some-other-page,1,1,100.0diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_special_metrics_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_special_metrics_test.exsindex 1b69d1a4a8..9d755becbd 100644--- a/test/plausible_web/controllers/api/external_stats_controller/query_special_metrics_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/query_special_metrics_test.exs@@ -216,4 +216,288 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QuerySpecialMetricsTest do%{"dimensions" => ["Mobile"], "metrics" => [25.0]}]end++ describe "exit_rate" do+ test "in visit:exit_page breakdown without filters", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, user_id: 1, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 1, pathname: "/two", timestamp: ~N[2021-01-01 00:10:00]),+ build(:pageview, user_id: 3, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 3, pathname: "/never-exit", timestamp: ~N[2021-01-01 00:00:00]),+ build(:event, user_id: 3, name: "a", pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 3, pathname: "/one", timestamp: ~N[2021-01-01 00:10:00])+ ])++ conn =+ post(+ conn,+ "/api/v2/query-internal-test",+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "date_range" => "all",+ "dimensions" => ["visit:exit_page"],+ "order_by" => [["exit_rate", "desc"]]+ }+ )++ %{"results" => results} = json_response(conn, 200)++ assert results == [+ %{"dimensions" => ["/two"], "metrics" => [100]},+ %{"dimensions" => ["/one"], "metrics" => [33.3]}+ ]+ end++ test "in visit:exit_page breakdown filtered by visit:exit_page", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 1, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 1, pathname: "/two", timestamp: ~N[2021-01-01 00:10:00])+ ])++ conn =+ post(+ conn,+ "/api/v2/query-internal-test",+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "date_range" => "all",+ "dimensions" => ["visit:exit_page"],+ "filters" => [["is", "visit:exit_page", ["/one"]]]+ }+ )++ %{"results" => results} = json_response(conn, 200)++ assert results == [+ %{"dimensions" => ["/one"], "metrics" => [66.7]}+ ]+ end++ test "in visit:exit_page breakdown filtered by visit:exit_page and visit:entry_page", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ # Bounced sessions: Match both entry- and exit page filters+ build(:pageview, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ # Session 1: Matches both entry- and exit page filters+ build(:pageview, user_id: 1, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 1, pathname: "/two", timestamp: ~N[2021-01-01 00:10:00]),+ build(:pageview, user_id: 1, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ # Session 2: Does not match exit_page filter, BUT the pageview on /one still+ # gets counted towards total pageviews.+ build(:pageview, user_id: 2, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 2, pathname: "/two", timestamp: ~N[2021-01-01 00:10:00]),+ # Session 3: Does not match entry_page filter, should be ignored+ build(:pageview, user_id: 3, pathname: "/two", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 3, pathname: "/one", timestamp: ~N[2021-01-01 00:20:00])+ ])++ conn =+ post(+ conn,+ "/api/v2/query-internal-test",+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "date_range" => "all",+ "dimensions" => ["visit:exit_page"],+ "filters" => [+ ["is", "visit:exit_page", ["/one"]],+ ["is", "visit:entry_page", ["/one"]]+ ]+ }+ )++ %{"results" => results} = json_response(conn, 200)++ assert results == [+ %{"dimensions" => ["/one"], "metrics" => [60]}+ ]+ end++ test "in visit:exit_page breakdown filtered by visit:country", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, pathname: "/one", country_code: "EE", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, pathname: "/one", country_code: "US", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview,+ user_id: 1,+ pathname: "/one",+ country_code: "EE",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: 1,+ pathname: "/two",+ country_code: "EE",+ timestamp: ~N[2021-01-01 00:10:00]+ )+ ])++ conn =+ post(+ conn,+ "/api/v2/query-internal-test",+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "date_range" => "all",+ "filters" => [["is", "visit:country", ["EE"]]],+ "dimensions" => ["visit:exit_page"],+ "order_by" => [["exit_rate", "asc"]]+ }+ )++ %{"results" => results} = json_response(conn, 200)++ assert results == [+ %{"dimensions" => ["/one"], "metrics" => [50]},+ %{"dimensions" => ["/two"], "metrics" => [100.0]}+ ]+ end++ test "sorting and pagination", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 2, pathname: "/two", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 2, pathname: "/two", timestamp: ~N[2021-01-01 00:01:00]),+ build(:pageview, user_id: 3, pathname: "/three", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 3, pathname: "/three", timestamp: ~N[2021-01-01 00:01:00]),+ build(:pageview, user_id: 3, pathname: "/three", timestamp: ~N[2021-01-01 00:02:00]),+ build(:pageview, user_id: 4, pathname: "/four", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 4, pathname: "/four", timestamp: ~N[2021-01-01 00:01:00]),+ build(:pageview, user_id: 4, pathname: "/four", timestamp: ~N[2021-01-01 00:02:00]),+ build(:pageview, user_id: 4, pathname: "/four", timestamp: ~N[2021-01-01 00:03:00])+ ])++ do_query = fn order_by, pagination ->+ conn+ |> post("/api/v2/query-internal-test", %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "date_range" => "all",+ "dimensions" => ["visit:exit_page"],+ "order_by" => order_by,+ "pagination" => pagination+ })+ |> json_response(200)+ |> Map.get("results")+ end++ all_results_asc = do_query.([["exit_rate", "asc"]], %{"limit" => 4})+ all_results_desc = do_query.([["exit_rate", "desc"]], %{"limit" => 4})++ assert all_results_asc == Enum.reverse(all_results_desc)++ assert do_query.([["exit_rate", "desc"]], %{"limit" => 2, "offset" => 0}) == [+ %{"dimensions" => ["/one"], "metrics" => [100]},+ %{"dimensions" => ["/two"], "metrics" => [50]}+ ]++ assert do_query.([["exit_rate", "desc"]], %{"limit" => 2, "offset" => 2}) == [+ %{"dimensions" => ["/three"], "metrics" => [33.3]},+ %{"dimensions" => ["/four"], "metrics" => [25]}+ ]++ assert do_query.([["exit_rate", "asc"]], %{"limit" => 3, "offset" => 1}) == [+ %{"dimensions" => ["/three"], "metrics" => [33.3]},+ %{"dimensions" => ["/two"], "metrics" => [50]},+ %{"dimensions" => ["/one"], "metrics" => [100]}+ ]+ end++ test "with comparisons", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, user_id: 1, pathname: "/one", timestamp: ~N[2021-01-09 00:00:00]),+ build(:pageview, user_id: 1, pathname: "/three", timestamp: ~N[2021-01-09 00:00:00]),+ build(:pageview, pathname: "/one", timestamp: ~N[2021-01-09 00:10:00]),+ build(:pageview, user_id: 2, pathname: "/one", timestamp: ~N[2021-01-10 00:00:00]),+ build(:pageview, user_id: 2, pathname: "/two", timestamp: ~N[2021-01-10 00:10:00]),+ build(:pageview, user_id: 3, pathname: "/one", timestamp: ~N[2021-01-10 00:00:00]),+ build(:pageview, user_id: 3, pathname: "/one", timestamp: ~N[2021-01-10 00:10:00])+ ])++ conn =+ post(+ conn,+ "/api/v2/query-internal-test",+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "date_range" => ["2021-01-10", "2021-01-10"],+ "dimensions" => ["visit:exit_page"],+ "include" => %{"comparisons" => %{"mode" => "previous_period"}},+ "order_by" => [["exit_rate", "desc"]]+ }+ )++ %{"results" => results} = json_response(conn, 200)++ assert results == [+ %{+ "dimensions" => ["/two"],+ "metrics" => [100],+ "comparison" => %{+ "change" => [nil],+ "dimensions" => ["/two"],+ "metrics" => [nil]+ }+ },+ %{+ "dimensions" => ["/one"],+ "metrics" => [33.3],+ "comparison" => %{+ "change" => [-16.7],+ "dimensions" => ["/one"],+ "metrics" => [50]+ }+ }+ ]+ end++ test "with imported data", %{conn: conn, site: site} do+ site_import =+ insert(:site_import,+ site: site,+ start_date: ~D[2020-01-01],+ end_date: ~D[2020-12-31]+ )++ populate_stats(site, site_import.id, [+ build(:pageview, user_id: 1, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 1, pathname: "/two", timestamp: ~N[2021-01-01 00:10:00]),+ build(:pageview, user_id: 3, pathname: "/one", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 3, pathname: "/three", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, user_id: 3, pathname: "/one", timestamp: ~N[2021-01-01 00:10:00]),+ build(:imported_pages, page: "/one", visits: 10, pageviews: 20, date: ~D[2020-01-01]),+ build(:imported_exit_pages, exit_page: "/one", exits: 2, date: ~D[2020-01-01])+ ])++ conn =+ post(+ conn,+ "/api/v2/query-internal-test",+ %{+ "site_id" => site.domain,+ "metrics" => ["exit_rate"],+ "date_range" => "all",+ "include" => %{"imports" => true},+ "dimensions" => ["visit:exit_page"],+ "order_by" => [["exit_rate", "desc"]]+ }+ )++ %{"results" => results} = json_response(conn, 200)++ assert results == [+ %{"dimensions" => ["/two"], "metrics" => [100]},+ %{"dimensions" => ["/one"], "metrics" => [13]}+ ]+ end+ endenddiff --git a/test/plausible_web/controllers/api/stats_controller/pages_test.exs b/test/plausible_web/controllers/api/stats_controller/pages_test.exsindex 37805866b6..559036ccd0 100644--- a/test/plausible_web/controllers/api/stats_controller/pages_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/pages_test.exs@@ -2580,7 +2580,7 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest doconn = get(conn, "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01")assert json_response(conn, 200)["results"] == [- %{"name" => "/page1", "visitors" => 2, "visits" => 2, "exit_rate" => 66},+ %{"name" => "/page1", "visitors" => 2, "visits" => 2, "exit_rate" => 66.7},%{"name" => "/page2", "visitors" => 1, "visits" => 1, "exit_rate" => 100}]end@@ -2615,7 +2615,7 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest doassert json_response(conn, 200)["results"] == [%{"name" => "/page2", "visitors" => 1, "visits" => 1, "exit_rate" => 100},- %{"name" => "/page1", "visitors" => 2, "visits" => 2, "exit_rate" => 66}+ %{"name" => "/page1", "visitors" => 2, "visits" => 2, "exit_rate" => 66.7}]end@@ -2744,7 +2744,7 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest doconn1 = get(conn, "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01")assert json_response(conn1, 200)["results"] == [- %{"name" => "/page1", "visitors" => 2, "visits" => 2, "exit_rate" => 66},+ %{"name" => "/page1", "visitors" => 2, "visits" => 2, "exit_rate" => 66.7},%{"name" => "/page2", "visitors" => 1, "visits" => 1, "exit_rate" => 100}]@@ -2761,7 +2761,7 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do"visits" => 4,"exit_rate" => 80.0},- %{"name" => "/page1", "visitors" => 2, "visits" => 2, "exit_rate" => 66}+ %{"name" => "/page1", "visitors" => 2, "visits" => 2, "exit_rate" => 66.7}]end