Matomo

This content is for v0.2.1. Switch to the latest version for up-to-date documentation.

Overview

v0.1.0 introduced analytics goals. v0.2.0 added Tag Manager variables, triggers, tags, and declarative publication. v0.2.1 is a patch that fixes structured Matomo variable parameter decoding so unmanaged structured parameters do not block planning managed Data Layer variables.

Source: providers/matomo/README.md at v0.2.1.

Supported capabilities

matomo.goal, matomo.variable (Data Layer), matomo.trigger (Custom Event), matomo.tag (Matomo Analytics event), $ref dependencies, and declarative publication.

Prerequisites

A Matomo instance, site ID, and — for Tag Manager — an existing container plus a Matomo Configuration variable before managing matomo.tag.

Authentication / setup

Environment variables only. v0.2.1 does not load .agoraform.env.

Environment variables

MATOMO_URL            required
MATOMO_TOKEN_AUTH     required
MATOMO_SITE_ID        required for site resources
MATOMO_CONTAINER_ID   required for Tag Manager

Supported resources

`matomo.goal`

- address: matomo.goal.trial_started
  attributes:
    name: Trial Started
    matchAttribute: event_action
    pattern: trialStarted

Optional patternType: contains (default), exact, or regex. name is immutable once bound.

`matomo.variable`

- address: matomo.variable.user_id
  attributes:
    type: dataLayer
    key: userId
    name: User ID

`matomo.trigger`

- address: matomo.trigger.trial_started
  attributes:
    type: customEvent
    event: trialStarted

`matomo.tag`

- address: matomo.tag.trial_started
  attributes:
    type: matomoAnalytics
    trigger:
      $ref: matomo.trigger.trial_started
    eventCategory: trial
    eventAction: started

eventCategory / eventAction (required) and eventName / eventValue (optional) may be literals or supported variable $refs.

Example manifest

See the quick start.

Known limitations

Matomo is the only provider
One container via MATOMO_CONTAINER_ID
Data Layer / Custom Event / Matomo Analytics event tag only
MatomoConfiguration is not a managed resource
No agoraform publish command; publication is declarative
No destroy, remote state, rollback, or scheduled publication