Plausible
Plausible
v0.0.1

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

Plugins API context module for Goals. All high level Goal operations should be implemented here.

Summary

Types

create_request()

Functions

create(site, goal_or_goals)
get(site, id)
get_goals(site, params)

Types

Link to this type

create_request()

View Source 
@type create_request() ::
  PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.CustomEvent.t()
  | PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Revenue.t()
  | PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Pageview.t()

Functions

Link to this function

create(site, goal_or_goals)

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

get(site, id)

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

get_goals(site, params)

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