View Source Plausible.Sites (Plausible v0.0.1)

Sites context functions.

Summary

Functions

clear_stats_start_date!(site)

create(user, params)

create_shared_link(site, name, password \\ nil)

get_by_domain(domain)

get_by_domain!(domain)

get_for_user(user_id, domain, roles \\ [:owner, :admin, :viewer])

get_for_user!(user_id, domain, roles \\ [:owner, :admin, :viewer])

has_admin_access?(user_id, site)

has_goals?(site)

has_stats?(site)

is_member?(user_id, site)

list(user, pagination_params, opts \\ [])

list_with_invitations(user, pagination_params, opts \\ [])

local_start_date(site)

Returns the date of the first recorded stat in the timezone configured by the user. This function does 2 transformations: UTC %NaiveDateTime{} -> Local %DateTime{} -> Local %Date

locked?(site)

native_stats_start_date(site)

owned_site_ids(user)

owned_sites_count(user)

owned_sites_domains(user)

role(user_id, site)

set_option(user, site, option, value)

shared_link_url(site, link)

stats_start_date(site)

Returns the date of the first event of the given site, or nil if the site does not have stats yet.

toggle_pin(user, site)

Types

list_opt()

@type list_opt() :: {:filter_by_domain, String.t()}

Functions

clear_stats_start_date!(site)

@spec clear_stats_start_date!(Plausible.Site.t()) :: Plausible.Site.t()

create(user, params)

create_shared_link(site, name, password \\ nil)

get_by_domain(domain)

get_by_domain!(domain)

get_for_user(user_id, domain, roles \\ [:owner, :admin, :viewer])

get_for_user!(user_id, domain, roles \\ [:owner, :admin, :viewer])

has_admin_access?(user_id, site)

has_goals?(site)

has_stats?(site)

is_member?(user_id, site)

list(user, pagination_params, opts \\ [])

@spec list(Plausible.Auth.User.t(), map(), [list_opt()]) :: Scrivener.Page.t()

list_with_invitations(user, pagination_params, opts \\ [])

@spec list_with_invitations(Plausible.Auth.User.t(), map(), [list_opt()]) ::
  Scrivener.Page.t()

local_start_date(site)

@spec local_start_date(Plausible.Site.t()) :: Date.t() | nil

Returns the date of the first recorded stat in the timezone configured by the user. This function does 2 transformations: UTC %NaiveDateTime{} -> Local %DateTime{} -> Local %Date

Examples

iex> Plausible.Site.local_start_date(%Plausible.Site{stats_start_date: nil}) nil

iex> utc_start = ~N[2022-09-28 00:00:00] iex> tz = "Europe/Helsinki" iex> site = %Plausible.Site{stats_start_date: utc_start, timezone: tz} iex> Plausible.Site.local_start_date(site) ~D[2022-09-28]

iex> utc_start = ~N[2022-09-28 00:00:00] iex> tz = "America/Los_Angeles" iex> site = %Plausible.Site{stats_start_date: utc_start, timezone: tz} iex> Plausible.Site.local_start_date(site) ~D[2022-09-27]

locked?(site)

native_stats_start_date(site)

@spec native_stats_start_date(Plausible.Site.t()) :: Date.t() | nil

owned_site_ids(user)

owned_sites_count(user)

owned_sites_domains(user)

role(user_id, site)

set_option(user, site, option, value)

@spec set_option(Plausible.Auth.User.t(), Plausible.Site.t(), atom(), any()) ::
  Plausible.Site.UserPreference.t()

shared_link_url(site, link)

stats_start_date(site)

@spec stats_start_date(Plausible.Site.t()) :: Date.t() | nil

Returns the date of the first event of the given site, or nil if the site does not have stats yet.

If this is the first time the function is called for the site, it queries imported stats and Clickhouse, choosing the earliest start date and saves it in the sites table.

toggle_pin(user, site)

@spec toggle_pin(Plausible.Auth.User.t(), Plausible.Site.t()) ::
  {:ok, Plausible.Site.UserPreference.t()} | {:error, :too_many_pins}