View Source Plausible.Plugins.API.Funnels (Plausible v0.0.1)

Plugins API context module for Funnels. All high level Funnel operations should be implemented here.

Summary

Types

create_request()

Functions

create(site, create_request)
get(site, by)
get_funnels(site, params)

Types

Link to this type

create_request()

View Source 
@type create_request() :: PlausibleWeb.Plugins.API.Schemas.Funnel.CreateRequest.t()

Functions

Link to this function

create(site, create_request)

View Source 
@spec create(
  Plausible.Site.t(),
  create_request()
) ::
  {:ok, Plausible.Funnel.t()}
  | {:error, Ecto.Changeset.t()}
  | {:error, :upgrade_required}
Link to this function

get(site, by)

View Source 
@spec get(Plausible.Site.t(), pos_integer() | String.t()) ::
  nil | Plausible.Funnel.t()
Link to this function

get_funnels(site, params)

View Source 
@spec get_funnels(Plausible.Site.t(), map()) :: {:ok, Paginator.Page.t()}