diff --git a/assets/js/dashboard/number-formatter.js b/assets/js/dashboard/number-formatter.js index 7d76c5768..a611df2c7 100644 --- a/assets/js/dashboard/number-formatter.js +++ b/assets/js/dashboard/number-formatter.js @@ -22,3 +22,20 @@ export default function numberFormatter(num) { return num } } + +function pad(num, size) { + return ('000' + num).slice(size * -1); +} + +export function durationFormatter(duration) { + const hours = Math.floor(duration / 60 / 60) + const minutes = Math.floor(duration / 60) % 60 + const seconds = Math.floor(duration - (minutes * 60) - (hours * 60 * 60)) + if (hours > 0) { + return `${hours}h ${minutes}m ${seconds}s` + } else if (minutes > 0) { + return `${minutes}m ${pad(seconds, 2)}s` + } else { + return `${seconds}s` + } +} diff --git a/assets/js/dashboard/stats/modals/referrers.js b/assets/js/dashboard/stats/modals/referrers.js index 773045474..24249d6ef 100644 --- a/assets/js/dashboard/stats/modals/referrers.js +++ b/assets/js/dashboard/stats/modals/referrers.js @@ -4,7 +4,7 @@ import { Link, withRouter } from 'react-router-dom' import FadeIn from '../../fade-in' import Modal from './modal' import * as api from '../../api' -import numberFormatter from '../../number-formatter' +import numberFormatter, {durationFormatter} from '../../number-formatter' import {parseQuery} from '../../query' class ReferrersModal extends React.Component { @@ -21,14 +21,14 @@ class ReferrersModal extends React.Component { api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/goal/referrers`, this.state.query, {limit: 100}) .then((res) => this.setState({loading: false, referrers: res})) } else { - const include = this.showBounceRate() ? 'bounce_rate' : null + const include = this.showExtra() ? 'bounce_rate,visit_duration' : null api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/referrers`, this.state.query, {limit: 100, include: include}) .then((res) => this.setState({loading: false, referrers: res})) } } - showBounceRate() { + showExtra() { return this.state.query.period !== 'realtime' && !this.state.query.filters.goal } @@ -40,6 +40,14 @@ class ReferrersModal extends React.Component { } } + formatDuration(referrer) { + if (typeof(referrer.visit_duration) === 'number') { + return durationFormatter(referrer.visit_duration) + } else { + return '-' + } + } + renderReferrer(referrer) { return ( @@ -48,7 +56,8 @@ class ReferrersModal extends React.Component { { referrer.name } {numberFormatter(referrer.count)} - {this.showBounceRate() && {this.formatBounceRate(referrer)} } + {this.showExtra() && {this.formatBounceRate(referrer)} } + {this.showExtra() && {this.formatDuration(referrer)} } ) } @@ -74,7 +83,8 @@ class ReferrersModal extends React.Component { Referrer {this.label()} - {this.showBounceRate() && Bounce rate} + {this.showExtra() && Bounce rate} + {this.showExtra() && Visit duration} diff --git a/assets/js/dashboard/stats/visitor-graph.js b/assets/js/dashboard/stats/visitor-graph.js index b4c97d1f5..8ee3ed2aa 100644 --- a/assets/js/dashboard/stats/visitor-graph.js +++ b/assets/js/dashboard/stats/visitor-graph.js @@ -3,7 +3,7 @@ import { withRouter } from 'react-router-dom' import Chart from 'chart.js' import FadeIn from '../fade-in' import { eventName } from '../query' -import numberFormatter from '../number-formatter' +import numberFormatter, {durationFormatter} from '../number-formatter' import * as api from '../api' function mainSet(plot, present_index, ctx, label) { @@ -257,6 +257,16 @@ class LineGraph extends React.Component { } } + renderTopStatNumber(stat) { + if (stat.name === 'Visit Duration') { + return durationFormatter(stat.count) + } else if (typeof(stat.count) == 'number') { + return numberFormatter(stat.count) + } else { + return stat.percentage + '%' + } + } + renderTopStats() { const {graphData} = this.props const stats = this.props.graphData.top_stats.map((stat, index) => { @@ -267,7 +277,7 @@ class LineGraph extends React.Component {
{stat.name}
- { typeof(stat.count) == 'number' ? numberFormatter(stat.count) : stat.percentage + '%' } + { this.renderTopStatNumber(stat) } {this.renderComparison(stat.name, stat.change)}
diff --git a/lib/plausible/stats/clickhouse.ex b/lib/plausible/stats/clickhouse.ex index 5a62203cb..a9e757f1f 100644 --- a/lib/plausible/stats/clickhouse.ex +++ b/lib/plausible/stats/clickhouse.ex @@ -159,13 +159,12 @@ defmodule Plausible.Stats.Clickhouse do groups = Clickhouse.all( from e in "events", - where: e.domain == ^site.domain, - where: e.timestamp >= fragment("now() - INTERVAL 31 MINUTE"), - select: - { - fragment("dateDiff('minute', now(), ?) as relativeMinute", e.timestamp), - fragment("count(*) as pageviews") - }, + where: e.domain == ^site.domain, + where: e.timestamp >= fragment("now() - INTERVAL 31 MINUTE"), + select: { + fragment("dateDiff('minute', now(), ?) as relativeMinute", e.timestamp), + fragment("count(*) as pageviews") + }, group_by: fragment("relativeMinute"), order_by: fragment("relativeMinute") ) @@ -191,6 +190,16 @@ defmodule Plausible.Stats.Clickhouse do res["bounce_rate"] || 0 end + def visit_duration(site, query) do + [res] = + Clickhouse.all( + from s in base_session_query(site, query), + select: {fragment("round(avg(duration * sign)) as visit_duration")} + ) + + res["visit_duration"] || 0 + end + def total_pageviews(site, %Query{period: "realtime"}) do [res] = Clickhouse.all( @@ -248,49 +257,37 @@ defmodule Plausible.Stats.Clickhouse do end def top_referrers(site, query, limit, include) do - referrers = - Clickhouse.all( - from e in base_session_query(site, query), - select: - {fragment("? as name", e.referrer_source), fragment("any(?) as url", e.referrer), - fragment("uniq(user_id) as count")}, - group_by: e.referrer_source, - where: e.referrer_source != "", - order_by: [desc: fragment("count")], - limit: ^limit + q = + from(e in base_session_query(site, query), + group_by: e.referrer_source, + where: e.referrer_source != "", + order_by: [desc: fragment("count")], + limit: ^limit ) - |> Enum.map(fn ref -> - Map.update(ref, "url", nil, fn url -> url && URI.parse("http://" <> url).host end) - end) - - if "bounce_rate" in include do - bounce_rates = bounce_rates_by_referrer_source(site, query) - Enum.map(referrers, fn referrer -> - Map.put(referrer, "bounce_rate", bounce_rates[referrer["name"]]) - end) - else - referrers - end - end - - defp bounce_rates_by_referrer_source(site, query) do - {first_datetime, last_datetime} = utc_boundaries(query, site.timezone) + q = + if "bounce_rate" in include do + from( + s in q, + select: + {fragment("? as name", s.referrer_source), fragment("any(?) as url", s.referrer), + fragment("uniq(user_id) as count"), + fragment("round(sum(is_bounce * sign) / sum(sign) * 100) as bounce_rate"), + fragment("round(avg(duration * sign)) as visit_duration")} + ) + else + from( + s in q, + select: + {fragment("? as name", s.referrer_source), fragment("any(?) as url", s.referrer), + fragment("uniq(user_id) as count")} + ) + end - Clickhouse.all( - from s in "sessions", - select: - {s.referrer_source, fragment("count(*) as total"), - fragment("round(sum(is_bounce * sign) / sum(sign) * 100) as bounce_rate")}, - where: s.domain == ^site.domain, - where: s.start >= ^first_datetime and s.start < ^last_datetime, - where: s.referrer_source != "", - group_by: s.referrer_source, - order_by: [desc: fragment("total")], - limit: 100 - ) - |> Enum.map(fn row -> {row["referrer_source"], row["bounce_rate"]} end) - |> Enum.into(%{}) + Clickhouse.all(q) + |> Enum.map(fn ref -> + Map.update(ref, "url", nil, fn url -> url && URI.parse("http://" <> url).host end) + end) end def visitors_from_referrer(site, query, referrer) do @@ -404,11 +401,11 @@ defmodule Plausible.Stats.Clickhouse do def top_pages(site, %Query{period: "realtime"} = query, limit, _include) do Clickhouse.all( from s in base_session_query(site, query), - select: {fragment("? as name", s.exit_page), fragment("uniq(?) as count", s.user_id)}, - group_by: s.exit_page, - order_by: [desc: fragment("count")], - limit: ^limit - ) + select: {fragment("? as name", s.exit_page), fragment("uniq(?) as count", s.user_id)}, + group_by: s.exit_page, + order_by: [desc: fragment("count")], + limit: ^limit + ) end def top_pages(site, query, limit, include) do @@ -611,7 +608,8 @@ defmodule Plausible.Stats.Clickhouse do end defp base_session_query(site, %Query{period: "realtime"}) do - first_datetime = Timex.now(site.timezone) |> Timex.shift(minutes: -5) |> Timex.Timezone.convert("UTC") + first_datetime = + Timex.now(site.timezone) |> Timex.shift(minutes: -5) |> Timex.Timezone.convert("UTC") from(s in "sessions", where: s.domain == ^site.domain, @@ -653,13 +651,17 @@ defmodule Plausible.Stats.Clickhouse do end defp utc_boundaries(%Query{period: "30m"}, timezone) do - last_datetime = NaiveDateTime.utc_now() |> Timex.to_datetime(timezone) |> Timex.Timezone.convert("UTC") + last_datetime = + NaiveDateTime.utc_now() |> Timex.to_datetime(timezone) |> Timex.Timezone.convert("UTC") + first_datetime = last_datetime |> Timex.shift(minutes: -30) {first_datetime, last_datetime} end defp utc_boundaries(%Query{period: "realtime"}, timezone) do - last_datetime = NaiveDateTime.utc_now() |> Timex.to_datetime(timezone) |> Timex.Timezone.convert("UTC") + last_datetime = + NaiveDateTime.utc_now() |> Timex.to_datetime(timezone) |> Timex.Timezone.convert("UTC") + first_datetime = last_datetime |> Timex.shift(minutes: -5) {first_datetime, last_datetime} end diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index db3bf6afe..c57faa72b 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -79,6 +79,8 @@ defmodule PlausibleWeb.Api.StatsController do bounce_rate = Stats.bounce_rate(site, query) prev_bounce_rate = Stats.bounce_rate(site, prev_query) change_bounce_rate = if prev_bounce_rate > 0, do: bounce_rate - prev_bounce_rate + visit_duration = Stats.visit_duration(site, query) + prev_visit_duration = Stats.visit_duration(site, prev_query) [ %{ @@ -91,7 +93,8 @@ defmodule PlausibleWeb.Api.StatsController do count: pageviews, change: percent_change(prev_pageviews, pageviews) }, - %{name: "Bounce rate", percentage: bounce_rate, change: change_bounce_rate} + %{name: "Bounce rate", percentage: bounce_rate, change: change_bounce_rate}, + %{name: "Visit duration", count: visit_duration, change: percent_change(prev_visit_duration, visit_duration)} ] end diff --git a/test/plausible_web/controllers/api/stats_controller/main_graph_test.exs b/test/plausible_web/controllers/api/stats_controller/main_graph_test.exs index 783bb934a..72467e0d0 100644 --- a/test/plausible_web/controllers/api/stats_controller/main_graph_test.exs +++ b/test/plausible_web/controllers/api/stats_controller/main_graph_test.exs @@ -99,6 +99,13 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do res = json_response(conn, 200) assert %{"name" => "Bounce rate", "percentage" => 33.0, "change" => nil} in res["top_stats"] end + + test "calculates average visit duration", %{conn: conn, site: site} do + conn = get(conn, "/api/stats/#{site.domain}/main-graph?period=day&date=2019-01-01") + + res = json_response(conn, 200) + assert %{"name" => "Visit duration", "count" => 67.0, "change" => 100} in res["top_stats"] + end end describe "GET /api/stats/main-graph - filtered for goal" do diff --git a/test/plausible_web/controllers/api/stats_controller/referrers_test.exs b/test/plausible_web/controllers/api/stats_controller/referrers_test.exs index 2d086aaa4..551b26567 100644 --- a/test/plausible_web/controllers/api/stats_controller/referrers_test.exs +++ b/test/plausible_web/controllers/api/stats_controller/referrers_test.exs @@ -14,11 +14,11 @@ defmodule PlausibleWeb.Api.StatsController.ReferrersTest do ] end - test "calculates bounce rate for referrers", %{conn: conn, site: site} do + test "calculates bounce rate and visit duration for referrers", %{conn: conn, site: site} do conn = get( conn, - "/api/stats/#{site.domain}/referrers?period=day&date=2019-01-01&include=bounce_rate" + "/api/stats/#{site.domain}/referrers?period=day&date=2019-01-01&include=bounce_rate,visit_duration" ) assert json_response(conn, 200) == [ @@ -26,9 +26,10 @@ defmodule PlausibleWeb.Api.StatsController.ReferrersTest do "name" => "10words", "count" => 2, "bounce_rate" => 50.0, + "visit_duration" => 50, "url" => "10words.com" }, - %{"name" => "Bing", "count" => 1, "bounce_rate" => 0, "url" => ""} + %{"name" => "Bing", "count" => 1, "bounce_rate" => 0, "visit_duration" => 100 ,"url" => ""} ] end diff --git a/test/support/clickhouse_setup.ex b/test/support/clickhouse_setup.ex index 794e71705..113fef5d9 100644 --- a/test/support/clickhouse_setup.ex +++ b/test/support/clickhouse_setup.ex @@ -217,6 +217,7 @@ defmodule Plausible.Test.ClickhouseSetup do referrer: "10words.com/page1", session_id: @conversion_1_session_id, is_bounce: true, + duration: 100, start: ~N[2019-01-01 02:00:00] }, %{ @@ -227,6 +228,7 @@ defmodule Plausible.Test.ClickhouseSetup do referrer: "10words.com/page1", session_id: @conversion_2_session_id, is_bounce: false, + duration: 0, start: ~N[2019-01-01 02:00:00] }, %{ @@ -236,6 +238,7 @@ defmodule Plausible.Test.ClickhouseSetup do referrer_source: "Bing", referrer: "", is_bounce: false, + duration: 100, start: ~N[2019-01-01 03:00:00] }, %{