Allow revenue metrics to be queried with session dimensions (#6211)

ukutaht · web-flow · commit 7b18ffcab440 · 2026-03-31T16:14:21.000Z
* Allow revenue metrics to be queried with session dimensions

* Remove superfluous test cases

* Add changelog entry

* Run revenue tests in EE only

* Naming
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,9 +6,10 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+- Allow querying revenue metrics (`total_revenue`, `average_revenue`) with visit dimensions in Stats API v2
 - Allow querying `views_per_visit` with a time dimension in Stats API
 - Add `bounce_rate` to page-filtered Top Stats even when imports are included, but render a metric warning about imported data not included in `bounce_rate` tooltip.
-- Add `time_on_page` to page-filtered Top Stats even when imports are included, unless legacy time on page is in view. 
+- Add `time_on_page` to page-filtered Top Stats even when imports are included, unless legacy time on page is in view.
 - Adds team_id to query debug metadata (saved in system.query_log log_comment column)
 - Add "Unknown" option to Countries shield, for when the country code is unrecognized
 - Add "Last 24 Hours" to dashboard time range picker and Stats API v2
diff --git a/lib/plausible/stats/table_decider.ex b/lib/plausible/stats/table_decider.ex
@@ -4,15 +4,25 @@ defmodule Plausible.Stats.TableDecider do
   and metrics, with the purpose of reducing the number of queries and JOINs needed to perform.
   """
 
+  use Plausible
+
   import Enum, only: [empty?: 1]
   import Plausible.Stats.Filters, only: [dimensions_used_in_filters: 1]
 
   alias Plausible.Stats.{Query, QueryError}
 
+  @revenue_metrics on_ee(do: Plausible.Stats.Goal.Revenue.revenue_metrics(), else: [])
+
   def events_join_sessions?(query) do
-    query.filters
-    |> dimensions_used_in_filters()
-    |> Enum.any?(&(dimension_partitioner(query, &1) == :session))
+    session_dims_in_filters? =
+      query.filters
+      |> dimensions_used_in_filters()
+      |> Enum.any?(&(dimension_partitioner(query, &1) == :session))
+
+    session_dims? =
+      Enum.any?(query.dimensions, &(dimension_partitioner(query, &1) == :session))
+
+    session_dims? or session_dims_in_filters?
   end
 
   def sessions_join_events?(query) do
@@ -36,6 +46,8 @@ defmodule Plausible.Stats.TableDecider do
     %{event: event_only_dimensions, session: session_only_dimensions} =
       partition(query.dimensions, query, &dimension_partitioner/2)
 
+    conflicting_event_metrics = event_only_metrics -- @revenue_metrics
+
     cond do
       # event:page is a special case handled in QueryOptimizer.split_sessions_query
       event_only_dimensions == ["event:page"] ->
@@ -49,12 +61,12 @@ defmodule Plausible.Stats.TableDecider do
              "Session metric(s) #{i(session_only_metrics)} cannot be queried along with event dimension(s) #{i(event_only_dimensions)}"
          }}
 
-      not empty?(event_only_metrics) and not empty?(session_only_dimensions) ->
+      not empty?(conflicting_event_metrics) and not empty?(session_only_dimensions) ->
         {:error,
          %QueryError{
            code: :invalid_metrics,
            message:
-             "Event metric(s) #{i(event_only_metrics)} cannot be queried along with session dimension(s) #{i(session_only_dimensions)}"
+             "Event metric(s) #{i(conflicting_event_metrics)} cannot be queried along with session dimension(s) #{i(session_only_dimensions)}"
          }}
 
       true ->
diff --git a/test/plausible/stats/table_decider_test.exs b/test/plausible/stats/table_decider_test.exs
@@ -216,7 +216,21 @@ defmodule Plausible.Stats.TableDeciderTest do
               message:
                 "Event metric(s) `scroll_depth` cannot be queried along with session dimension(s) `visit:exit_page`"
             }}},
-          {[:bounce_rate, :scroll_depth], ["event:page"], :ok}
+          {[:bounce_rate, :scroll_depth], ["event:page"], :ok},
+          {[:scroll_depth], ["visit:entry_page"],
+           {:error,
+            %QueryError{
+              code: :invalid_metrics,
+              message:
+                "Event metric(s) `scroll_depth` cannot be queried along with session dimension(s) `visit:entry_page`"
+            }}},
+          {[:time_on_page], ["visit:exit_page"],
+           {:error,
+            %QueryError{
+              code: :invalid_metrics,
+              message:
+                "Event metric(s) `time_on_page` cannot be queried along with session dimension(s) `visit:exit_page`"
+            }}}
         ] do
       test "metrics #{inspect(metrics)} and dimensions #{inspect(dimensions)}" do
         query =
@@ -225,6 +239,19 @@ defmodule Plausible.Stats.TableDeciderTest do
         assert validate_no_metrics_dimensions_conflict(query) == unquote(Macro.escape(expected))
       end
     end
+
+    for {metrics, dimensions} <- [
+          {[:total_revenue], ["visit:entry_page"]},
+          {[:average_revenue], ["visit:exit_page"]}
+        ] do
+      @tag :ee_only
+      test "revenue metrics #{inspect(metrics)} and dimensions #{inspect(dimensions)} are allowed with session dimensions" do
+        query =
+          make_query() |> Query.set(metrics: unquote(metrics), dimensions: unquote(dimensions))
+
+        assert validate_no_metrics_dimensions_conflict(query) == :ok
+      end
+    end
   end
 
   defp make_query(filter_dimensions \\ [], dimensions \\ []) do
diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_test.exs
@@ -4824,6 +4824,70 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryTest do
 
       assert "metric_warnings" not in json_response(conn, 200)["meta"]
     end
+
+    test "breakdown by session dimension (entry page)", %{conn: conn, site: site} do
+      insert(:goal, site: site, event_name: "Purchase", currency: "USD")
+
+      populate_stats(site, [
+        build(:pageview, user_id: 1, pathname: "/blog"),
+        build(:event,
+          name: "Purchase",
+          user_id: 1,
+          revenue_reporting_amount: Decimal.new("100.00"),
+          revenue_reporting_currency: "USD"
+        ),
+        build(:pageview, user_id: 2, pathname: "/blog"),
+        build(:event,
+          name: "Purchase",
+          user_id: 2,
+          revenue_reporting_amount: Decimal.new("50.00"),
+          revenue_reporting_currency: "USD"
+        ),
+        build(:pageview, user_id: 3, pathname: "/home"),
+        build(:event,
+          name: "Purchase",
+          user_id: 3,
+          revenue_reporting_amount: Decimal.new("20.00"),
+          revenue_reporting_currency: "USD"
+        )
+      ])
+
+      conn =
+        post(conn, "/api/v2/query", %{
+          "site_id" => site.domain,
+          "date_range" => "all",
+          "metrics" => ["total_revenue", "average_revenue"],
+          "dimensions" => ["visit:entry_page"],
+          "filters" => [["is", "event:goal", ["Purchase"]]]
+        })
+
+      assert json_response(conn, 200)["results"] == [
+               %{
+                 "dimensions" => ["/blog"],
+                 "metrics" => [
+                   %{
+                     "currency" => "USD",
+                     "long" => "$150.00",
+                     "short" => "$150.0",
+                     "value" => 150.0
+                   },
+                   %{"currency" => "USD", "long" => "$75.00", "short" => "$75.0", "value" => 75.0}
+                 ]
+               },
+               %{
+                 "dimensions" => ["/home"],
+                 "metrics" => [
+                   %{
+                     "currency" => "USD",
+                     "long" => "$20.00",
+                     "short" => "$20.0",
+                     "value" => 20.0
+                   },
+                   %{"currency" => "USD", "long" => "$20.00", "short" => "$20.0", "value" => 20.0}
+                 ]
+               }
+             ]
+    end
   end
 
   describe "behavioral (has_done/has_not_done) filters" do
