DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:googleanalytics

Google Analytics for DokuWiki

Compatible with DokuWiki

  • 2024-02-06 "Kaos" unknown
  • 2023-04-04 "Jack Jackrum" unknown
  • 2022-07-31 "Igor" unknown
  • 2020-07-29 "Hogfather" yes

plugin This tool allows you to set a code for use with Google Analytics, which allows you to track your visitors.

Last updated on
2020-11-03
Provides
Action
Repository
Source

This plugin allows you to track visits to your wiki in Google Analytics.

Download

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Setup

This plugin generates JavaScript code that is automatically included into your site via the lib/exe/js.php file. (Which you can inspect via your browser's “developer tools.”)

Set the options for this plugin via the Configuration Settings menu from the DokuWiki admin menu. (It will be near the bottom of the page.)

You may use one of two tracking options:

  • Basic “Google Analytics ID” (also known as “analytics.js”) using a UA-XXXXXX-XX code
  • Newer “Global Site Tag ID” (also known as “gtag.js”) using a G-XXXXXXXXXX code

If you set a “Global Site Tag ID”, then this method will be used and any “Google Analytics ID” / UA-XXXXXXX-XX specific settings will be ignored.

Tag Setup

To properly use this plugin you will need to set up and configure a Google Analytics property.

Google Analytics ID Method

Sign into https://analytics.google.com and create a new property:

Now follow the steps below. There are also screenshots available to help you find your way through the menus.

At the end of the setup process you should get a Tracking Code. You can also find it under AdminPropertyTracking InfoTracking Code. The code starts with UA followed by a large number and a shorter number separated by dashes (UA-XXXXXX-XX).

Next, setup the custom dimensions. Go to AdminPropertyCustom DefinitionsCustom Dimensions. There create two new custom dimensions:

  1. Name: wiki-action
    • Scope: Hit
    • Index: 1
    • Active: yes
  2. Name: wiki-id
    • Scope: Hit
    • Index: 2
    • Active: yes

Be sure the indexes are correct!

Next, if you want to track logged in users across different devices, you have to enable the User ID tracking feature and create a new view. To do so go to AdminPropertyTracking InfoUser-ID and follow the wizard. Please not that this step is completely optional. It may have repercussions on your privacy policies. Be sure to read the documentation provided by Google.

Finally go to AdminView and select the view you want to use1). Then pick View Settings. Enable Site Search Tracking, enter q as Query parameter and tick the Strip query parameters out of URL checkbox.

Global Site ID Method

TODO: Write me

DokuWiki Setup

Once you have finished your Setup at Google Analytics, you can configure DokuWiki. Install the plugin via the extension manager, then go the configuration and use the config options to configure the plugin for your account.

You have to fill in at least your Tracking Code!

If you enabled User ID tracking in the Google Analytics above, you can enable it here as well.

Usage

Once configured, your Google Analytics should begin to show data after a day or two. Please refer to Google Analytics Help for info on general usage.

Developer Info

Once configured, the plugin makes Google's ga() method available globally. You can use it to log additional events from your JavaScript.

if(window.ga) window.ga('send', 'event', ...);

Please refer to Googles documentation on details.

1)
If you set up User ID tracking above, you probably want to repeat this step for both views. Otherwise there's only one
plugin/googleanalytics.txt · Last modified: 2020-11-03 10:40 by tjgrant@tatewake.com

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki