Add comparison values and dates to top stats API

jsx-conditional-rendering
Vinicius Brasil 4 years ago
parent b8e3a469ec
commit 80a7396e86

@ -208,7 +208,11 @@ defmodule PlausibleWeb.Api.StatsController do
interval: query.interval,
sample_percent: sample_percent,
with_imported: query.include_imported,
imported_source: site.imported_data && site.imported_data.source
imported_source: site.imported_data && site.imported_data.source,
comparing_from: comparison_query && comparison_query.date_range.first,
comparing_to: comparison_query && comparison_query.date_range.last,
from: query.date_range.first,
to: query.date_range.last
})
else
{:error, message} when is_binary(message) -> bad_request(conn, message)
@ -360,21 +364,25 @@ defmodule PlausibleWeb.Api.StatsController do
%{
name: "Unique visitors",
value: unique_visitors,
comparison_value: prev_unique_visitors,
change: percent_change(prev_unique_visitors, unique_visitors)
},
%{
name: "Unique conversions",
value: converted_visitors,
comparison_value: prev_converted_visitors,
change: percent_change(prev_converted_visitors, converted_visitors)
},
%{
name: "Total conversions",
value: completions,
comparison_value: prev_completions,
change: percent_change(prev_completions, completions)
},
%{
name: "Conversion rate",
value: conversion_rate,
comparison_value: prev_conversion_rate,
change: percent_change(prev_conversion_rate, conversion_rate)
}
]
@ -430,7 +438,7 @@ defmodule PlausibleWeb.Api.StatsController do
prev_value = get_in(prev_results, [key, :value])
change = prev_value && calculate_change(key, prev_value, value)
%{name: name, value: value, change: change}
%{name: name, value: value, comparison_value: prev_value, change: change}
end
end

