@@ -241,9 +266,13 @@ export default function ListReport(props) {
}
function renderMetricValuesFor(listItem) {
- return metrics.map((metric) => {
+ return getAvailableMetrics().map((metric) => {
return (
-
+
{ displayMetricValue(listItem[metric.name], metric) }
diff --git a/assets/js/dashboard/stats/reports/metrics.js b/assets/js/dashboard/stats/reports/metrics.js
index 3f40c1498..6708bb80a 100644
--- a/assets/js/dashboard/stats/reports/metrics.js
+++ b/assets/js/dashboard/stats/reports/metrics.js
@@ -1,11 +1,13 @@
import numberFormatter from "../../util/number-formatter"
import React from "react"
+import Money from "../behaviours/money"
export const VISITORS_METRIC = {
name: 'visitors',
label: 'Visitors',
realtimeLabel: 'Current visitors',
- goalFilterLabel: 'Conversions'
+ goalFilterLabel: 'Conversions',
+ plot: true
}
export const PERCENTAGE_METRIC = { name: 'percentage', label: '%' }
export const CR_METRIC = { name: 'conversion_rate', label: 'CR' }
@@ -23,7 +25,9 @@ export function maybeWithCR(metrics, query) {
}
export function displayMetricValue(value, metric) {
- if (metric === PERCENTAGE_METRIC) {
+ if (['total_revenue', 'average_revenue'].includes(metric.name)) {
+ return
+ } else if (metric === PERCENTAGE_METRIC) {
return value
} else if (metric === CR_METRIC) {
return `${value}%`
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex
index 9b9f2f929..5e26d7cbb 100644
--- a/lib/plausible_web/controllers/api/stats_controller.ex
+++ b/lib/plausible_web/controllers/api/stats_controller.ex
@@ -1206,18 +1206,28 @@ defmodule PlausibleWeb.Api.StatsController do
end
defp breakdown_custom_prop_values(site, %{"prop_key" => prop_key} = params) do
+ pagination = parse_pagination(params)
+ prefixed_prop = "event:props:" <> prop_key
+
query =
Query.from(site, params)
|> Filters.add_prefix()
|> Map.put(:include_imported, false)
- pagination = parse_pagination(params)
-
- prefixed_prop = "event:props:" <> prop_key
+ metrics =
+ if Map.has_key?(query.filters, "event:goal") do
+ [:visitors, :events, :average_revenue, :total_revenue]
+ else
+ [:visitors, :events]
+ end
props =
- Stats.breakdown(site, query, prefixed_prop, [:visitors, :events], pagination)
+ Stats.breakdown(site, query, prefixed_prop, metrics, pagination)
|> transform_keys(%{prop_key => :name})
+ |> Enum.map(fn entry ->
+ Enum.map(entry, &format_revenue_metric/1)
+ |> Map.new()
+ end)
|> add_percentages(site, query)
if Map.has_key?(query.filters, "event:goal") do
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 fd94f5c7b..c7cd3c559 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
@@ -775,6 +775,155 @@ defmodule PlausibleWeb.Api.StatsController.CustomPropBreakdownTest do
}
]
end
+
+ test "returns revenue metrics when filtering by a revenue goal", %{conn: conn, site: site} do
+ prop_key = "logged_in"
+
+ populate_stats(site, [
+ build(:event,
+ name: "Payment",
+ "meta.key": [prop_key],
+ "meta.value": ["true"],
+ revenue_reporting_amount: Decimal.new("12"),
+ revenue_reporting_currency: "EUR"
+ ),
+ build(:event,
+ name: "Payment",
+ "meta.key": [prop_key],
+ "meta.value": ["true"],
+ revenue_reporting_amount: Decimal.new("100"),
+ revenue_reporting_currency: "EUR"
+ ),
+ build(:event,
+ name: "Payment",
+ "meta.key": [prop_key],
+ "meta.value": ["false"],
+ revenue_reporting_amount: Decimal.new("8"),
+ revenue_reporting_currency: "EUR"
+ )
+ ])
+
+ insert(:goal, %{site: site, event_name: "Payment", currency: :EUR})
+
+ filters = Jason.encode!(%{goal: "Payment"})
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/custom-prop-values/#{prop_key}?period=day&filters=#{filters}"
+ )
+
+ assert json_response(conn, 200) == [
+ %{
+ "visitors" => 2,
+ "name" => "true",
+ "events" => 2,
+ "conversion_rate" => 66.7,
+ "total_revenue" => %{"long" => "€112.00", "short" => "€112.0"},
+ "average_revenue" => %{"long" => "€56.00", "short" => "€56.0"}
+ },
+ %{
+ "visitors" => 1,
+ "name" => "false",
+ "events" => 1,
+ "conversion_rate" => 33.3,
+ "total_revenue" => %{"long" => "€8.00", "short" => "€8.0"},
+ "average_revenue" => %{"long" => "€8.00", "short" => "€8.0"}
+ }
+ ]
+ end
+
+ test "returns revenue metrics when filtering by many revenue goals with same currency", %{
+ conn: conn,
+ site: site
+ } do
+ prop_key = "logged_in"
+ insert(:goal, site: site, event_name: "Payment", currency: "EUR")
+ insert(:goal, site: site, event_name: "Payment2", currency: "EUR")
+
+ populate_stats(site, [
+ build(:event,
+ name: "Payment",
+ "meta.key": [prop_key],
+ "meta.value": ["false"],
+ revenue_reporting_amount: Decimal.new("10"),
+ revenue_reporting_currency: "EUR"
+ ),
+ build(:event,
+ name: "Payment",
+ "meta.key": [prop_key],
+ "meta.value": ["true"],
+ revenue_reporting_amount: Decimal.new("30"),
+ revenue_reporting_currency: "EUR"
+ ),
+ build(:event,
+ name: "Payment2",
+ "meta.key": [prop_key],
+ "meta.value": ["true"],
+ revenue_reporting_amount: Decimal.new("50"),
+ revenue_reporting_currency: "EUR"
+ )
+ ])
+
+ filters = Jason.encode!(%{goal: "Payment|Payment2"})
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/custom-prop-values/#{prop_key}?period=day&filters=#{filters}"
+ )
+
+ assert json_response(conn, 200) == [
+ %{
+ "visitors" => 2,
+ "name" => "true",
+ "events" => 2,
+ "conversion_rate" => 66.7,
+ "total_revenue" => %{"long" => "€80.00", "short" => "€80.0"},
+ "average_revenue" => %{"long" => "€40.00", "short" => "€40.0"}
+ },
+ %{
+ "visitors" => 1,
+ "name" => "false",
+ "events" => 1,
+ "conversion_rate" => 33.3,
+ "total_revenue" => %{"long" => "€10.00", "short" => "€10.0"},
+ "average_revenue" => %{"long" => "€10.00", "short" => "€10.0"}
+ }
+ ]
+ end
+
+ test "does not return revenue metrics when filtering by many revenue goals with different currencies",
+ %{conn: conn, site: site} do
+ insert(:goal, site: site, event_name: "Payment", currency: "USD")
+ insert(:goal, site: site, event_name: "AddToCart", currency: "EUR")
+
+ populate_stats(site, [
+ build(:event,
+ name: "Payment",
+ "meta.key": ["logged_in"],
+ "meta.value": ["false"],
+ revenue_reporting_amount: Decimal.new("10"),
+ revenue_reporting_currency: "EUR"
+ )
+ ])
+
+ filters = Jason.encode!(%{goal: "Payment|AddToCart"})
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/custom-prop-values/whatever-prop?period=day&filters=#{filters}"
+ )
+
+ returned_metrics =
+ json_response(conn, 200)
+ |> List.first()
+ |> Map.keys()
+
+ refute "Average revenue" in returned_metrics
+ refute "Total revenue" in returned_metrics
+ end
end
describe "GET /api/stats/:domain/custom-prop-values/:prop_key - other filters" do