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

Collection of functions to work with intervals.

The interval of a query defines the granularity of the data. You can think of it as a GROUP BY clause. Possible values are minute, hour, date, week, and month.

Summary

Types

opt()

opts()

t()

Functions

default_for_date_range(range)

Returns the suggested interval for the given Date.Range struct.

default_for_period(period)

Returns the suggested interval for the given time period.

list()

valid?(interval)

valid_by_period(opts \\ [])

valid_for_period?(period, interval, opts \\ [])

Returns whether the given interval is valid for a time period.

Types

opt()

@type opt() :: {:site, Plausible.Site.t()} | {:from, Date.t()}

opts()

@type opts() :: [opt()]

t()

@type t() :: String.t()

Functions

default_for_date_range(range)

@spec default_for_date_range(Date.Range.t()) :: t()

Returns the suggested interval for the given Date.Range struct.

default_for_period(period)

@spec default_for_period(period()) :: t()

Returns the suggested interval for the given time period.

list()

@spec list() :: [t()]

valid?(interval)

@spec valid?(term()) :: boolean()

valid_by_period(opts \\ [])

@spec valid_by_period(opts()) :: map()

valid_for_period?(period, interval, opts \\ [])

@spec valid_for_period?(period(), t(), opts()) :: boolean()

Returns whether the given interval is valid for a time period.

Intervals longer than periods are not supported, e.g. current month stats with a month interval, or today stats with a week interval.

There are two dynamic states:

custom period is only applicable with month or week intervals, if the opts[:from] and opts[:to] range difference exceeds 12 months
all period's interval options depend on particular site's stats_start_date
- daily interval is excluded if the all-time range exceeds 12 months