Overview

Have you ever wondered, not only how many people visited a Confluence page or blog post you wrote, but also who read it when and how many times? The viewtracker plugin gives you the answers to exactly those questions, because it is more than just a simple visit-counter.

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 timeframe=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

Supplier Support

The viewtracker plugin provides supplier support for advanced reporting. Learn more about the Viewtracker supplier.

Examples

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

Only display views tracked in the last 10 days:

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

or to specify it in a different format:

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:

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

Screenshots

Viewtracker Report

Viewtracker Report{viewtracker-report}Documentation
confluence-contentHidden

Parameter

NameDescriptionTypeThis is a required fieldDefaultValues
Page
page
The page you want to display the tracked data from. Format: SPACEKEY:PAGETITLE, leave blank for current page.string
User
user
The user you want to display the tracked data from. Use this option if you want to display the tracked data of a users profile page instead of a wiki page. Use @self for current user.string
Action
action
The name of the user profile action, if its not the default "viewuserprofile" action.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 timeframe=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 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 is required!

FAQ

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

For Space Usage Reports the Reporting Plugin is required!

 How can I make the Viewtracker macro 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 Visibility plugin to display the data in read-only mode:

 How can I include the Viewtracker macro on every page?

You could add the macro to the page layout, though we don't really recommend it for larger instances cause of performance reasons.

Example to add the Viewtracker macro at the end of any page:

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

The viewtracker macro affects the performance of the page only 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:

Support