Extension:MatomoAnalytics

Category:Extensions supporting ComposerCategory:GPL licensed extensions
MediaWiki extensions manual
MatomoAnalytics
Release status: stableCategory:Stable extensions
Implementation Special page Category:Special page extensions, User activity Category:User activity extensions
Description Integration with Matomo for analytics. Adds a special page to view that stats on-wiki.
Author(s) John Lewis, Southparkfan, Universal Omega, Agent Isai
Maintainer(s) Miraheze system administrators
Latest version continuous updates
Compatibility policy Main branch maintains backward compatibility.Category:Extensions with master compatibility policy
MediaWiki >= 1.43.0
PHP 7.2+
Database changes No, Yes if $wgMatomoAnalyticsUseDB is enabled
Composer miraheze/matomo-analytics
Virtual domain virtual-matomoanalytics
  • $wgMatomoAnalyticsEnableCustomDimensionsUserType
  • $wgMatomoAnalyticsForceGetRequest
  • $wgMatomoAnalyticsDisableCookie
  • $wgMatomoAnalyticsSiteID
  • $wgMatomoAnalyticsUseDB
  • $wgMatomoAnalyticsTokenAuth
  • $wgMatomoAnalyticsDisableJS
  • $wgMatomoAnalyticsGlobalID
  • $wgMatomoAnalyticsServerURL
  • noanalytics
  • viewanalytics
Licence GNU General Public License 3.0 or later
Download Category:Extensions in GitHub version control
Category:All extensions

The MatomoAnalytics extension inserts tracking code for the Matomo analytics platform. It also creates a Special Page (Special:Analytics) where you can view the stats on-wiki.

For reporting an issue or a bug, please use Miraheze Phabricator. See here for the workboard.

Installation

  • Download and place the file(s) in a directory called MatomoAnalytics in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'MatomoAnalytics' );
    
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

parameter default comment required?
$wgMatomoAnalyticsServerURL "" URL of your Matomo installation

It is important that the whole URL is used with protocol and trailing slash: http://example.org/

Required
$wgMatomoAnalyticsTokenAuth "" The auth token for the API of your Matomo install Required
$wgMatomoAnalyticsSiteID 1 Matomo site ID Optional
$wgMatomoAnalyticsGlobalID 0 Shared Matomo site ID. For use on wikifarms. Optional
$wgMatomoAnalyticsUseDB false Whether to use a database or not. For use on wikifarms. Optional
$wgMatomoAnalyticsForceGetRequest false Whether or not you want to force GET requests which also disables beacon. Reverts back to Matomo v3 tracking behavior. Optional
$wgMatomoAnalyticsEnableCustomDimensionsUserType false Whether to fetch userType in Matomo using CustomDimensions. You must set up CustomDimensions to be able to use this. Optional
$wgMatomoAnalyticsDisableCookie false Allow disabling cookies set by Matomo. Optional
$wgMatomoAnalyticsDisableJS false Allow disabling of JS tracking code globally Optional

Matomo API token

To obtain a Matomo API token from your Matomo installation, you can follow the official documentation:

https://matomo.org/faq/general/faq_114/

See also

Category:Web Analytics extensions Category:Statistics extensions Category:Extensions by Miraheze
Category:All extensions Category:CreateWikiCreation extensions Category:CreateWikiDeletion extensions Category:CreateWikiRename extensions Category:Extensions by Miraheze Category:Extensions in GitHub version control Category:Extensions included in Miraheze Category:Extensions supporting Composer Category:Extensions with master compatibility policy Category:GPL licensed extensions Category:InfoAction extensions Category:LoadExtensionSchemaUpdates extensions Category:SkinAfterBottomScripts extensions Category:Special page extensions Category:Stable extensions Category:Statistics extensions Category:User activity extensions Category:Web Analytics extensions