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
APIv2: Use `Query.build` over `Query.from` in more cases (#5699)
Karl-Aksel Puulmannbf24ae0cd20d
diff --git a/extra/lib/plausible_web/live/funnel_settings/form.ex b/extra/lib/plausible_web/live/funnel_settings/form.exindex a9b0dabdec..045ab27e44 100644--- a/extra/lib/plausible_web/live/funnel_settings/form.ex+++ b/extra/lib/plausible_web/live/funnel_settings/form.ex@@ -347,7 +347,18 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form dosteps)- query = Plausible.Stats.Query.from(site, %{"period" => "month"})+ {:ok, query} =+ Plausible.Stats.Query.build(+ site,+ :internal,+ %{+ "site_id" => site.domain,+ "date_range" => "month",+ "metrics" => ["pageviews"]+ },+ %{}+ )+{:ok, {definition, query}}enddiff --git a/lib/plausible/stats/breakdown.ex b/lib/plausible/stats/breakdown.exindex b87eee2a21..2b0334b014 100644--- a/lib/plausible/stats/breakdown.ex+++ b/lib/plausible/stats/breakdown.ex@@ -8,7 +8,7 @@ defmodule Plausible.Stats.Breakdown douse Plausible.ClickhouseRepouse Plausible.Stats.SQL.Fragments- alias Plausible.Stats.{Query, QueryRunner, QueryResult, QueryOptimizer, Comparisons}+ alias Plausible.Stats.{Query, QueryRunner, QueryResult, Comparisons}def breakdown(site,@@ -35,7 +35,6 @@ defmodule Plausible.Stats.Breakdown dolegacy_breakdown: true,remove_unavailable_revenue_metrics: true)- |> QueryOptimizer.optimize()%QueryResult{results: results, meta: meta} = QueryRunner.run(site, query_with_metrics)diff --git a/lib/plausible/stats/goal_suggestions.ex b/lib/plausible/stats/goal_suggestions.exindex 4747e1753c..9f089915a3 100644--- a/lib/plausible/stats/goal_suggestions.ex+++ b/lib/plausible/stats/goal_suggestions.ex@@ -40,14 +40,18 @@ defmodule Plausible.Stats.GoalSuggestions doto_date = Date.utc_today()from_date = Date.shift(to_date, month: -6)- params = %{- "with_imported" => "true",- "period" => "custom",- "from" => Date.to_iso8601(from_date),- "to" => Date.to_iso8601(to_date)- }-- query = Query.from(site, params)+ {:ok, query} =+ Plausible.Stats.Query.build(+ site,+ :internal,+ %{+ "site_id" => site.domain,+ "date_range" => [Date.to_iso8601(from_date), Date.to_iso8601(to_date)],+ "metrics" => ["pageviews"],+ "include" => %{"imports" => true}+ },+ %{}+ )native_q =from(e in base_event_query(query),diff --git a/lib/plausible/stats/legacy/legacy_query_builder.ex b/lib/plausible/stats/legacy/legacy_query_builder.exindex f7579ada83..72b33082f9 100644--- a/lib/plausible/stats/legacy/legacy_query_builder.ex+++ b/lib/plausible/stats/legacy/legacy_query_builder.ex@@ -1,6 +1,8 @@defmodule Plausible.Stats.Legacy.QueryBuilder do@moduledoc """- Module used to parse URL search params to a valid Query, used to power the API for the dashboard.+ Module used to parse URL search params to a valid Query, used to power the API for the dashboard+ and v1 of our Stats API.+@deprecated"""diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.exindex f33a19f848..7b7a343c78 100644--- a/lib/plausible/stats/query.ex+++ b/lib/plausible/stats/query.ex@@ -57,7 +57,7 @@ defmodule Plausible.Stats.Query doend@doc """- Builds query from old-style params. New code should prefer Query.build+ Builds query from old-style stats APIv1 params. New code should use `Query.build`."""def from(site, params, debug_metadata \\ %{}, now \\ nil) doLegacy.QueryBuilder.from(site, params, debug_metadata, now)diff --git a/lib/plausible/stats/timeseries.ex b/lib/plausible/stats/timeseries.exindex 2dcbd5a434..380d448f50 100644--- a/lib/plausible/stats/timeseries.ex+++ b/lib/plausible/stats/timeseries.ex@@ -7,7 +7,7 @@ defmodule Plausible.Stats.Timeseries douse Plausibleuse Plausible.ClickhouseRepo- alias Plausible.Stats.{Comparisons, Query, QueryRunner, QueryOptimizer, Metrics, Time}+ alias Plausible.Stats.{Comparisons, Query, QueryRunner, Metrics, Time}@time_dimension %{"month" => "time:month",@@ -26,7 +26,6 @@ defmodule Plausible.Stats.Timeseries doorder_by: [{time_dimension(query), :asc}],remove_unavailable_revenue_metrics: true)- |> QueryOptimizer.optimize()comparison_query =if(query.include.comparisons,diff --git a/lib/plausible_web/live/goal_settings/form.ex b/lib/plausible_web/live/goal_settings/form.exindex 33bd58ec22..ff8a05e09a 100644--- a/lib/plausible_web/live/goal_settings/form.ex+++ b/lib/plausible_web/live/goal_settings/form.ex@@ -553,7 +553,18 @@ defmodule PlausibleWeb.Live.GoalSettings.Form doenddef suggest_page_paths(input, site) do- query = Plausible.Stats.Query.from(site, %{"with_imported" => "true", "period" => "all"})+ {:ok, query} =+ Plausible.Stats.Query.build(+ site,+ :internal,+ %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["pageviews"],+ "include" => %{"imports" => true}+ },+ %{}+ )site|> Plausible.Stats.filter_suggestions(query, "page", input)diff --git a/lib/plausible_web/live/shields/hostname_rules.ex b/lib/plausible_web/live/shields/hostname_rules.exindex e3c158de7f..610e06b05e 100644--- a/lib/plausible_web/live/shields/hostname_rules.ex+++ b/lib/plausible_web/live/shields/hostname_rules.ex@@ -227,7 +227,17 @@ defmodule PlausibleWeb.Live.Shields.HostnameRules doenddef suggest_hostnames(input, _options, site) do- query = Plausible.Stats.Query.from(site, %{})+ {:ok, query} =+ Plausible.Stats.Query.build(+ site,+ :internal,+ %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["pageviews"]+ },+ %{}+ )site|> Plausible.Stats.filter_suggestions(query, "hostname", input)diff --git a/lib/plausible_web/live/shields/page_rules.ex b/lib/plausible_web/live/shields/page_rules.exindex b85e7a46ad..026c68727d 100644--- a/lib/plausible_web/live/shields/page_rules.ex+++ b/lib/plausible_web/live/shields/page_rules.ex@@ -220,14 +220,18 @@ defmodule PlausibleWeb.Live.Shields.PageRules doenddef suggest_page_paths(input, _options, site, page_rules) do- query =- site- |> Plausible.Stats.Query.from(%{})- |> Plausible.Stats.Query.add_filter([- :is_not,- "event:page",- Enum.map(page_rules, & &1.page_path)- ])+ {:ok, query} =+ Plausible.Stats.Query.build(+ site,+ :internal,+ %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["pageviews"],+ "filters" => [["is_not", "event:page", Enum.map(page_rules, & &1.page_path)]]+ },+ %{}+ )site|> Plausible.Stats.filter_suggestions(query, "page", input)diff --git a/lib/workers/traffic_change_notifier.ex b/lib/workers/traffic_change_notifier.exindex 02f93d18a1..8e2719034f 100644--- a/lib/workers/traffic_change_notifier.ex+++ b/lib/workers/traffic_change_notifier.ex@@ -119,37 +119,46 @@ defmodule Plausible.Workers.TrafficChangeNotifier doenddefp get_traffic_spike_stats(site) do+ %{}+ |> put_sources(site)+ |> put_pages(site)+ end++ @base_query_params %{+ "metrics" => ["visitors"],+ "pagination" => %{"limit" => 3},+ "date_range" => "realtime"+ }++ defp put_sources(stats, site) do{:ok, query} =Query.build(site,:internal,- %{- "site_id" => "#{site.id}",- "metrics" => ["visitors"],- "pagination" => %{"limit" => 3},- "date_range" => "realtime"- },+ Map.merge(@base_query_params, %{+ "site_id" => site.domain,+ "dimensions" => ["visit:source"],+ "filters" => [["is_not", "visit:source", ["Direct / None"]]]+ }),%{})- %{}- |> put_sources(site, query)- |> put_pages(site, query)- end-- defp put_sources(stats, site, query) do- query =- query- |> Query.set(dimensions: ["visit:source"])- |> Query.add_filter([:is_not, "visit:source", ["Direct / None"]])-%{results: sources} = Plausible.Stats.query(site, query)Map.put(stats, :sources, sources)end- defp put_pages(stats, site, query) do- query = Query.set(query, dimensions: ["event:page"])+ defp put_pages(stats, site) do+ {:ok, query} =+ Query.build(+ site,+ :internal,+ Map.merge(@base_query_params, %{+ "site_id" => site.domain,+ "dimensions" => ["event:page"]+ }),+ %{}+ )%{results: pages} = Plausible.Stats.query(site, query)