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
Revenue metrics in APIv2 (#4893)
Karl-Aksel Puulmann82085c553e66
diff --git a/extra/lib/plausible/stats/goal/revenue.ex b/extra/lib/plausible/stats/goal/revenue.exindex 6c2d96ede1..dba19909ca 100644--- a/extra/lib/plausible/stats/goal/revenue.ex+++ b/extra/lib/plausible/stats/goal/revenue.ex@@ -10,7 +10,10 @@ defmodule Plausible.Stats.Goal.Revenue doend@doc """- Preloads revenue currencies for a query.+ Preloads revenue currencies for a query. Used when parsing the query.++ Returns tuple containing revenue warning (if set, no revenue metrics should be calculated) and+ revenue currencies map.Assumptions and business logic:1. Goals are already filtered according to query filters and dimensions@@ -21,26 +24,33 @@ defmodule Plausible.Stats.Goal.Revenue doThe resulting data structure is attached to a `Query` and used below in `format_revenue_metric/3`."""- def preload_revenue_currencies(site, goals, metrics, dimensions) do- if requested?(metrics) and length(goals) > 0 and available?(site) do- goal_currency_map =- goals- |> Map.new(fn goal -> {Plausible.Goal.display_name(goal), goal.currency} end)- |> Map.reject(fn {_goal, currency} -> is_nil(currency) end)-- currencies = goal_currency_map |> Map.values() |> Enum.uniq()- goal_dimension? = "event:goal" in dimensions-- case {currencies, goal_dimension?} do- {[currency], false} -> %{default: currency}- {_, true} -> goal_currency_map- _ -> %{}- end- else- %{}+ def preload(site, goals, metrics, dimensions) do+ cond do+ not requested?(metrics) -> {nil, %{}}+ not available?(site) -> {:revenue_goals_unavailable, %{}}+ true -> preload(goals, dimensions)+ end+ end++ defp preload(goals, dimensions) do+ goal_currency_map =+ goals+ |> Map.new(fn goal -> {Plausible.Goal.display_name(goal), goal.currency} end)+ |> Map.reject(fn {_goal, currency} -> is_nil(currency) end)++ currencies = goal_currency_map |> Map.values() |> Enum.uniq()+ goal_dimension? = "event:goal" in dimensions++ case {currencies, goal_dimension?} do+ {[currency], false} -> {nil, %{default: currency}}+ {[], _} -> {:no_revenue_goals_matching, %{}}+ {_, true} -> {nil, goal_currency_map}+ _ -> {:no_single_revenue_currency, %{}}endend+ def format_revenue_metric(_, query, _) when not is_nil(query.revenue_warning), do: nil+def format_revenue_metric(value, query, dimension_values) docurrency =query.revenue_currencies[:default] ||@@ -52,7 +62,8 @@ defmodule Plausible.Stats.Goal.Revenue do%{short: Money.to_string!(money, format: :short, fractional_digits: 1),long: Money.to_string!(money),- value: Decimal.to_float(money.amount)+ value: Decimal.to_float(money.amount),+ currency: currency}elsevaluediff --git a/lib/plausible/stats/filters/query_parser.ex b/lib/plausible/stats/filters/query_parser.exindex 684d6e1310..048e61f988 100644--- a/lib/plausible/stats/filters/query_parser.ex+++ b/lib/plausible/stats/filters/query_parser.ex@@ -38,8 +38,8 @@ defmodule Plausible.Stats.Filters.QueryParser do{:ok, order_by} <- parse_order_by(Map.get(params, "order_by")),{:ok, include} <- parse_include(site, Map.get(params, "include", %{})),{:ok, pagination} <- parse_pagination(Map.get(params, "pagination", %{})),- {preloaded_goals, revenue_currencies} <-- preload_needed_goals(site, metrics, filters, dimensions),+ {preloaded_goals, revenue_warning, revenue_currencies} <-+ preload_goals_and_revenue(site, metrics, filters, dimensions),query = %{metrics: metrics,filters: filters,@@ -50,6 +50,7 @@ defmodule Plausible.Stats.Filters.QueryParser doinclude: include,pagination: pagination,preloaded_goals: preloaded_goals,+ revenue_warning: revenue_warning,revenue_currencies: revenue_currencies},:ok <- validate_order_by(query),@@ -422,20 +423,24 @@ defmodule Plausible.Stats.Filters.QueryParser doendend- def preload_needed_goals(site, metrics, filters, dimensions) do+ def preload_goals_and_revenue(site, metrics, filters, dimensions) dogoal_filters? =Enum.any?(filters, fn [_, filter_key | _rest] -> filter_key == "event:goal" end)- if goal_filters? or Enum.member?(dimensions, "event:goal") do- goals = Plausible.Goals.Filters.preload_needed_goals(site, filters)+ goals =+ if goal_filters? or Enum.member?(dimensions, "event:goal") do+ Plausible.Goals.Filters.preload_needed_goals(site, filters)+ else+ []+ end- {- goals,- preload_revenue_currencies(site, goals, metrics, dimensions)- }- else- {[], %{}}- end+ {revenue_warning, revenue_currencies} = preload_revenue(site, goals, metrics, dimensions)++ {+ goals,+ revenue_warning,+ revenue_currencies+ }end@only_toplevel ["event:goal", "event:hostname"]@@ -485,8 +490,9 @@ defmodule Plausible.Stats.Filters.QueryParser doon_ee doalias Plausible.Stats.Goal.Revenue- defdelegate preload_revenue_currencies(site, preloaded_goals, metrics, dimensions),- to: Plausible.Stats.Goal.Revenue+ def preload_revenue(site, preloaded_goals, metrics, dimensions) do+ Revenue.preload(site, preloaded_goals, metrics, dimensions)+ enddefp validate_revenue_metrics_access(site, query) doif Revenue.requested?(query.metrics) and not Revenue.available?(site) do@@ -496,7 +502,7 @@ defmodule Plausible.Stats.Filters.QueryParser doendendelse- defp preload_revenue_currencies(_site, _preloaded_goals, _metrics, _dimensions), do: %{}+ defp preload_revenue(_site, _preloaded_goals, _metrics, _dimensions), do: {nil, %{}}defp validate_revenue_metrics_access(_site, _query), do: :okenddiff --git a/lib/plausible/stats/json_schema.ex b/lib/plausible/stats/json_schema.exindex 60fbb686a9..4ba428780e 100644--- a/lib/plausible/stats/json_schema.ex+++ b/lib/plausible/stats/json_schema.ex@@ -5,6 +5,7 @@ defmodule Plausible.Stats.JSONSchema doNote that `internal` queries expose some metrics, filter types and other features notavailable on the public API."""+ use Plausiblealias Plausible.Stats.JSONSchema.Utils@external_resource "priv/json-schemas/query-api-schema.json"@@ -13,8 +14,14 @@ defmodule Plausible.Stats.JSONSchema do|> File.read!()|> Jason.decode!()@raw_public_schema Utils.traverse(@raw_internal_schema, fn- %{"$comment" => "only :internal"} -> :remove- value -> value+ %{"$comment" => "only :internal"} ->+ :remove++ %{"$comment" => "only :ee"} = value ->+ if(ee?(), do: Map.delete(value, "$comment"), else: :remove)++ value ->+ valueend)@internal_query_schema ExJsonSchema.Schema.resolve(@raw_internal_schema)@public_query_schema ExJsonSchema.Schema.resolve(@raw_public_schema)diff --git a/lib/plausible/stats/legacy/legacy_query_builder.ex b/lib/plausible/stats/legacy/legacy_query_builder.exindex f555fa491e..5fa518bbcf 100644--- a/lib/plausible/stats/legacy/legacy_query_builder.ex+++ b/lib/plausible/stats/legacy/legacy_query_builder.ex@@ -19,7 +19,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do|> put_dimensions(params)|> put_interval(params)|> put_parsed_filters(params)- |> put_preloaded_goals(site)+ |> preload_goals_and_revenue(site)|> put_order_by(params)|> put_include_comparisons(site, params)|> Query.put_imported_opts(site, params)@@ -31,16 +31,20 @@ defmodule Plausible.Stats.Legacy.QueryBuilder doqueryend- defp put_preloaded_goals(query, site) do- {preloaded_goals, revenue_currencies} =- Plausible.Stats.Filters.QueryParser.preload_needed_goals(+ defp preload_goals_and_revenue(query, site) do+ {preloaded_goals, revenue_warning, revenue_currencies} =+ Plausible.Stats.Filters.QueryParser.preload_goals_and_revenue(site,query.metrics,query.filters,query.dimensions)- struct!(query, preloaded_goals: preloaded_goals, revenue_currencies: revenue_currencies)+ struct!(query,+ preloaded_goals: preloaded_goals,+ revenue_warning: revenue_warning,+ revenue_currencies: revenue_currencies+ )enddefp put_period(%Query{now: now} = query, _site, %{"period" => period})diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.exindex c4e18a01ec..8ee940eec6 100644--- a/lib/plausible/stats/query.ex+++ b/lib/plausible/stats/query.ex@@ -15,12 +15,14 @@ defmodule Plausible.Stats.Query doorder_by: nil,timezone: nil,legacy_breakdown: false,- remove_unavailable_revenue_metrics: false,preloaded_goals: [],- revenue_currencies: %{},include: Plausible.Stats.Filters.QueryParser.default_include(),debug_metadata: %{},- pagination: nil+ pagination: nil,+ # Revenue metric specific metadata+ revenue_currencies: %{},+ revenue_warning: nil,+ remove_unavailable_revenue_metrics: falserequire OpenTelemetry.Tracer, as: Traceralias Plausible.Stats.{DateTimeRange, Filters, Imported, Legacy}diff --git a/lib/plausible/stats/query_result.ex b/lib/plausible/stats/query_result.exindex 82a2128731..750097ecd7 100644--- a/lib/plausible/stats/query_result.ex+++ b/lib/plausible/stats/query_result.ex@@ -7,6 +7,7 @@ defmodule Plausible.Stats.QueryResult doproduced by Jason.encode(query_result) is ordered."""+ use Plausiblealias Plausible.Stats.DateTimeRangedefstruct results: [],@@ -40,10 +41,13 @@ defmodule Plausible.Stats.QueryResult do)end- @imports_unsupported_query_warning "Imported stats are not included in the results because query parameters are not supported. " <>- "For more information, see: https://plausible.io/docs/stats-api#filtering-imported-stats"-- @imports_unsupported_interval_warning "Imported stats are not included because the time dimension (i.e. the interval) is too short."+ @imports_warnings %{+ unsupported_query:+ "Imported stats are not included in the results because query parameters are not supported. " <>+ "For more information, see: https://plausible.io/docs/stats-api#filtering-imported-stats",+ unsupported_interval:+ "Imported stats are not included because the time dimension (i.e. the interval) is too short."+ }defp meta(query, meta_extra) do%{@@ -52,18 +56,14 @@ defmodule Plausible.Stats.QueryResult doif(query.include.imports and query.skip_imported_reason,do: to_string(query.skip_imported_reason)),- imports_warning:- case query.skip_imported_reason do- :unsupported_query -> @imports_unsupported_query_warning- :unsupported_interval -> @imports_unsupported_interval_warning- _ -> nil- end,+ imports_warning: @imports_warnings[query.skip_imported_reason],+ metric_warnings: metric_warnings(query),time_labels:if(query.include.time_labels, do: Plausible.Stats.Time.time_labels(query), else: nil),total_rows: if(query.include.total_rows, do: meta_extra.total_rows, else: nil)}|> Enum.reject(fn {_, value} -> is_nil(value) end)- |> Enum.into(%{})+ |> Map.new()enddefp include(query) do@@ -80,6 +80,36 @@ defmodule Plausible.Stats.QueryResult doendend+ on_ee do+ @revenue_metrics_warnings %{+ revenue_goals_unavailable:+ "The owner of this site does not have access to the revenue metrics feature.",+ no_single_revenue_currency:+ "Revenue metrics are null as there are multiple currencies for the selected event:goals.",+ no_revenue_goals_matching:+ "Revenue metrics are null as there are no matching revenue goals."+ }++ defp metric_warnings(query) do+ if query.revenue_warning do+ query.metrics+ |> Enum.filter(&(&1 in Plausible.Stats.Goal.Revenue.revenue_metrics()))+ |> Enum.map(+ &{&1,+ %{+ code: query.revenue_warning,+ warning: @revenue_metrics_warnings[query.revenue_warning]+ }}+ )+ |> Map.new()+ else+ nil+ end+ end+ else+ defp metric_warnings(_query), do: nil+ end+defp to_iso8601(datetime, timezone) dodatetime|> DateTime.shift_zone!(timezone)diff --git a/priv/json-schemas/query-api-schema.json b/priv/json-schemas/query-api-schema.jsonindex 593544d1ec..df18503283 100644--- a/priv/json-schemas/query-api-schema.json+++ b/priv/json-schemas/query-api-schema.json@@ -264,11 +264,13 @@},{"const": "total_revenue",- "$comment": "only :internal"+ "markdownDescription": "Total revenue",+ "$comment": "only :ee"},{"const": "average_revenue",- "$comment": "only :internal"+ "markdownDescription": "Average revenue",+ "$comment": "only :ee"},{"const": "scroll_depth",diff --git a/test/plausible/stats/query_parser_test.exs b/test/plausible/stats/query_parser_test.exsindex f8c2f536a2..ba7c8e8b81 100644--- a/test/plausible/stats/query_parser_test.exs+++ b/test/plausible/stats/query_parser_test.exs@@ -1,4 +1,5 @@defmodule Plausible.Stats.Filters.QueryParserTest do+ use Plausibleuse Plausible.DataCaseuse Plausible.Teams.Test@@ -49,8 +50,8 @@ defmodule Plausible.Stats.Filters.QueryParserTest dodef check_success(params, site, expected_result, schema_type \\ :public) doassert {:ok, result} = parse(site, schema_type, params, @now)- return_value = Map.take(result, [:preloaded_goals, :revenue_currencies])- result = Map.drop(result, [:preloaded_goals, :revenue_currencies])+ return_value = Map.take(result, [:preloaded_goals, :revenue_warning, :revenue_currencies])+ result = Map.drop(result, [:preloaded_goals, :revenue_warning, :revenue_currencies])assert result == expected_resultreturn_value@@ -88,6 +89,7 @@ defmodule Plausible.Stats.Filters.QueryParserTest do|> Enum.sort()assert preloaded_goal_names == Keyword.get(opts, :preloaded_goals)+ assert actual[:revenue_warning] == Keyword.get(opts, :revenue_warning)assert actual[:revenue_currencies] == Keyword.get(opts, :revenue_currencies)end@@ -1699,19 +1701,7 @@ defmodule Plausible.Stats.Filters.QueryParserTest do:okend- test "not valid in public schema", %{site: site} do- %{- "site_id" => site.domain,- "metrics" => ["total_revenue", "average_revenue"],- "date_range" => "all"- }- |> check_error(- site,- "#/metrics/0: Invalid metric \"total_revenue\"\n#/metrics/1: Invalid metric \"average_revenue\""- )- end-- test "can request in internal schema", %{site: site} do+ test "can request", %{site: site} do%{"site_id" => site.domain,"metrics" => ["total_revenue", "average_revenue"],@@ -1728,8 +1718,12 @@ defmodule Plausible.Stats.Filters.QueryParserTest dotimezone: site.timezone,include: %{imports: false, time_labels: false, total_rows: false, comparisons: nil},pagination: %{limit: 10_000, offset: 0}- },- :internal+ }+ )+ |> check_goals(+ preloaded_goals: [],+ revenue_warning: :no_revenue_goals_matching,+ revenue_currencies: %{})end@@ -1746,8 +1740,7 @@ defmodule Plausible.Stats.Filters.QueryParserTest do}|> check_error(site,- "The owner of this site does not have access to the revenue metrics feature.",- :internal+ "The owner of this site does not have access to the revenue metrics feature.")end@@ -1780,11 +1773,11 @@ defmodule Plausible.Stats.Filters.QueryParserTest dotimezone: site.timezone,include: %{imports: false, time_labels: false, total_rows: false, comparisons: nil},pagination: %{limit: 10_000, offset: 0}- },- :internal+ })|> check_goals(preloaded_goals: ["PurchaseUSD", "Signup", "Subscription"],+ revenue_warning: nil,revenue_currencies: %{default: :USD})end@@ -1811,11 +1804,42 @@ defmodule Plausible.Stats.Filters.QueryParserTest dotimezone: site.timezone,include: %{imports: false, time_labels: false, total_rows: false, comparisons: nil},pagination: %{limit: 10_000, offset: 0}- },- :internal+ })|> check_goals(preloaded_goals: ["Purchase", "Signup", "Subscription"],+ revenue_warning: :no_single_revenue_currency,+ revenue_currencies: %{}+ )+ end++ test "with event:goal filters with no revenue currencies", %{site: site} do+ insert(:goal, site: site, event_name: "Purchase", currency: "USD")+ insert(:goal, site: site, event_name: "Subscription", currency: "EUR")+ insert(:goal, site: site, event_name: "Signup")++ %{+ "site_id" => site.domain,+ "metrics" => ["total_revenue", "average_revenue"],+ "date_range" => "all",+ "filters" => [["is", "event:goal", ["Signup"]]]+ }+ |> check_success(+ site,+ %{+ metrics: [:total_revenue, :average_revenue],+ utc_time_range: @date_range_day,+ filters: [[:is, "event:goal", ["Signup"]]],+ dimensions: [],+ order_by: nil,+ timezone: site.timezone,+ include: %{imports: false, time_labels: false, total_rows: false, comparisons: nil},+ pagination: %{limit: 10_000, offset: 0}+ }+ )+ |> check_goals(+ preloaded_goals: ["Signup"],+ revenue_warning: :no_revenue_goals_matching,revenue_currencies: %{})end@@ -1842,16 +1866,51 @@ defmodule Plausible.Stats.Filters.QueryParserTest dotimezone: site.timezone,include: %{imports: false, time_labels: false, total_rows: false, comparisons: nil},pagination: %{limit: 10_000, offset: 0}- },- :internal+ })|> check_goals(preloaded_goals: ["Donation", "Purchase", "Signup"],+ revenue_warning: nil,revenue_currencies: %{"Donation" => :EUR, "Purchase" => :USD})endtest "with event:goal dimension and filters", %{site: site} do+ insert(:goal, site: site, event_name: "Purchase", currency: "USD")+ insert(:goal, site: site, event_name: "Subscription", currency: "EUR")+ insert(:goal, site: site, event_name: "Signup")+ insert(:goal, site: site, event_name: "Logout")++ %{+ "site_id" => site.domain,+ "metrics" => ["total_revenue", "average_revenue"],+ "date_range" => "all",+ "dimensions" => ["event:goal"],+ "filters" => [["is", "event:goal", ["Purchase", "Signup", "Subscription"]]]+ }+ |> check_success(+ site,+ %{+ metrics: [:total_revenue, :average_revenue],+ utc_time_range: @date_range_day,+ filters: [[:is, "event:goal", ["Purchase", "Signup", "Subscription"]]],+ dimensions: ["event:goal"],+ order_by: nil,+ timezone: site.timezone,+ include: %{imports: false, time_labels: false, total_rows: false, comparisons: nil},+ pagination: %{limit: 10_000, offset: 0}+ }+ )+ |> check_goals(+ preloaded_goals: ["Purchase", "Signup", "Subscription"],+ revenue_warning: nil,+ revenue_currencies: %{"Purchase" => :USD, "Subscription" => :EUR}+ )+ end++ test "with event:goal dimension and filters with no revenue goals matching", %{+ site: site+ } doinsert(:goal, site: site, event_name: "Purchase", currency: "USD")insert(:goal, site: site, event_name: "Subscription", currency: "USD")insert(:goal, site: site, event_name: "Signup")@@ -1862,29 +1921,42 @@ defmodule Plausible.Stats.Filters.QueryParserTest do"metrics" => ["total_revenue", "average_revenue"],"date_range" => "all","dimensions" => ["event:goal"],- "filters" => [["is", "event:goal", ["Purchase", "Signup"]]]+ "filters" => [["is", "event:goal", ["Signup"]]]}|> check_success(site,%{metrics: [:total_revenue, :average_revenue],utc_time_range: @date_range_day,- filters: [[:is, "event:goal", ["Purchase", "Signup"]]],+ filters: [[:is, "event:goal", ["Signup"]]],dimensions: ["event:goal"],order_by: nil,timezone: site.timezone,include: %{imports: false, time_labels: false, total_rows: false, comparisons: nil},pagination: %{limit: 10_000, offset: 0}- },- :internal+ })|> check_goals(- preloaded_goals: ["Purchase", "Signup"],- revenue_currencies: %{"Purchase" => :USD}+ preloaded_goals: ["Signup"],+ revenue_warning: :no_revenue_goals_matching,+ revenue_currencies: %{})endend+ @tag :ce_build_only+ test "revenue metrics are not available on CE", %{site: site} do+ %{+ "site_id" => site.domain,+ "metrics" => ["total_revenue", "average_revenue"],+ "date_range" => "all"+ }+ |> check_error(+ site,+ "#/metrics/0: Invalid metric \"total_revenue\"\n#/metrics/1: Invalid metric \"average_revenue\""+ )+ end+describe "session metrics" dotest "single session metric succeeds", %{site: site} 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.exsindex 5100a9c311..009cec6189 100644--- a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/query_test.exs@@ -4077,4 +4077,398 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryTest do%{"metrics" => [2, 1, 0, 1500], "dimensions" => []}]end++ describe "revenue metrics" do+ @describetag :ee_only++ setup %{user: user} do+ subscribe_to_enterprise_plan(user,+ features: [Plausible.Billing.Feature.StatsAPI, Plausible.Billing.Feature.RevenueGoals]+ )++ :ok+ end++ test "not requested leads to no metric_warnings", %{conn: conn, site: site} do+ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["pageviews"]+ })++ assert json_response(conn, 200)["results"] == [%{"dimensions" => [], "metrics" => [0]}]+ assert "metric_warnings" not in json_response(conn, 200)["meta"]+ end++ test "no revenue goals configured", %{conn: conn, site: site} do+ insert(:goal, site: site, event_name: "Signup")++ populate_stats(site, [+ build(:event,+ name: "Signup",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["average_revenue", "total_revenue"],+ "dimensions" => ["event:goal"]+ })++ assert json_response(conn, 200)["results"] == [+ %{"dimensions" => ["Signup"], "metrics" => [nil, nil]}+ ]++ assert json_response(conn, 200)["meta"]["metric_warnings"] == %{+ "average_revenue" => %{+ "code" => "no_revenue_goals_matching",+ "warning" => "Revenue metrics are null as there are no matching revenue goals."+ },+ "total_revenue" => %{+ "code" => "no_revenue_goals_matching",+ "warning" => "Revenue metrics are null as there are no matching revenue goals."+ }+ }+ end++ test "not filtering or grouping by goals leads to warnings", %{conn: conn, site: site} do+ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["average_revenue", "total_revenue"]+ })++ assert json_response(conn, 200)["results"] == [+ %{"dimensions" => [], "metrics" => [nil, nil]}+ ]++ assert json_response(conn, 200)["meta"]["metric_warnings"] == %{+ "average_revenue" => %{+ "code" => "no_revenue_goals_matching",+ "warning" => "Revenue metrics are null as there are no matching revenue goals."+ },+ "total_revenue" => %{+ "code" => "no_revenue_goals_matching",+ "warning" => "Revenue metrics are null as there are no matching revenue goals."+ }+ }+ end++ test "filtering by revenue goals with same currency", %{conn: conn, site: site} do+ insert(:goal, site: site, event_name: "Purchase", currency: "USD")+ insert(:goal, site: site, event_name: "Payment", currency: "USD")+ insert(:goal, site: site, event_name: "Subscription", currency: "EUR")+ insert(:goal, site: site, event_name: "Signup")++ populate_stats(site, [+ build(:event,+ name: "Purchase",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("100.3"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("40.3"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("60.6"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Subscription",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("100"),+ revenue_reporting_currency: "EUR"+ ),+ build(:event,+ name: "Signup",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["events", "average_revenue", "total_revenue"],+ "filters" => [+ ["is", "event:goal", ["Signup", "Purchase", "Payment"]]+ ]+ })++ assert json_response(conn, 200)["results"] == [+ %{+ "dimensions" => [],+ "metrics" => [+ 4,+ %{+ "currency" => "USD",+ "long" => "$67.07",+ "short" => "$67.1",+ "value" => 67.066+ },+ %{+ "currency" => "USD",+ "long" => "$201.20",+ "short" => "$201.2",+ "value" => 201.2+ }+ ]+ }+ ]++ assert "metric_warnings" not in json_response(conn, 200)["meta"]+ end++ test "filtering by revenue goals with different currencies", %{conn: conn, site: site} do+ insert(:goal, site: site, event_name: "Purchase", currency: "USD")+ insert(:goal, site: site, event_name: "Payment", currency: "USD")+ insert(:goal, site: site, event_name: "Subscription", currency: "EUR")+ insert(:goal, site: site, event_name: "Signup")++ populate_stats(site, [+ build(:event,+ name: "Purchase",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("100.3"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("40.3"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("60.6"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Subscription",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("100"),+ revenue_reporting_currency: "EUR"+ ),+ build(:event,+ name: "Signup",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["average_revenue", "total_revenue"],+ "filters" => [+ ["is", "event:goal", ["Subscription", "Payment"]]+ ]+ })++ assert json_response(conn, 200)["results"] == [+ %{+ "dimensions" => [],+ "metrics" => [nil, nil]+ }+ ]++ assert json_response(conn, 200)["meta"]["metric_warnings"] == %{+ "average_revenue" => %{+ "code" => "no_single_revenue_currency",+ "warning" =>+ "Revenue metrics are null as there are multiple currencies for the selected event:goals."+ },+ "total_revenue" => %{+ "code" => "no_single_revenue_currency",+ "warning" =>+ "Revenue metrics are null as there are multiple currencies for the selected event:goals."+ }+ }+ end++ test "breakdown by revenue goals", %{conn: conn, site: site} do+ insert(:goal, site: site, event_name: "Purchase", currency: "USD")+ insert(:goal, site: site, event_name: "Payment", currency: "USD")+ insert(:goal, site: site, event_name: "Subscription", currency: "EUR")+ insert(:goal, site: site, event_name: "Signup")++ populate_stats(site, [+ build(:event,+ name: "Purchase",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("100.3"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("40.3"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("60.6"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Subscription",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("100"),+ revenue_reporting_currency: "EUR"+ ),+ build(:event,+ name: "Signup",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["average_revenue", "total_revenue"],+ "dimensions" => ["event:goal"]+ })++ assert json_response(conn, 200)["results"] == [+ %{+ "dimensions" => ["Purchase"],+ "metrics" => [+ %{+ "currency" => "USD",+ "long" => "$100.30",+ "short" => "$100.3",+ "value" => 100.3+ },+ %{+ "currency" => "USD",+ "long" => "$100.30",+ "short" => "$100.3",+ "value" => 100.3+ }+ ]+ },+ %{+ "dimensions" => ["Subscription"],+ "metrics" => [+ %{+ "currency" => "EUR",+ "long" => "€100.00",+ "short" => "€100.0",+ "value" => 100.0+ },+ %{+ "currency" => "EUR",+ "long" => "€100.00",+ "short" => "€100.0",+ "value" => 100.0+ }+ ]+ },+ %{+ "dimensions" => ["Payment"],+ "metrics" => [+ %{+ "currency" => "USD",+ "long" => "$50.45",+ "short" => "$50.4",+ "value" => 50.45+ },+ %{+ "currency" => "USD",+ "long" => "$100.90",+ "short" => "$100.9",+ "value" => 100.9+ }+ ]+ },+ %{"dimensions" => ["Signup"], "metrics" => [nil, nil]}+ ]++ assert "metric_warnings" not in json_response(conn, 200)["meta"]+ end++ test "breakdown by revenue goals + filtering", %{conn: conn, site: site} do+ insert(:goal, site: site, event_name: "Purchase", currency: "USD")+ insert(:goal, site: site, event_name: "Payment", currency: "USD")+ insert(:goal, site: site, event_name: "Subscription", currency: "EUR")+ insert(:goal, site: site, event_name: "Signup")++ populate_stats(site, [+ build(:event,+ name: "Purchase",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("100.3"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("40.3"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("60.6"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Subscription",+ timestamp: ~N[2021-01-01 00:00:00],+ revenue_reporting_amount: Decimal.new("100"),+ revenue_reporting_currency: "EUR"+ ),+ build(:event,+ name: "Signup",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["average_revenue", "total_revenue"],+ "filters" => [["is", "event:goal", ["Signup", "Purchase"]]],+ "dimensions" => ["event:goal"]+ })++ assert json_response(conn, 200)["results"] == [+ %{+ "dimensions" => ["Purchase"],+ "metrics" => [+ %{+ "currency" => "USD",+ "long" => "$100.30",+ "short" => "$100.3",+ "value" => 100.3+ },+ %{+ "currency" => "USD",+ "long" => "$100.30",+ "short" => "$100.3",+ "value" => 100.3+ }+ ]+ },+ %{"dimensions" => ["Signup"], "metrics" => [nil, nil]}+ ]++ assert "metric_warnings" not in json_response(conn, 200)["meta"]+ end+ endenddiff --git a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs b/test/plausible_web/controllers/api/stats_controller/conversions_test.exsindex 260573f4a8..738c5b6e6b 100644--- a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/conversions_test.exs@@ -308,12 +308,14 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"average_revenue" => %{"short" => "€166.7M","long" => "€166,733,566.75",- "value" => 166_733_566.748+ "value" => 166_733_566.748,+ "currency" => "EUR"},"total_revenue" => %{"short" => "€500.2M","long" => "€500,200,700.25",- "value" => 500_200_700.246+ "value" => 500_200_700.246,+ "currency" => "EUR"}}]@@ -390,11 +392,21 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest doassert [%{- "average_revenue" => %{"long" => "€10.00", "short" => "€10.0", "value" => 10.0},+ "average_revenue" => %{+ "long" => "€10.00",+ "short" => "€10.0",+ "value" => 10.0,+ "currency" => "EUR"+ },"conversion_rate" => 16.7,"name" => "Payment","events" => 1,- "total_revenue" => %{"long" => "€10.00", "short" => "€10.0", "value" => 10.0},+ "total_revenue" => %{+ "long" => "€10.00",+ "short" => "€10.0",+ "value" => 10.0,+ "currency" => "EUR"+ },"visitors" => 1},%{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.exsindex 34c9f1da66..d25228b293 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@@ -810,16 +810,36 @@ defmodule PlausibleWeb.Api.StatsController.CustomPropBreakdownTest do"name" => "true","events" => 2,"conversion_rate" => 66.7,- "total_revenue" => %{"long" => "€112.00", "short" => "€112.0", "value" => 112.00},- "average_revenue" => %{"long" => "€56.00", "short" => "€56.0", "value" => 56.00}+ "total_revenue" => %{+ "long" => "€112.00",+ "short" => "€112.0",+ "value" => 112.00,+ "currency" => "EUR"+ },+ "average_revenue" => %{+ "long" => "€56.00",+ "short" => "€56.0",+ "value" => 56.00,+ "currency" => "EUR"+ }},%{"visitors" => 1,"name" => "false","events" => 1,"conversion_rate" => 33.3,- "total_revenue" => %{"long" => "€8.00", "short" => "€8.0", "value" => 8.00},- "average_revenue" => %{"long" => "€8.00", "short" => "€8.0", "value" => 8.00}+ "total_revenue" => %{+ "long" => "€8.00",+ "short" => "€8.0",+ "value" => 8.00,+ "currency" => "EUR"+ },+ "average_revenue" => %{+ "long" => "€8.00",+ "short" => "€8.0",+ "value" => 8.00,+ "currency" => "EUR"+ }}]end@@ -874,16 +894,36 @@ defmodule PlausibleWeb.Api.StatsController.CustomPropBreakdownTest do"name" => "true","events" => 2,"conversion_rate" => 66.7,- "total_revenue" => %{"long" => "€80.00", "short" => "€80.0", "value" => 80.0},- "average_revenue" => %{"long" => "€40.00", "short" => "€40.0", "value" => 40.0}+ "total_revenue" => %{+ "long" => "€80.00",+ "short" => "€80.0",+ "value" => 80.0,+ "currency" => "EUR"+ },+ "average_revenue" => %{+ "long" => "€40.00",+ "short" => "€40.0",+ "value" => 40.0,+ "currency" => "EUR"+ }},%{"visitors" => 1,"name" => "false","events" => 1,"conversion_rate" => 33.3,- "total_revenue" => %{"long" => "€10.00", "short" => "€10.0", "value" => 10.0},- "average_revenue" => %{"long" => "€10.00", "short" => "€10.0", "value" => 10.0}+ "total_revenue" => %{+ "long" => "€10.00",+ "short" => "€10.0",+ "value" => 10.0,+ "currency" => "EUR"+ },+ "average_revenue" => %{+ "long" => "€10.00",+ "short" => "€10.0",+ "value" => 10.0,+ "currency" => "EUR"+ }}]enddiff --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 0bc99cdc3f..f5061b6e9c 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@@ -1414,13 +1414,23 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest doassert %{"name" => "Average revenue",- "value" => %{"long" => "$1,659.50", "short" => "$1.7K", "value" => 1659.5},+ "value" => %{+ "long" => "$1,659.50",+ "short" => "$1.7K",+ "value" => 1659.5,+ "currency" => "USD"+ },"graph_metric" => "average_revenue"} in top_statsassert %{"name" => "Total revenue",- "value" => %{"long" => "$3,319.00", "short" => "$3.3K", "value" => 3319.0},+ "value" => %{+ "long" => "$3,319.00",+ "short" => "$3.3K",+ "value" => 3319.0,+ "currency" => "USD"+ },"graph_metric" => "total_revenue"} in top_statsend@@ -1473,13 +1483,23 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest doassert %{"name" => "Average revenue",- "value" => %{"long" => "$1,659.50", "short" => "$1.7K", "value" => 1659.5},+ "value" => %{+ "long" => "$1,659.50",+ "short" => "$1.7K",+ "value" => 1659.5,+ "currency" => "USD"+ },"graph_metric" => "average_revenue"} in top_statsassert %{"name" => "Total revenue",- "value" => %{"long" => "$6,638.00", "short" => "$6.6K", "value" => 6638.0},+ "value" => %{+ "long" => "$6,638.00",+ "short" => "$6.6K",+ "value" => 6638.0,+ "currency" => "USD"+ },"graph_metric" => "total_revenue"} in top_statsend@@ -1549,13 +1569,23 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest doassert %{"name" => "Average revenue",- "value" => %{"long" => "$1,000.00", "short" => "$1.0K", "value" => 1000.0},+ "value" => %{+ "long" => "$1,000.00",+ "short" => "$1.0K",+ "value" => 1000.0,+ "currency" => "USD"+ },"graph_metric" => "average_revenue"} in top_statsassert %{"name" => "Total revenue",- "value" => %{"long" => "$2,000.00", "short" => "$2.0K", "value" => 2000.0},+ "value" => %{+ "long" => "$2,000.00",+ "short" => "$2.0K",+ "value" => 2000.0,+ "currency" => "USD"+ },"graph_metric" => "total_revenue"} in top_statsend@@ -1571,13 +1601,23 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest doassert %{"name" => "Average revenue",- "value" => %{"long" => "$0.00", "short" => "$0.0", "value" => 0.0},+ "value" => %{+ "long" => "$0.00",+ "short" => "$0.0",+ "value" => 0.0,+ "currency" => "USD"+ },"graph_metric" => "average_revenue"} in top_statsassert %{"name" => "Total revenue",- "value" => %{"long" => "$0.00", "short" => "$0.0", "value" => 0.0},+ "value" => %{+ "long" => "$0.00",+ "short" => "$0.0",+ "value" => 0.0,+ "currency" => "USD"+ },"graph_metric" => "total_revenue"} in top_statsend