[WIP] Dashboard breakdowns v2

lib/plausible/stats/api_query_parser.ex

@@ -325,11 +325,11 @@ defmodule Plausible.Stats.ApiQueryParser do
   defp parse_include_entry(key, _value),
     do: {:error, %QueryError{code: :invalid_include, message: "Invalid include key'#{i(key)}'."}}
 
-  defp parse_pagination(pagination) when is_map(pagination) do
+  def parse_pagination(pagination) when is_map(pagination) do
     {:ok, Map.merge(@default_pagination, atomize_keys(pagination))}
   end
 
-  defp parse_pagination(nil), do: {:ok, @default_pagination}
+  def parse_pagination(nil), do: {:ok, @default_pagination}
 
   defp atomize_keys(map) when is_map(map) do
     Map.new(map, fn {key, value} ->

lib/plausible/stats/dashboard/query_parser.ex

@@ -20,6 +20,8 @@ defmodule Plausible.Stats.Dashboard.QueryParser do
          {:ok, dimensions} <- ApiQueryParser.parse_dimensions(params["dimensions"]),
          {:ok, filters} <- ApiQueryParser.parse_filters(params["filters"]),
          {:ok, metrics} <- parse_metrics(params),
+         {:ok, order_by} <- ApiQueryParser.parse_order_by(params["order_by"]),
+         {:ok, pagination} <- ApiQueryParser.parse_pagination(params["pagination"]),
          {:ok, include} <- parse_include(params) do
       {:ok,
        ParsedQueryParams.new!(%{
@@ -28,6 +30,8 @@ defmodule Plausible.Stats.Dashboard.QueryParser do
          dimensions: dimensions,
          filters: filters,
          metrics: metrics,
+         order_by: order_by,
+         pagination: pagination,
          include: include,
          skip_goal_existence_check: true,
          now: Keyword.get(opts, :now)

lib/plausible/stats/metrics.ex

@@ -17,6 +17,7 @@ defmodule Plausible.Stats.Metrics do
                  :visit_duration,
                  :events,
                  :conversion_rate,
+                 :total_visitors,
                  :group_conversion_rate,
                  :time_on_page,
                  :percentage,

test/plausible/stats/query/query_parse_and_build_test.exs

@@ -88,6 +88,19 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do
       assert error =~ "Invalid metric"
     end
 
+    test "public API does not recognize total_visitors metric", %{site: site} do
+      params = %{
+        "site_id" => site.domain,
+        "metrics" => ["total_visitors"],
+        "date_range" => "all"
+      }
+
+      assert {:error, %QueryError{message: error}} =
+               Query.parse_and_build(site, params, now: @now)
+
+      assert error =~ "Invalid metric"
+    end
+
     test "valid metrics passed", %{site: site} do
       params = %{
         "site_id" => site.domain,