Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Allow setting sample_threshold in dashboard API queries (#2958)
RobertJoonasdafb60164ac0
diff --git a/lib/plausible/stats/base.ex b/lib/plausible/stats/base.exindex b509f440ce..3ac344cede 100644--- a/lib/plausible/stats/base.ex+++ b/lib/plausible/stats/base.ex@@ -514,7 +514,7 @@ defmodule Plausible.Stats.Base dodefp add_sample_hint(db_q, query) docase query.sample_threshold do- "infinite" ->+ :infinite ->db_qthreshold ->diff --git a/lib/plausible/stats/interval.ex b/lib/plausible/stats/interval.exindex 3ce469dd39..13735e949f 100644--- a/lib/plausible/stats/interval.ex+++ b/lib/plausible/stats/interval.ex@@ -38,6 +38,34 @@ defmodule Plausible.Stats.Interval doendend+ @doc """+ Returns the suggested interval for the given `Date.Range` struct.++ ## Examples++ iex> Plausible.Stats.Interval.default_for_date_range(Date.range(~D[2022-01-01], ~D[2023-01-01]))+ "month"++ iex> Plausible.Stats.Interval.default_for_date_range(Date.range(~D[2022-01-01], ~D[2022-01-15]))+ "date"++ iex> Plausible.Stats.Interval.default_for_date_range(Date.range(~D[2022-01-01], ~D[2022-01-01]))+ "hour"+ """++ def default_for_date_range(%Date.Range{first: first, last: last}) do+ cond do+ Timex.diff(last, first, :months) > 0 ->+ "month"++ Timex.diff(last, first, :days) > 0 ->+ "date"++ true ->+ "hour"+ end+ end+@valid_by_period %{"realtime" => ["minute"],"day" => ["minute", "hour"],diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.exindex 4dcb6401af..092178b6af 100644--- a/lib/plausible/stats/query.ex+++ b/lib/plausible/stats/query.ex@@ -13,60 +13,53 @@ defmodule Plausible.Stats.Query do@type t :: %__MODULE__{}- def from(site, %{"period" => "realtime"} = params) do+ def from(site, params) do+ query_by_period(site, params)+ |> maybe_put_interval(params)+ |> put_parsed_filters(params)+ |> put_imported_opts(site, params)+ |> put_sample_threshold(params)+ end++ defp query_by_period(site, %{"period" => "realtime"}) dodate = today(site.timezone)%__MODULE__{period: "realtime",- interval: params["interval"] || Interval.default_for_period(params["period"]),- date_range: Date.range(date, date),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(date, date)}end- def from(site, %{"period" => "day"} = params) do+ defp query_by_period(site, %{"period" => "day"} = params) dodate = parse_single_date(site.timezone, params)%__MODULE__{period: "day",- date_range: Date.range(date, date),- interval: params["interval"] || Interval.default_for_period(params["period"]),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(date, date)}- |> put_imported_opts(site, params)end- def from(site, %{"period" => "7d"} = params) do+ defp query_by_period(site, %{"period" => "7d"} = params) doend_date = parse_single_date(site.timezone, params)start_date = end_date |> Timex.shift(days: -6)%__MODULE__{period: "7d",- date_range: Date.range(start_date, end_date),- interval: params["interval"] || Interval.default_for_period(params["period"]),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(start_date, end_date)}- |> put_imported_opts(site, params)end- def from(site, %{"period" => "30d"} = params) do+ defp query_by_period(site, %{"period" => "30d"} = params) doend_date = parse_single_date(site.timezone, params)start_date = end_date |> Timex.shift(days: -30)%__MODULE__{period: "30d",- date_range: Date.range(start_date, end_date),- interval: params["interval"] || Interval.default_for_period(params["period"]),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(start_date, end_date)}- |> put_imported_opts(site, params)end- def from(site, %{"period" => "month"} = params) do+ defp query_by_period(site, %{"period" => "month"} = params) dodate = parse_single_date(site.timezone, params)start_date = Timex.beginning_of_month(date)@@ -74,15 +67,11 @@ defmodule Plausible.Stats.Query do%__MODULE__{period: "month",- date_range: Date.range(start_date, end_date),- interval: params["interval"] || Interval.default_for_period(params["period"]),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(start_date, end_date)}- |> put_imported_opts(site, params)end- def from(site, %{"period" => "6mo"} = params) do+ defp query_by_period(site, %{"period" => "6mo"} = params) doend_date =parse_single_date(site.timezone, params)|> Timex.end_of_month()@@ -93,15 +82,11 @@ defmodule Plausible.Stats.Query do%__MODULE__{period: "6mo",- date_range: Date.range(start_date, end_date),- interval: params["interval"] || Interval.default_for_period(params["period"]),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(start_date, end_date)}- |> put_imported_opts(site, params)end- def from(site, %{"period" => "12mo"} = params) do+ defp query_by_period(site, %{"period" => "12mo"} = params) doend_date =parse_single_date(site.timezone, params)|> Timex.end_of_month()@@ -112,15 +97,11 @@ defmodule Plausible.Stats.Query do%__MODULE__{period: "12mo",- date_range: Date.range(start_date, end_date),- interval: params["interval"] || Interval.default_for_period(params["period"]),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(start_date, end_date)}- |> put_imported_opts(site, params)end- def from(site, %{"period" => "year"} = params) do+ defp query_by_period(site, %{"period" => "year"} = params) doend_date =parse_single_date(site.timezone, params)|> Timex.end_of_year()@@ -129,76 +110,67 @@ defmodule Plausible.Stats.Query do%__MODULE__{period: "year",- date_range: Date.range(start_date, end_date),- interval: params["interval"] || Interval.default_for_period(params["period"]),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(start_date, end_date)}- |> put_imported_opts(site, params)end- def from(site, %{"period" => "all"} = params) do+ defp query_by_period(site, %{"period" => "all"}) donow = today(site.timezone)start_date = Plausible.Site.local_start_date(site) || now- cond do- Timex.diff(now, start_date, :months) > 0 ->- from(- site,- Map.merge(params, %{- "period" => "custom",- "from" => Date.to_iso8601(start_date),- "to" => Date.to_iso8601(now),- "interval" => params["interval"] || "month"- })- )- |> Map.put(:period, "all")-- Timex.diff(now, start_date, :days) > 0 ->- from(- site,- Map.merge(params, %{- "period" => "custom",- "from" => Date.to_iso8601(start_date),- "to" => Date.to_iso8601(now),- "interval" => params["interval"] || "date"- })- )- |> Map.put(:period, "all")-- true ->- from(site, Map.merge(params, %{"period" => "day", "date" => "today"}))- |> Map.put(:period, "all")- end+ date_range = Date.range(start_date, now)++ %__MODULE__{+ period: "all",+ date_range: date_range,+ interval: Interval.default_for_date_range(date_range)+ }end- def from(site, %{"period" => "custom", "from" => from, "to" => to} = params) do+ defp query_by_period(site, %{"period" => "custom", "from" => from, "to" => to} = params) donew_params =params- |> Map.delete("from")- |> Map.delete("to")+ |> Map.drop(["from", "to"])|> Map.put("date", Enum.join([from, to], ","))- from(site, new_params)+ query_by_period(site, new_params)end- def from(site, %{"period" => "custom", "date" => date} = params) do+ defp query_by_period(_site, %{"period" => "custom", "date" => date}) do[from, to] = String.split(date, ",")from_date = Date.from_iso8601!(String.trim(from))to_date = Date.from_iso8601!(String.trim(to))%__MODULE__{period: "custom",- date_range: Date.range(from_date, to_date),- interval: params["interval"] || Interval.default_for_period(params["period"]),- filters: FilterParser.parse_filters(params["filters"]),- sample_threshold: Map.get(params, "sample_threshold", @default_sample_threshold)+ date_range: Date.range(from_date, to_date)}- |> put_imported_opts(site, params)end- def from(tz, params) do- __MODULE__.from(tz, Map.merge(params, %{"period" => "30d"}))+ defp query_by_period(site, params) do+ query_by_period(site, Map.merge(params, %{"period" => "30d"}))+ end++ defp maybe_put_interval(%{interval: nil} = query, params) do+ interval = Map.get(params, "interval", Interval.default_for_period(query.period))+ Map.put(query, :interval, interval)+ end++ defp maybe_put_interval(query, _), do: query++ defp put_parsed_filters(query, params) do+ Map.put(query, :filters, FilterParser.parse_filters(params["filters"]))+ end++ defp put_sample_threshold(query, params) do+ sample_threshold =+ case params["sample_threshold"] do+ nil -> @default_sample_threshold+ "infinite" -> :infinite+ value -> String.to_integer(value)+ end++ Map.put(query, :sample_threshold, sample_threshold)enddef put_filter(query, key, val) do@@ -244,7 +216,7 @@ defmodule Plausible.Stats.Query docase params["date"] do"today" -> Timex.now(tz) |> Timex.to_date()date when is_binary(date) -> Date.from_iso8601!(date)- _ -> Timex.now(tz) |> Timex.to_date()+ _ -> today(tz)endenddiff --git a/test/plausible/stats/query_test.exs b/test/plausible/stats/query_test.exsindex 0233501bc9..c7401ca81b 100644--- a/test/plausible/stats/query_test.exs+++ b/test/plausible/stats/query_test.exs@@ -142,6 +142,16 @@ defmodule Plausible.Stats.QueryTest doassert q.interval == "date"end+ test "adds sample_threshold :infinite to query struct" do+ q = Query.from(@site, %{"period" => "30d", "sample_threshold" => "infinite"})+ assert q.sample_threshold == :infinite+ end++ test "casts sample_threshold to integer in query struct" do+ q = Query.from(@site, %{"period" => "30d", "sample_threshold" => "30000000"})+ assert q.sample_threshold == 30_000_000+ end+describe "filters" dotest "parses goal filter" dofilters = Jason.encode!(%{"goal" => "Signup"})