@ -16,7 +16,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=day")
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "value" => 2, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 2
} in res["top_stats"]
end
test "counts total pageviews", %{conn: conn, site: site} do
@ -29,7 +35,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=day")
res = json_response(conn, 200)
assert %{"name" => "Total pageviews", "value" => 3, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Total pageviews",
"value" => 3
} in res["top_stats"]
end
test "counts total visits", %{conn: conn, site: site} do
@ -43,7 +55,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=day&date=2021-01-01")
res = json_response(conn, 200)
assert %{"name" => "Total visits", "value" => 3, "change" => 100} in res["top_stats"]
assert %{"change" => 100, "comparison_value" => 0, "name" => "Total visits", "value" => 3} in res[
"top_stats"
]
end
test "counts pages per visit", %{conn: conn, site: site} do
@ -57,7 +72,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=day&date=2021-01-01")
res = json_response(conn, 200)
assert %{"name" => "Views per visit", "value" => 1.33, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0.0,
"name" => "Views per visit",
"value" => 1.33
} in res["top_stats"]
end
test "calculates bounce rate", %{conn: conn, site: site} do
@ -70,7 +91,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=day")
res = json_response(conn, 200)
assert %{"name" => "Bounce rate", "value" => 50, "change" => nil} in res["top_stats"]
assert %{"change" => nil, "comparison_value" => 0, "name" => "Bounce rate", "value" => 50} in res[
"top_stats"
]
end
test "calculates average visit duration", %{conn: conn, site: site} do
@ -91,7 +115,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=day&date=2021-01-01")
res = json_response(conn, 200)
assert %{"name" => "Visit duration", "value" => 450, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Visit duration",
"value" => 450
} in res["top_stats"]
end
test "calculates time on page instead when filtered for page", %{conn: conn, site: site} do
@ -121,7 +151,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Time on page", "value" => 900, "change" => 100} in res["top_stats"]
assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 900} in res[
"top_stats"
]
end
test "calculates time on page when filtered for multiple pages", %{
@ -159,7 +192,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Time on page", "value" => 480, "change" => 100} in res["top_stats"]
assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 480} in res[
"top_stats"
]
end
test "calculates time on page when filtered for multiple negated pages", %{
@ -197,7 +233,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Time on page", "value" => 60, "change" => 100} in res["top_stats"]
assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 60} in res[
"top_stats"
]
end
test "calculates time on page when filtered for multiple wildcard pages", %{
@ -236,7 +275,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Time on page", "value" => 480, "change" => 100} in res["top_stats"]
assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 480} in res[
"top_stats"
]
end
test "calculates time on page when filtered for multiple negated wildcard pages", %{
@ -277,7 +319,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Time on page", "value" => 600, "change" => 100} in res["top_stats"]
assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 600} in res[
"top_stats"
]
end
end
@ -312,12 +357,42 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
res = json_response(conn, 200)
assert res["top_stats"] == [
%{"name" => "Unique visitors", "value" => 3, "change" => 100},
%{"name" => "Total visits", "value" => 3, "change" => 100},
%{"name" => "Total pageviews", "value" => 4, "change" => 100},
%{"name" => "Views per visit", "value" => 1.5, "change" => 100},
%{"name" => "Bounce rate", "value" => 33, "change" => nil},
%{"name" => "Visit duration", "value" => 303, "change" => 100}
%{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 3
},
%{
"change" => 100,
"comparison_value" => 0,
"name" => "Total visits",
"value" => 3
},
%{
"change" => 100,
"comparison_value" => 0,
"name" => "Total pageviews",
"value" => 4
},
%{
"change" => 100,
"comparison_value" => 0.0,
"name" => "Views per visit",
"value" => 1.5
},
%{
"change" => nil,
"comparison_value" => 0,
"name" => "Bounce rate",
"value" => 33
},
%{
"change" => 100,
"comparison_value" => 0,
"name" => "Visit duration",
"value" => 303
}
]
end
end
@ -422,7 +497,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "value" => 2, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 2
} in res["top_stats"]
end
test "page glob filter", %{conn: conn, site: site} do
@ -441,7 +522,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "value" => 2, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 2
} in res["top_stats"]
end
test "contains (~) filter", %{conn: conn, site: site} do
@ -460,7 +547,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "value" => 2, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 2
} in res["top_stats"]
end
test "returns only visitors with specific screen size", %{conn: conn, site: site} do
@ -479,7 +572,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "value" => 2, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 2
} in res["top_stats"]
end
test "returns only visitors with specific browser", %{conn: conn, site: site} do
@ -498,7 +597,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "value" => 2, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 2
} in res["top_stats"]
end
test "returns only visitors with specific operating system", %{conn: conn, site: site} do
@ -517,7 +622,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "value" => 2, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 2
} in res["top_stats"]
end
test "returns number of visits from one specific referral source", %{conn: conn, site: site} do
@ -549,7 +660,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Total visits", "value" => 2, "change" => 100} in res["top_stats"]
assert %{"change" => 100, "comparison_value" => 0, "name" => "Total visits", "value" => 2} in res[
"top_stats"
]
end
end
@ -573,7 +687,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "value" => 3, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique visitors",
"value" => 3
} in res["top_stats"]
end
test "returns converted visitors", %{conn: conn, site: site} do
@ -593,7 +713,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique conversions", "value" => 1, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0,
"name" => "Unique conversions",
"value" => 1
} in res["top_stats"]
end
test "returns conversion rate", %{conn: conn, site: site} do
@ -614,7 +740,12 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
res = json_response(conn, 200)
assert %{"name" => "Conversion rate", "value" => 33.3, "change" => 100} in res["top_stats"]
assert %{
"change" => 100,
"comparison_value" => 0.0,
"name" => "Conversion rate",
"value" => 33.3
} in res["top_stats"]
end
test "returns conversion rate with change=nil when comparison mode disallowed", %{
@ -638,7 +769,83 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
res = json_response(conn, 200)
assert %{"name" => "Conversion rate", "value" => 33.3, "change" => nil} in res["top_stats"]
assert %{
"change" => nil,
"comparison_value" => nil,
"name" => "Conversion rate",
"value" => 33.3
} in res["top_stats"]
end
end
describe "GET /api/stats/top-stats - with comparisons" do
setup [:create_user, :log_in, :create_new_site]
test "defaults to previous period when comparison is not set", %{site: site, conn: conn} do
populate_stats(site, [
build(:pageview, timestamp: ~N[2020-12-31 00:00:00]),
build(:pageview, timestamp: ~N[2020-12-31 00:00:00]),
build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, timestamp: ~N[2021-01-01 00:01:00]),
build(:pageview, timestamp: ~N[2021-01-01 10:00:00])
])
conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=day&date=2021-01-01")
res = json_response(conn, 200)
assert %{"change" => 50, "comparison_value" => 2, "name" => "Total visits", "value" => 3} in res[
"top_stats"
]
end
test "returns comparison data when mode is custom", %{site: site, conn: conn} do
populate_stats(site, [
build(:pageview, timestamp: ~N[2020-01-01 00:00:00]),
build(:pageview, timestamp: ~N[2020-01-05 00:00:00]),
build(:pageview, timestamp: ~N[2020-01-20 00:00:00]),
build(:pageview, timestamp: ~N[2020-12-31 00:00:00]),
build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, timestamp: ~N[2021-01-01 00:01:00]),
build(:pageview, timestamp: ~N[2021-01-01 10:00:00])
])
conn =
get(
conn,
"/api/stats/#{site.domain}/top-stats?period=day&date=2021-01-01&comparison=custom&compare_from=2020-01-01&compare_to=2020-01-20"
)
res = json_response(conn, 200)
assert %{"change" => 0, "comparison_value" => 3, "name" => "Total visits", "value" => 3} in res[
"top_stats"
]
end
test "returns source query and comparison query date range", %{site: site, conn: conn} do
populate_stats(site, [
build(:pageview, timestamp: ~N[2020-01-01 00:00:00]),
build(:pageview, timestamp: ~N[2020-01-05 00:00:00]),
build(:pageview, timestamp: ~N[2020-01-20 00:00:00]),
build(:pageview, timestamp: ~N[2020-12-31 00:00:00]),
build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, timestamp: ~N[2021-01-01 00:01:00]),
build(:pageview, timestamp: ~N[2021-01-01 10:00:00])
])
conn =
get(
conn,
"/api/stats/#{site.domain}/top-stats?period=month&date=2021-01-01&comparison=previous_period"
)
assert %{
"comparing_from" => "2020-12-01",
"comparing_to" => "2020-12-31",
"from" => "2021-01-01",
"to" => "2021-01-31"
} = json_response(conn, 200)
end
end
end

Loading…
Cancel
Save