Mailster Matomo

Description

Mailster Matomo connects the Mailster Newsletter Plugin for WordPress to Matomo so you can attribute newsletter clicks to campaigns in your analytics reports.

When a subscriber clicks a same-site link in a Mailster campaign, the add-on appends Matomo-compatible campaign query arguments (pk_campaign and pk_kwd) to the click redirect URL. Matomo still accepts these legacy pk_* names for campaign reporting (alongside newer mtm_* parameters).

This plugin requires Mailster and a Matomo property (Site ID and tracker domain). It is not affiliated with Matomo or the Piwik PRO brand. For click attribution to appear in reports, your destination pages still need Matomo tracking installed on the website.

What it does

  • Appends pk_campaign and pk_kwd to same-site Mailster click redirects (exact host match with your WordPress site_url host)
  • Lets you set default campaign name and keyword patterns, including merge tags for campaign, subscriber, and link data
  • Optionally overrides those values per campaign via a Matomo Analytics metabox when Campaign based value is enabled
  • Stores Site ID, tracker domain, and optional setDomains for the embedded tracker snippet
  • Outputs the Matomo JavaScript tracker (piwik.js / piwik.php) in the Mailster campaign web version footer when Site ID and domain are set

What it does not do

  • It does not tag external (off-site) links — only redirects whose host matches your site host
  • It does not switch to Matomo’s newer mtm_* parameter names (it always writes pk_campaign / pk_kwd)
  • It does not add an email open-tracking pixel; Mailster and Matomo handle opens separately if you configure them
  • The embedded script is not a full-site Matomo install — it only loads on the Mailster campaign web version page

Merge tags you can use

Use these placeholders in the campaign name and keyword fields:

%%CAMP_ID%%, `%%CAMP_TITLE%%`, `%%CAMP_TYPE%%`, `%%CAMP_LINK%%`, `%%SUBSCRIBER_ID%%`, `%%SUBSCRIBER_EMAIL%%`, `%%SUBSCRIBER_HASH%%`, `%%LINK%%`
  • %%CAMP_TYPE%% resolves to autoresponder or regular based on the campaign status
  • Defaults on the settings screen are %%CAMP_TITLE%% for the campaign name and %%LINK%% for the keyword until you change them

Avoid putting personally identifiable merge tags (such as %%SUBSCRIBER_EMAIL%%) into public URLs unless you intend that data to appear in query strings and analytics.

Screenshots

Installation

  1. Install and activate the Mailster Newsletter Plugin for WordPress.
  2. Upload the entire mailster-piwik folder to /wp-content/plugins/, or install Mailster Matomo from Plugins Add New.
  3. Activate Mailster Matomo.
  4. Open Newsletter Settings Matomo and enter your analytics Site ID and domain (the host that serves the tracker; this add-on loads piwik.js and posts to piwik.php on that host).
  5. Adjust the default campaign name and keyword patterns if needed. Optionally enable Campaign based value to edit them on each campaign screen.
  6. Ensure Matomo tracking is present on the pages users land on after clicking newsletter links.
  7. Send a campaign (or click through a tracked link) and confirm same-site destinations include pk_campaign / pk_kwd, then check campaign reports in Matomo.

FAQ

What does the plugin require?

An active Mailster install and a Matomo property (Site ID plus the domain where the tracker is hosted). Your site pages need Matomo tracking so campaign parameters on landing URLs are recorded.

Does this work with Matomo?

Yes. Campaign attribution uses pk_campaign and pk_kwd, which Matomo still accepts for backwards compatibility. This add-on does not output Matomo’s newer mtm_* parameter names.

Where do I configure it in Mailster?

Go to Newsletter Settings and open the Matomo tab. That matches Mailster’s Newsletter menu and Settings submenu.

Are external (off-site) links tagged?

No. Only click redirects whose host exactly matches your WordPress site URL host receive the campaign parameters. Links to other domains (and hosts that differ, such as a bare domain vs www) are left unchanged. Unlike some other Mailster analytics add-ons, there is no option to tag external domains.

Can I set different tracking values per campaign?

Yes. Enable Campaign based value on the Matomo settings tab. A Matomo Analytics metabox appears on the campaign edit screen so you can override the campaign name and keyword for that newsletter. Fields are read-only for finished/active campaigns (and autoresponder stats views).

What is the optional JavaScript tracker for?

When Site ID and domain are set, the add-on prints a classic Matomo _paq snippet (including optional setDomains) on the Mailster campaign web version page via Mailster’s mailster_wpfooter hook. It loads piwik.js and uses piwik.php as the tracker endpoint on the domain you entered. It does not replace installing Matomo on your main website.

Does this track newsletter opens?

No. This add-on only adds campaign parameters on click redirects. Open tracking is separate (Mailster’s own open tracking, and/or a Matomo email tracking pixel if you add one yourself).

Where is subscriber or click data sent?

Campaign parameters are added to links on your site. If you configure Site ID and domain, the campaign web version page can send analytics hits to the Matomo hostname you enter. Use only a tracker endpoint you control or trust. Merge-tag values you put in pk_campaign / pk_kwd may appear in URLs and thus in analytics logs.

Reviews

There are no reviews for this plugin.

Contributors & Developers

“Mailster Matomo” is open source software. The following people have contributed to this plugin.

Contributors

Translate “Mailster Matomo” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.1.0

  • Rename plugin branding and UI labels from Piwik to Matomo (slugs and option keys unchanged).

1.0.0

  • initial release