Table of Contents

Children


Changes in Version 4.0:

 

Overview

Gain valuable insight into who is visiting your Confluence pages. The Viewtracker add-on provides more information than just counting page hits. It provides important user behaviour details, of who has viewed which Confluence pages, and how often the page has been visited.

Viewtracker Macro

Use the Viewtracker macro to track page views per users.

Viewtracker{viewtracker}
confluence-content

Parameter

NameDescriptionTypeThis is a required fieldDefaultValues
Hide
hide
Allows you to hide the tracked resultsbooleanfalse
Expandable
expandable
Enables the expansion of the listbooleantrue
Render User Names
renderusernames
Enables the creation of links to user profile pages in the list. Disable for better performance.booleantrue
Sort
sort
Sorts the list by date or nameenumdatedate, name
Time frame
timeframe
Specifies the time frame for displaying the tracked data. The time frame can either be a specific date or the number of days (for example 12would display all views tracked in the last twelve days). By default all tracked views are displayed.string
Date format
dateformat
Define the format of the date specified in timeframe, if it is in a different format than the default Confluence format defined in the formatting/international settings. Specify a format that matches the simple date format.string

Supplier Support

Examples

Simply place the Viewtracker macro on a Confluence page or blog post and your counter is ready to go:

{viewtracker}

Only display views tracked in the last 10 days:

{viewtracker:timeframe=10}

Only display views tracked after 01/01/2000 (if MM/dd/yyyy is your default format in Confluence):

{viewtracker:timeframe=01/01/2000}

or to specify it in a different format:

{viewtracker:timeframe=01.01.2000|dateformat=dd.MM.yyyy}

Screenshots

Recently Viewed Macro

Recently Viewed Pages{recently-viewed}
Displays pages you have recently visited in Confluence. This history is also available in the Recently Viewed content view from the "User" dropdown.
confluence-content

Parameter

NameDescriptionTypeThis is a required fieldDefaultValues
Hide header
hideHeader
Allows you to hide the header of the table.booleanfalse
Maximum number of results
maxResults
The maximum number of results to display.int20

Examples

Displays pages you have recently visited in Confluence:

{recently-viewed}

Only display the last 5 pages visited and hide the header of the table:

{recently-viewed:maxResults=8|hideHeader=true}

Screenshots

Viewtracker Report

Viewtracker Report{viewtracker-report}Documentation
confluence-content

Parameter

NameDescriptionTypeThis is a required fieldDefaultValues
Expandable
expandable
The report is closed by default and can be expanded.booleanfalse
Page
page
The page you want to display the tracked data from. Format: SPACEKEY:PAGETITLE, leave blank for current page.string
Render User Names
renderusernames
Enables the creation of links to user profile pages in the list. Disable for better performance.booleantrue
Sort
sort
Sorts the list by date or nameenumdatedate, name
Time frame
timeframe
Specifies the time frame for displaying the tracked data. The time frame can either be a specific date or the number of days (for example 12 would display all views tracked in the last twelve days). By default all tracked views are displayed.string
Date format
dateformat
Define the format of the date specified in timeframe, if it is in a different format than the default Confluence format defined in the formatting/international settings. Specify a format that matches the simple date format.string

Configuration

In the configuration of the Viewtracker plugin, which is in the Administration Console, you can configure the blocking time option and enable/disable space usage reports:

  1. In the add-on management section in the administration console of Confluence, select the Viewtracker plugin and click on "Configure":
     
  2. Configure the Viewtracker plugin:
     

Blocking Time

The blocking time (ms) defines the time period in between the Viewtracker macro doesn’t track multiple views per user for the same page.

Space Usage Reports

Space Usage Reports is an optional feature and can be enabled to show up in Space Administration. Feel free to override the default template with your custom report. For Space Usage Reports the Reporting Plugin and Viewtracker Supplier Add-on is required!

FAQ

 Space usage reports don't work. How can I make them work?

For Space Usage Reports the ServiceRocket Reporting Plugin and the Viewtracker Supplier is required!

 How can I make a Viewtracker report only visible to administrators?

You could hide the output of the main Viewtracker macro and use the undocumented Viewtracker-Report macro in combination with the free ServiceRocket Visibility plugin to display the data in read-only mode:

{viewtracker:hide=true}
{show-if:group=confluence-administrators}
{viewtracker-report}
{show-if}
 How can I include the Viewtracker macro on every page?

You can add the macro to the page layout. This is an example to add the Viewtracker macro at the end of any page:

...
<div id="main-content" class="wiki-content">
    $body
    $helper.renderConfluenceMacro("{viewtracker}")
</div>
...
 How does the Viewtracker add-on store page view data?

You can find a description of the datastructure here: Viewtracker Datastructure

 How does the Viewtracker macro affect the performance of the Confluence page?

The viewtracker macro up to Version 3.2.2 affects the performance of the page if it has a large number of unique (registered) visitors (mainly in large Confluence installations). However, if you experience performance problems, just disable the rendering of the links to the user profile pages:

{viewtracker:renderusernames=false}

In Version 4.0 we rewrote a large part of the add-on so that the performance is much better, especially on large instances.

 After the Upgrade to Viewtracker 4.0.0 all my stats are lost

In Version 4.0 we rewrote a large part of the add-on so that the performance is much better, especially on large instances. So the old data will be migrated to the new Viewtracker Datastructure.

  • Only valid users will be migrated. Old views, where the user can't be found anymore aren't migrated.
  • If the Viewtracker macro is working well and just the Reports of the Space Usage are missing, please verify that you have installed the required dependencies for this optional feature: 

 Why is Viewtracker now a paid add-on?

bitvoodoo was founded in 2008. We offer many free add-ons, as well as some paid add-ons and a complete range of services, from system installation and configuration to support, training and custom development.

The Viewtracker add-on was first listed in the Atlassian Marketplace in 2010. One of our main goals is to produce high quality software, which in our understanding, means that our add-ons are always compatible with the latest version of the Atlassian software they were developed for, and are, for example, compliant with the Atlassian User Interface Guidelines. This constantly generates maintenance work. To provide this service in the future, we have now decided to change the Viewtracker add-on from a free plan to a paid one, at a very reasonable price. We are confident that all of our loyal customers will understand this move.

We've also invested much time and rewrote a large part of the add-on. All installations will benefit from increased performance with Viewtracker 4, but especially users with large Confluence instances will see a big difference.

 

 

Related articles

Support

 

Known errors and Feature requests

Comments  (0)

Attachments  (6)

Add Attachment
  File Modified
PNG File viewtracker-screenshot-2.png 03. Mar. 2014 by Remo Siegwart
PNG File viewtracker-screenshot-1.png 03. Mar. 2014 by Remo Siegwart
PNG File viewtracker-screenshot-3.png 03. Mar. 2014 by Remo Siegwart
PNG File viewtracker-plugin-config-2.png 03. Mar. 2014 by Remo Siegwart
PNG File viewtracker-plugin-config-1.png 03. Mar. 2014 by Remo Siegwart
PNG File viewtracker-logo.png 03. Mar. 2014 by Remo Siegwart