diff --git a/assets/js/dashboard/stats/behaviours/props.js b/assets/js/dashboard/stats/behaviours/props.js index 2a9579568..6463a65ac 100644 --- a/assets/js/dashboard/stats/behaviours/props.js +++ b/assets/js/dashboard/stats/behaviours/props.js @@ -43,9 +43,11 @@ export default function Properties(props) { getFilterFor={getFilterFor} keyLabel={propKey} metrics={[ - {name: 'visitors', label: 'Visitors'}, - {name: 'events', label: 'Events'}, - query.filters.goal ? CR_METRIC : PERCENTAGE_METRIC + {name: 'visitors', label: 'Visitors', plot: true}, + {name: 'events', label: 'Events', hiddenOnMobile: true}, + query.filters.goal ? CR_METRIC : PERCENTAGE_METRIC, + {name: 'total_revenue', label: 'Revenue', hiddenOnMobile: true}, + {name: 'average_revenue', label: 'Average', hiddenOnMobile: true} ]} detailsLink={url.sitePath(site, `/custom-prop-values/${propKey}`)} query={query} diff --git a/assets/js/dashboard/stats/modals/props.js b/assets/js/dashboard/stats/modals/props.js index 09e66d19a..44ce1fc59 100644 --- a/assets/js/dashboard/stats/modals/props.js +++ b/assets/js/dashboard/stats/modals/props.js @@ -1,6 +1,7 @@ import React, { useEffect, useState } from "react"; import { Link } from 'react-router-dom' import { withRouter } from 'react-router-dom' +import Money from "../behaviours/money"; import Modal from './modal' import * as api from '../../api' @@ -53,7 +54,7 @@ function PropsModal(props) { return searchParams.toString() } - function renderListItem(listItem) { + function renderListItem(listItem, hasRevenue) { return ( @@ -63,10 +64,12 @@ function PropsModal(props) { {listItem.name} - {numberFormatter(listItem.visitors)} - {numberFormatter(listItem.events)} - { query.filters.goal && {listItem.conversion_rate}% } - { !query.filters.goal && {listItem.percentage} } + {numberFormatter(listItem.visitors)} + {numberFormatter(listItem.events)} + { query.filters.goal && {listItem.conversion_rate}% } + { !query.filters.goal && {listItem.percentage} } + { hasRevenue && } + { hasRevenue && } ) } @@ -76,6 +79,8 @@ function PropsModal(props) { } function renderBody() { + const hasRevenue = list.some((prop) => prop.total_revenue) + return ( <>

Custom Property breakdown

@@ -86,13 +91,15 @@ function PropsModal(props) { {propKey} - Visitors - Events - {query.filters.goal ? 'CR' : '%'} + Visitors + Events + {query.filters.goal ? 'CR' : '%'} + {hasRevenue && Revenue} + {hasRevenue && Average} - { list.map(renderListItem) } + { list.map((item) => renderListItem(item, hasRevenue)) } diff --git a/assets/js/dashboard/stats/reports/list.js b/assets/js/dashboard/stats/reports/list.js index c0fd73d4c..a22beb56b 100644 --- a/assets/js/dashboard/stats/reports/list.js +++ b/assets/js/dashboard/stats/reports/list.js @@ -139,6 +139,23 @@ export default function ListReport(props) { return () => { document.removeEventListener('tick', fetchData) } }, [props.keyLabel, props.query, visible]); + // returns a filtered `metrics` list. Since currently, the backend can return different + // metrics based on filters and existing data, this function validates that the metrics + // we want to display are actually there in the API response. + function getAvailableMetrics() { + return metrics.filter((metric) => { + return state.list.some((listItem) => listItem[metric.name] != null) + }) + } + + function hiddenOnMobileClass(metric) { + if (metric.hiddenOnMobile) { + return 'hidden md:block' + } else { + return '' + } + } + function renderReport() { if (state.list && state.list.length > 0) { return ( @@ -159,8 +176,16 @@ export default function ListReport(props) { } function renderReportHeader() { - const metricLabels = metrics.map((metric) => { - return ({ metricLabelFor(metric, props.query) }) + const metricLabels = getAvailableMetrics().map((metric) => { + return ( +
+ { metricLabelFor(metric, props.query) } +
+ ) }) return ( @@ -205,7 +230,7 @@ export default function ListReport(props) { function renderBarFor(listItem) { const lightBackground = props.color || 'bg-green-50' const noop = () => {} - const metricToPlot = metrics[0].name + const metricToPlot = metrics.find(m => m.plot).name return (
@@ -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