View Source Plausible.Stats.Query (Plausible v0.0.1)

@type t() :: %Plausible.Stats.Query{
  date_range: term(),
  dimensions: term(),
  experimental_reduced_joins?: term(),
  filters: term(),
  include: term(),
  include_imported: term(),
  interval: term(),
  latest_import_end_date: term(),
  legacy_breakdown: term(),
  metrics: term(),
  now: term(),
  order_by: term(),
  period: term(),
  preloaded_goals: term(),
  sample_threshold: term(),
  skip_imported_reason: term(),
  timezone: term(),
  v2: term()
}

Functions

add_filter(query, filter)

build(site, params)

ensure_include_imported(query, requested?)

@spec ensure_include_imported(t(), boolean()) ::
  :ok
  | {:error,
     :no_imported_data | :out_of_range | :unsupported_query | :not_requested}

from(site, params)

@spec from(Plausible.Site.t(), map()) :: t()

Builds query from old-style params. New code should prefer Query.build

get_filter(query, name)

get_filter_by_prefix(query, prefix)

has_event_filters?(query)

put_experimental_reduced_joins(query, site, params)

put_imported_opts(query, site, params)

remove_filters(query, prefixes)

set(query, keywords)

trace(query, metrics)

@spec trace(
  %Plausible.Stats.Query{
    date_range: term(),
    dimensions: term(),
    experimental_reduced_joins?: term(),
    filters: term(),
    include: term(),
    include_imported: term(),
    interval: term(),
    latest_import_end_date: term(),
    legacy_breakdown: term(),
    metrics: term(),
    now: term(),
    order_by: term(),
    period: term(),
    preloaded_goals: term(),
    sample_threshold: term(),
    skip_imported_reason: term(),
    timezone: term(),
    v2: term()
  },
  [atom()]
) :: %Plausible.Stats.Query{
  date_range: term(),
  dimensions: term(),
  experimental_reduced_joins?: term(),
  filters: term(),
  include: term(),
  include_imported: term(),
  interval: term(),
  latest_import_end_date: term(),
  legacy_breakdown: term(),
  metrics: term(),
  now: term(),
  order_by: term(),
  period: term(),
  preloaded_goals: term(),
  sample_threshold: term(),
  skip_imported_reason: term(),
  timezone: term(),
  v2: term()
}