org.analytics

Classes

Plausible	Base class and registry for analytics providers.
Matomo	Base class and registry for analytics providers.
SiteimproveAnalytics	Base class and registry for analytics providers.

Module Contents

class org.analytics.Plausible(**configuration: Any)

Bases: onegov.core.analytics.AnalyticsProvider

Base class and registry for analytics providers.

template

property display_name: str

url(request: onegov.org.request.OrgRequest) → str

property script_src: str

domain(request: onegov.org.request.OrgRequest) → str

classmethod configure(*, script_src: str | None = None, title: str | None = None, **kwargs: Any) → Self | None

This function gets called with the per-provider configuration defined in onegov.yml. Analytics providers may optionally access these values.

The return value is either a provider instance, or None if the provider is not available.

template_variables(request: onegov.org.request.OrgRequest) → onegov.core.types.RenderData

Returns the necessary variables for formatting the template or None if the analytics can’t be rendered.

class org.analytics.Matomo(**configuration: Any)

Bases: onegov.core.analytics.AnalyticsProvider

Base class and registry for analytics providers.

template

property display_name: str

url(request: onegov.org.request.OrgRequest) → str

classmethod configure(*, matomo_url: str | None = None, title: str | None = None, **kwargs: Any) → Self | None

This function gets called with the per-provider configuration defined in onegov.yml. Analytics providers may optionally access these values.

The return value is either a provider instance, or None if the provider is not available.

template_variables(request: onegov.org.request.OrgRequest) → onegov.core.types.RenderData | None

Returns the necessary variables for formatting the template or None if the analytics can’t be rendered.

class org.analytics.SiteimproveAnalytics(**configuration: Any)

Bases: onegov.core.analytics.AnalyticsProvider

Base class and registry for analytics providers.

template

url(request: onegov.org.request.OrgRequest) → str

template_variables(request: onegov.org.request.OrgRequest) → onegov.core.types.RenderData | None

Returns the necessary variables for formatting the template or None if the analytics can’t be rendered.