@ -346,23 +346,61 @@ defmodule PlausibleWeb.Api.StatsController do
end
defp fetch_top_stats ( site , % Query { filters : %{ " event:goal " = > _ } } = query , comparison_query ) do
metrics =
[ :total_visitors , :visitors , :events , :conversion_rate ] ++ @revenue_metrics
query_without_filters = Query . remove_event_filters ( query , [ :goal , :props ] )
metrics = [ :visitors , :events ] ++ @revenue_metrics
results_without_filters =
site
|> Stats . aggregate ( query_without_filters , [ :visitors ] )
|> transform_keys ( %{ visitors : :unique_visitors } )
results = Stats . aggregate ( site , query , metrics )
comparison = if comparison_query , do : Stats . aggregate ( site , comparison_query , metrics )
results =
site
|> Stats . aggregate ( query , metrics )
|> transform_keys ( %{ visitors : :converted_visitors , events : :completions } )
|> Map . merge ( results_without_filters )
comparison =
if comparison_query do
comparison_query_without_filters =
Query . remove_event_filters ( comparison_query , [ :goal , :props ] )
comparison_without_filters =
site
|> Stats . aggregate ( comparison_query_without_filters , [ :visitors ] )
|> transform_keys ( %{ visitors : :unique_visitors } )
site
|> Stats . aggregate ( comparison_query , metrics )
|> transform_keys ( %{ visitors : :converted_visitors , events : :completions } )
|> Map . merge ( comparison_without_filters )
end
conversion_rate = %{
cr : %{ value : calculate_cr ( results . unique_visitors . value , results . converted_visitors . value ) }
}
comparison_conversion_rate =
if comparison do
value =
calculate_cr ( comparison . unique_visitors . value , comparison . converted_visitors . value )
%{ cr : %{ value : value } }
else
nil
end
[
top_stats_entry ( results , comparison , " Unique visitors " , :total_visitors ) ,
top_stats_entry ( results , comparison , " Unique conversions " , :visitors ) ,
top_stats_entry ( results , comparison , " Total conversions " , :events ) ,
top_stats_entry ( results , comparison , " Unique visitors " , : unique _visitors) ,
top_stats_entry ( results , comparison , " Unique conversions " , : converted_ visitors) ,
top_stats_entry ( results , comparison , " Total conversions " , : completion s) ,
on_full_build do
top_stats_entry ( results , comparison , " Average revenue " , :average_revenue , & format_money / 1 )
end ,
on_full_build do
top_stats_entry ( results , comparison , " Total revenue " , :total_revenue , & format_money / 1 )
end ,
top_stats_entry ( results , comparison , " Conversion rate " , :conversion_rate )
top_stats_entry ( conversion_rate, comparison_conversion_rate , " Conversion rate " , :c r)
]
|> Enum . reject ( & is_nil / 1 )
|> then ( & { &1 , 100 } )
@ -431,16 +469,17 @@ defmodule PlausibleWeb.Api.StatsController do
def sources ( conn , params ) do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
extra_metrics =
if params [ " detailed " ] , do : [ :bounce_rate , :visit_duration ] , else : [ ]
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query , extra_metrics )
metrics =
if params [ " detailed " ] , do : [ :visitors , :bounce_rate , :visit_duration ] , else : [ :visitors ]
res =
Stats . breakdown ( site , query , " visit:source " , metrics , pagination )
|> add_cr ( site , query , pagination , :source , " visit:source " )
|> transform_keys ( %{ source : :name } )
if params [ " csv " ] do
@ -513,12 +552,16 @@ defmodule PlausibleWeb.Api.StatsController do
def utm_mediums ( conn , params ) do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query , [ :bounce_rate , :visit_duration ] )
metrics = [ :visitors , :bounce_rate , :visit_duration ]
res =
Stats . breakdown ( site , query , " visit:utm_medium " , metrics , pagination )
|> add_cr ( site , query , pagination , :utm_medium , " visit:utm_medium " )
|> transform_keys ( %{ utm_medium : :name } )
if params [ " csv " ] do
@ -536,12 +579,16 @@ defmodule PlausibleWeb.Api.StatsController do
def utm_campaigns ( conn , params ) do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query , [ :bounce_rate , :visit_duration ] )
metrics = [ :visitors , :bounce_rate , :visit_duration ]
res =
Stats . breakdown ( site , query , " visit:utm_campaign " , metrics , pagination )
|> add_cr ( site , query , pagination , :utm_campaign , " visit:utm_campaign " )
|> transform_keys ( %{ utm_campaign : :name } )
if params [ " csv " ] do
@ -559,12 +606,15 @@ defmodule PlausibleWeb.Api.StatsController do
def utm_contents ( conn , params ) do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query , [ :bounce_rate , :visit_duration ] )
metrics = [ :visitors , :bounce_rate , :visit_duration ]
res =
Stats . breakdown ( site , query , " visit:utm_content " , metrics , pagination )
|> add_cr ( site , query , pagination , :utm_content , " visit:utm_content " )
|> transform_keys ( %{ utm_content : :name } )
if params [ " csv " ] do
@ -582,12 +632,15 @@ defmodule PlausibleWeb.Api.StatsController do
def utm_terms ( conn , params ) do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query , [ :bounce_rate , :visit_duration ] )
metrics = [ :visitors , :bounce_rate , :visit_duration ]
res =
Stats . breakdown ( site , query , " visit:utm_term " , metrics , pagination )
|> add_cr ( site , query , pagination , :utm_term , " visit:utm_term " )
|> transform_keys ( %{ utm_term : :name } )
if params [ " csv " ] do
@ -605,12 +658,16 @@ defmodule PlausibleWeb.Api.StatsController do
def utm_sources ( conn , params ) do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query , [ :bounce_rate , :visit_duration ] )
metrics = [ :visitors , :bounce_rate , :visit_duration ]
res =
Stats . breakdown ( site , query , " visit:utm_source " , metrics , pagination )
|> add_cr ( site , query , pagination , :utm_source , " visit:utm_source " )
|> transform_keys ( %{ utm_source : :name } )
if params [ " csv " ] do
@ -628,12 +685,16 @@ defmodule PlausibleWeb.Api.StatsController do
def referrers ( conn , params ) do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query , [ :bounce_rate , :visit_duration ] )
metrics = [ :visitors , :bounce_rate , :visit_duration ]
res =
Stats . breakdown ( site , query , " visit:referrer " , metrics , pagination )
|> add_cr ( site , query , pagination , :referrer , " visit:referrer " )
|> transform_keys ( %{ referrer : :name } )
if params [ " csv " ] do
@ -693,13 +754,12 @@ defmodule PlausibleWeb.Api.StatsController do
pagination = parse_pagination ( params )
extra_metrics =
if params [ " detailed " ] , do : [ :bounce_rate , :visit_duration ] , else : [ ]
metrics = breakdown_metrics ( query , extra_metrics )
metrics =
if params [ " detailed " ] , do : [ :visitors , :bounce_rate , :visit_duration ] , else : [ :visitors ]
referrers =
Stats . breakdown ( site , query , " visit:referrer " , metrics , pagination )
|> add_cr ( site , query , pagination , :referrer , " visit:referrer " )
|> transform_keys ( %{ referrer : :name } )
json ( conn , referrers )
@ -709,16 +769,16 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
extra_ metrics =
metrics =
if params [ " detailed " ] ,
do : [ : pageviews, :bounce_rate , :time_on_page ] ,
else : [ ]
do : [ : visitors, : pageviews, :bounce_rate , :time_on_page ] ,
else : [ :visitors ]
metrics = breakdown_metrics ( query , extra_metrics )
pagination = parse_pagination ( params )
pages =
Stats . breakdown ( site , query , " event:page " , metrics , pagination )
|> add_cr ( site , query , pagination , :page , " event:page " )
|> transform_keys ( %{ page : :name } )
if params [ " csv " ] do
@ -738,10 +798,11 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query , [ :visits , :visit_duration ] )
metrics = [ :visitors , :visits , :visit_duration ]
entry_pages =
Stats . breakdown ( site , query , " visit:entry_page " , metrics , pagination )
|> add_cr ( site , query , pagination , :entry_page , " visit:entry_page " )
|> transform_keys ( %{ entry_page : :name } )
if params [ " csv " ] do
@ -768,10 +829,11 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
{ limit , page } = parse_pagination ( params )
metrics = breakdown_metrics ( query , [ :visits ] )
metrics = [ :visitors , :visits ]
exit_pages =
Stats . breakdown ( site , query , " visit:exit_page " , metrics , { limit , page } )
|> add_cr ( site , query , { limit , page } , :exit_page , " visit:exit_page " )
|> add_exit_rate ( site , query , limit )
|> transform_keys ( %{ exit_page : :name } )
@ -827,10 +889,10 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = site |> Query . from ( params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query )
countries =
Stats . breakdown ( site , query , " visit:country " , metrics , pagination )
Stats . breakdown ( site , query , " visit:country " , [ :visitors ] , pagination )
|> add_cr ( site , query , { 300 , 1 } , :country , " visit:country " )
|> transform_keys ( %{ country : :code } )
|> add_percentages ( site , query )
@ -879,10 +941,9 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = site |> Query . from ( params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query )
regions =
Stats . breakdown ( site , query , " visit:region " , metrics , pagination )
Stats . breakdown ( site , query , " visit:region " , [ :visitors ] , pagination )
|> transform_keys ( %{ region : :code } )
|> Enum . map ( fn region ->
region_entry = Location . get_subdivision ( region [ :code ] )
@ -913,10 +974,9 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = site |> Query . from ( params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query )
cities =
Stats . breakdown ( site , query , " visit:city " , metrics , pagination )
Stats . breakdown ( site , query , " visit:city " , [ :visitors ] , pagination )
|> transform_keys ( %{ city : :code } )
|> Enum . map ( fn city ->
city_info = Location . get_city ( city [ :code ] )
@ -952,10 +1012,10 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query )
browsers =
Stats . breakdown ( site , query , " visit:browser " , metrics , pagination )
Stats . breakdown ( site , query , " visit:browser " , [ :visitors ] , pagination )
|> add_cr ( site , query , pagination , :browser , " visit:browser " )
|> transform_keys ( %{ browser : :name } )
|> add_percentages ( site , query )
@ -976,10 +1036,10 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query )
versions =
Stats . breakdown ( site , query , " visit:browser_version " , metrics , pagination )
Stats . breakdown ( site , query , " visit:browser_version " , [ :visitors ] , pagination )
|> add_cr ( site , query , pagination , :browser_version , " visit:browser_version " )
|> transform_keys ( %{ browser_version : :name } )
|> add_percentages ( site , query )
@ -1006,10 +1066,10 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query )
systems =
Stats . breakdown ( site , query , " visit:os " , metrics , pagination )
Stats . breakdown ( site , query , " visit:os " , [ :visitors ] , pagination )
|> add_cr ( site , query , pagination , :os , " visit:os " )
|> transform_keys ( %{ os : :name } )
|> add_percentages ( site , query )
@ -1030,10 +1090,10 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query )
versions =
Stats . breakdown ( site , query , " visit:os_version " , metrics , pagination )
Stats . breakdown ( site , query , " visit:os_version " , [ :visitors ] , pagination )
|> add_cr ( site , query , pagination , :os_version , " visit:os_version " )
|> transform_keys ( %{ os_version : :name } )
|> add_percentages ( site , query )
@ -1044,10 +1104,10 @@ defmodule PlausibleWeb.Api.StatsController do
site = conn . assigns [ :site ]
query = Query . from ( site , params )
pagination = parse_pagination ( params )
metrics = breakdown_metrics ( query )
sizes =
Stats . breakdown ( site , query , " visit:device " , metrics , pagination )
Stats . breakdown ( site , query , " visit:device " , [ :visitors ] , pagination )
|> add_cr ( site , query , pagination , :device , " visit:device " )
|> transform_keys ( %{ device : :name } )
|> add_percentages ( site , query )
@ -1064,6 +1124,14 @@ defmodule PlausibleWeb.Api.StatsController do
end
end
defp calculate_cr ( nil , _converted_visitors ) , do : nil
defp calculate_cr ( unique_visitors , converted_visitors ) do
if unique_visitors > 0 ,
do : Float . round ( converted_visitors / unique_visitors * 100 , 1 ) ,
else : 0.0
end
def conversions ( conn , params ) do
pagination = parse_pagination ( params )
site = Plausible.Repo . preload ( conn . assigns . site , :goals )
@ -1076,7 +1144,21 @@ defmodule PlausibleWeb.Api.StatsController do
query
end
metrics = [ :visitors , :events , :conversion_rate ] ++ @revenue_metrics
total_q = Query . remove_event_filters ( query , [ :goal , :props ] )
%{ visitors : %{ value : total_visitors } } = Stats . aggregate ( site , total_q , [ :visitors ] )
metrics =
on_full_build do
if Enum . any? ( site . goals , & Plausible.Goal.Revenue . revenue? / 1 ) and
Plausible.Billing.Feature.RevenueGoals . enabled? ( site ) do
[ :visitors , :events ] ++ @revenue_metrics
else
[ :visitors , :events ]
end
else
[ :visitors , :events ]
end
conversions =
site
@ -1084,6 +1166,7 @@ defmodule PlausibleWeb.Api.StatsController do
|> transform_keys ( %{ goal : :name } )
|> Enum . map ( fn goal ->
goal
|> Map . put ( :conversion_rate , calculate_cr ( total_visitors , goal [ :visitors ] ) )
|> Enum . map ( & format_revenue_metric / 1 )
|> Map . new ( )
end )
@ -1157,19 +1240,32 @@ defmodule PlausibleWeb.Api.StatsController do
|> Map . put ( :include_imported , false )
metrics =
if query . filters [ " event:goal " ] do
[ :visitors , :events , :conversion_rate ] ++ @revenue_metrics
else
if full_build? ( ) and Map . has_key? ( query . filters , " event:goal " ) do
[ :visitors , :events ] ++ @revenue_metrics
else
[ :visitors , :events ]
end
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 )
props =
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
total_q = Query . remove_event_filters ( query , [ :goal , :props ] )
%{ visitors : %{ value : total_unique_visitors } } = Stats . aggregate ( site , total_q , [ :visitors ] )
Enum . map ( props , fn prop ->
Map . put ( prop , :conversion_rate , calculate_cr ( total_unique_visitors , prop . visitors ) )
end )
else
props
end
end
def current_visitors ( conn , _ ) do
@ -1228,6 +1324,37 @@ defmodule PlausibleWeb.Api.StatsController do
defp add_percentages ( breakdown_result , _ , _ ) , do : breakdown_result
defp add_cr ( [ _ | _ ] = breakdown_results , site , query , pagination , key_name , filter_name )
when is_map_key ( query . filters , " event:goal " ) do
items = Enum . map ( breakdown_results , fn item -> Map . fetch! ( item , key_name ) end )
query_without_goal =
query
|> Query . put_filter ( filter_name , { :member , items } )
|> Query . remove_event_filters ( [ :goal , :props ] )
# Here, we're always only interested in the first page of results
# - the :member filter makes sure that the results always match with
# the items in the given breakdown_results list
pagination = { elem ( pagination , 0 ) , 1 }
res_without_goal =
Stats . breakdown ( site , query_without_goal , filter_name , [ :visitors ] , pagination )
Enum . map ( breakdown_results , fn item ->
without_goal =
Enum . find ( res_without_goal , fn s ->
Map . fetch! ( s , key_name ) == Map . fetch! ( item , key_name )
end )
item
|> Map . put ( :total_visitors , without_goal . visitors )
|> Map . put ( :conversion_rate , calculate_cr ( without_goal . visitors , item . visitors ) )
end )
end
defp add_cr ( breakdown_results , _ , _ , _ , _ , _ ) , do : breakdown_results
defp to_csv ( list , columns ) , do : to_csv ( list , columns , columns )
defp to_csv ( list , columns , column_names ) do
@ -1358,12 +1485,4 @@ defmodule PlausibleWeb.Api.StatsController do
{ metric , value }
end
end
defp breakdown_metrics ( query , extra_metrics \\ [ ] ) do
if query . filters [ " event:goal " ] do
[ :visitors , :conversion_rate , :total_visitors ]
else
[ :visitors ] ++ extra_metrics
end
end
end