Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

APIv2: More tolerant shorthands for date ranges (#5282)

Karl-Aksel Puulmann3d1d0c5139b5
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a6497c8da5..ee43468a30 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -49,6 +49,7 @@ All notable changes to this project will be documented in this file.
- Remove permissions to manage sites guests and run destructive actions from team editor and guest editor roles in favour of team admin role
- Time-on-page metric has been reworked. It now uses `engagement` events sent by plausible tracker script. We still use the old calculation methods for periods before the self-hosted instance was upgraded. Warnings are shown in the dashboard and API when legacy calculation methods are used.
- Always set site and team member limits to unlimited for Community Edition
+- Stats API now supports more `date_range` shorthand options like `30d`, `3mo`.
### Fixed
diff --git a/assets/js/types/query-api.d.ts b/assets/js/types/query-api.d.ts
index d9bf0ee646..d73fa18153 100644
--- a/assets/js/types/query-api.d.ts
+++ b/assets/js/types/query-api.d.ts
@@ -28,7 +28,8 @@ export type DateRangeShorthand =
| "month"
| "6mo"
| "12mo"
- | "year";
+ | "year"
+ | string;
/**
* @minItems 2
* @maxItems 2
diff --git a/lib/plausible/stats/filters/query_parser.ex b/lib/plausible/stats/filters/query_parser.ex
index d499ff3feb..2fdf6b0149 100644
--- a/lib/plausible/stats/filters/query_parser.ex
+++ b/lib/plausible/stats/filters/query_parser.ex
@@ -225,42 +225,12 @@ defmodule Plausible.Stats.Filters.QueryParser do
{:ok, DateTimeRange.new!(date, date, site.timezone)}
end
- defp parse_time_range(site, shorthand, date, _now)
- when shorthand in ["7d", "28d", "30d", "90d"] do
- {days, "d"} = Integer.parse(shorthand)
- last = date |> Date.add(-1)
- first = date |> Date.add(-days)
- {:ok, DateTimeRange.new!(first, last, site.timezone)}
- end
-
defp parse_time_range(site, "month", date, _now) do
last = date |> Date.end_of_month()
first = last |> Date.beginning_of_month()
{:ok, DateTimeRange.new!(first, last, site.timezone)}
end
- defp parse_time_range(site, "6mo", date, _now) do
- last = date |> Date.end_of_month()
-
- first =
- last
- |> Date.shift(month: -5)
- |> Date.beginning_of_month()
-
- {:ok, DateTimeRange.new!(first, last, site.timezone)}
- end
-
- defp parse_time_range(site, "12mo", date, _now) do
- last = date |> Date.end_of_month()
-
- first =
- last
- |> Date.shift(month: -11)
- |> Date.beginning_of_month()
-
- {:ok, DateTimeRange.new!(first, last, site.timezone)}
- end
-
defp parse_time_range(site, "year", date, _now) do
last = date |> Timex.end_of_year()
first = last |> Timex.beginning_of_year()
@@ -273,6 +243,23 @@ defmodule Plausible.Stats.Filters.QueryParser do
{:ok, DateTimeRange.new!(start_date, date, site.timezone)}
end
+ defp parse_time_range(site, shorthand, date, _now) when is_binary(shorthand) do
+ case Integer.parse(shorthand) do
+ {n, "d"} when n > 0 and n <= 5_000 ->
+ last = date |> Date.add(-1)
+ first = date |> Date.add(-n)
+ {:ok, DateTimeRange.new!(first, last, site.timezone)}
+
+ {n, "mo"} when n > 0 and n <= 100 ->
+ last = date |> Date.end_of_month()
+ first = last |> Date.shift(month: -n + 1) |> Date.beginning_of_month()
+ {:ok, DateTimeRange.new!(first, last, site.timezone)}
+
+ _ ->
+ {:error, "Invalid date_range #{i(shorthand)}"}
+ end
+ end
+
defp parse_time_range(site, [from, to], _date, _now) when is_binary(from) and is_binary(to) do
case date_range_from_date_strings(site, from, to) do
{:ok, date_range} -> {:ok, date_range}
@@ -281,7 +268,7 @@ defmodule Plausible.Stats.Filters.QueryParser do
end
defp parse_time_range(_site, unknown, _date, _now),
- do: {:error, "Invalid date_range '#{i(unknown)}'."}
+ do: {:error, "Invalid date_range #{i(unknown)}"}
defp date_range_from_date_strings(site, from, to) do
with {:ok, from_date} <- Date.from_iso8601(from),
diff --git a/priv/json-schemas/query-api-schema.json b/priv/json-schemas/query-api-schema.json
index a9601a7f63..f0ce373b04 100644
--- a/priv/json-schemas/query-api-schema.json
+++ b/priv/json-schemas/query-api-schema.json
@@ -171,7 +171,7 @@
]
},
"date_range_shorthand": {
- "oneOf": [
+ "anyOf": [
{
"const": "30m",
"$comment": "only :internal"
@@ -219,6 +219,16 @@
{
"const": "year",
"description": "Since the start of this year"
+ },
+ {
+ "type": "string",
+ "pattern": "^\\d+d$",
+ "description": "Last n days relative to today"
+ },
+ {
+ "type": "string",
+ "pattern": "^\\d+mo$",
+ "description": "Last n months relative to this month"
}
]
},
diff --git a/test/plausible/stats/query_parser_test.exs b/test/plausible/stats/query_parser_test.exs
index 8c3f9affed..ca32279020 100644
--- a/test/plausible/stats/query_parser_test.exs
+++ b/test/plausible/stats/query_parser_test.exs
@@ -27,6 +27,10 @@ defmodule Plausible.Stats.Filters.QueryParserTest do
first: DateTime.new!(~D[2021-04-28], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-04], ~T[23:59:59], "Etc/UTC")
}
+ @date_range_10d %DateTimeRange{
+ first: DateTime.new!(~D[2021-04-25], ~T[00:00:00], "Etc/UTC"),
+ last: DateTime.new!(~D[2021-05-04], ~T[23:59:59], "Etc/UTC")
+ }
@date_range_30d %DateTimeRange{
first: DateTime.new!(~D[2021-04-05], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-04], ~T[23:59:59], "Etc/UTC")
@@ -35,6 +39,10 @@ defmodule Plausible.Stats.Filters.QueryParserTest do
first: DateTime.new!(~D[2021-05-01], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-31], ~T[23:59:59], "Etc/UTC")
}
+ @date_range_3mo %DateTimeRange{
+ first: DateTime.new!(~D[2021-03-01], ~T[00:00:00], "Etc/UTC"),
+ last: DateTime.new!(~D[2021-05-31], ~T[23:59:59], "Etc/UTC")
+ }
@date_range_6mo %DateTimeRange{
first: DateTime.new!(~D[2020-12-01], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-31], ~T[23:59:59], "Etc/UTC")
@@ -1255,8 +1263,10 @@ defmodule Plausible.Stats.Filters.QueryParserTest do
test "parsing shortcut options", %{site: site} do
check_date_range(%{"date_range" => "day"}, site, @date_range_day)
check_date_range(%{"date_range" => "7d"}, site, @date_range_7d)
+ check_date_range(%{"date_range" => "10d"}, site, @date_range_10d)
check_date_range(%{"date_range" => "30d"}, site, @date_range_30d)
check_date_range(%{"date_range" => "month"}, site, @date_range_month)
+ check_date_range(%{"date_range" => "3mo"}, site, @date_range_3mo)
check_date_range(%{"date_range" => "6mo"}, site, @date_range_6mo)
check_date_range(%{"date_range" => "12mo"}, site, @date_range_12mo)
check_date_range(%{"date_range" => "year"}, site, @date_range_year)
@@ -1323,11 +1333,17 @@ defmodule Plausible.Stats.Filters.QueryParserTest do
end
test "parsing invalid custom date range with invalid dates", %{site: site} do
+ %{"site_id" => site.domain, "date_range" => "-1d", "metrics" => ["visitors"]}
+ |> check_error(site, "#/date_range: Invalid date range \"-1d\"")
+
%{"site_id" => site.domain, "date_range" => "foo", "metrics" => ["visitors"]}
|> check_error(site, "#/date_range: Invalid date range \"foo\"")
%{"site_id" => site.domain, "date_range" => ["21415-00", "eee"], "metrics" => ["visitors"]}
|> check_error(site, "#/date_range: Invalid date range [\"21415-00\", \"eee\"]")
+
+ %{"site_id" => site.domain, "date_range" => "999999999mo", "metrics" => ["visitors"]}
+ |> check_error(site, "Invalid date_range \"999999999mo\"")
end
test "custom date range is invalid when timestamps do not include timezone info", %{
@@ -1374,8 +1390,10 @@ defmodule Plausible.Stats.Filters.QueryParserTest do
for {date_range_shortcut, expected_date_range} <- [
{"day", @date_range_day},
{"7d", @date_range_7d},
+ {"10d", @date_range_10d},
{"30d", @date_range_30d},
{"month", @date_range_month},
+ {"3mo", @date_range_3mo},
{"6mo", @date_range_6mo},
{"12mo", @date_range_12mo},
{"year", @date_range_year}