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

Summary

Types

t()

Functions

add_filter(query, filter)

build(site, schema_type, params, debug_metadata)

date_range(query, options \\ [])

ensure_include_imported(query, requested?)

from(site, params, debug_metadata \\ %{}, now \\ nil)

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

put_imported_opts(query, site, params)

remove_top_level_filters(query, prefixes)

Removes top level filters matching any of passed prefix from the query.

set(query, keywords)

set_include(query, key, value)

trace(query, metrics)

Types

t()

@type t() :: %Plausible.Stats.Query{
  debug_metadata: term(),
  dimensions: 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(),
  pagination: term(),
  period: term(),
  preloaded_goals: term(),
  remove_unavailable_revenue_metrics: term(),
  revenue_currencies: term(),
  sample_threshold: term(),
  skip_imported_reason: term(),
  timezone: term(),
  utc_time_range: term()
}

Functions

add_filter(query, filter)

build(site, schema_type, params, debug_metadata)

date_range(query, options \\ [])

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, debug_metadata \\ %{}, now \\ nil)

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

put_imported_opts(query, site, params)

remove_top_level_filters(query, prefixes)

Removes top level filters matching any of passed prefix from the query.

Note that this doesn't handle cases with AND/OR/NOT and as such is discouraged from use.

set(query, keywords)

set_include(query, key, value)

trace(query, metrics)

@spec trace(
  %Plausible.Stats.Query{
    debug_metadata: term(),
    dimensions: 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(),
    pagination: term(),
    period: term(),
    preloaded_goals: term(),
    remove_unavailable_revenue_metrics: term(),
    revenue_currencies: term(),
    sample_threshold: term(),
    skip_imported_reason: term(),
    timezone: term(),
    utc_time_range: term()
  },
  [atom()]
) :: %Plausible.Stats.Query{
  debug_metadata: term(),
  dimensions: 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(),
  pagination: term(),
  period: term(),
  preloaded_goals: term(),
  remove_unavailable_revenue_metrics: term(),
  revenue_currencies: term(),
  sample_threshold: term(),
  skip_imported_reason: term(),
  timezone: term(),
  utc_time_range: term()
}