Viewtracker - Analytics for Confluence
Space shortcuts
Skip to end of metadata
Go to start of metadata

Please note:

We do not offer support for custom configured Space Usage Reports. 

On this page:

Space Usage Report with Reporting Plugin

For the optional feature Space Usage Reports the Viewtracker Supplier and ServiceRocket Reporting for Confluence are required.

 

Please note:

  • The features described below require the apps Reporting for Confluence (min. version 6.0) and Viewtracker (min. version 4.0).
  • Please be aware Reporting for Confluence by ServiceRocket is not free.
  • bitvoodoo will not be able to support you with questions regarding the Reporting for Confluence. Please contact the ServiceRocket support instead.


Enable Custom Space Reports

To enable the Custom Space Reports, you need to activate them in the administration of Viewtracker (Activate Custom Space Usage Reports).


Compatibility Matrix


Viewtracker versionViewtracker Supplier versionReporting for Confluence versionNotes

all versions before 3.0 ( 2.2.0)

built in to Viewtrackerall versions before 4.0 ( 3.4.2)

Last free version of the Reporting plugin, this old version can be downloaded here: VIEWTRACKER-20 - Getting issue details... STATUS

3.0built in to Viewtrackerall versions before 6.0 ( 5.8.1)
4.0.0 to 4.2.41.0≥ 6.0
4.3.1 to 5.0.1No compatible version
5.0.22.0≥ 6.0

Introduction Reporting Plugin

→ Documentation

Overview

Report Frames

MacroDescriptionExample
report-blockWill display the report results in a series of blocks.
{report-block}
  {xxx-reporter}
 
  {report-body}
  This content is repeated for each item.
  {report-body}
 
  {report-empty}This is displayed if no results are returned by the reporter.{report-empty}
{report-block}
report-tableDisplays each item of a reporter as a table row.
{report-table}
  {xxx-reporter}
 
  {report-column:title=Key 1}{report-info:item:key 1}{report-column}
  {report-column:title=Key 2}{report-info:item:key 2}{report-column}
 
  {report-empty}This is displayed if no results are returned by the reporter.{report-empty}
{report-table}
report-listDisplays each item of reporter as a list item.
{report-list:depth=[1,2...all]|outline=true/false|style=[disc, decimal, etc]}
  {xxx-reporter}
 
  {report-body}
  This content is repeated for each item.
  {report-body}
 
  {report-empty}This is displayed if no results are returned by the reporter.{report-empty}
{report-list}

Reporters

list non exhaustive


MacroDescriptionExample
content-reporter

Reports on Confluence content (pages, news, comments, attachments, etc).

The content can be filtered by space, type, scope or labels, as well as any custom filters specified in the body of the macro.

List the 5 most recent blogposts from all spaces:

{report-block:maxResults=5}
  {content-reporter:spaces=@all|types=news}
    {date-sort:content:modification date|order=descending}
  {content-reporter}
 
  {report-body}
    {report-info:content:title|link=true}
    {report-info:content:excerpt|render=wiki}
    Posted on {report-info:modification date|format=EEEE, MMMM d, yyyy} by {report-info:content:modifier|link=true}
  {report-body}
 
  {report-empty}No news items are available.{report-empty}
{report-block}

local-reporter

Allows reporting on the current page or reported item.

This reporter will display the contents of any sub-item of either the current item or that specified by the source parameter, identified using the prefix:key value.

Listing attachments from current page:

{report-table}
  {local-reporter:content:attachments}
    {text-sort:attachment:title}
  {local-reporter}
 
  {report-column:title=File Name}{report-info:attachment:title|link=true}{report-column}
  {report-column:title=Comment}{report-info:attachment:comment}{report-column}
  {report-column:title=Size}{report-info:attachment:nice file size}{report-column}
 
  {report-empty}_No files have been attached to this page._{report-empty}
{report-table}

expanding-reporter

This is a reporter which can expand on a items returned from another, contained reporter.

This reporter will expand on a list of sub-items in the original report.

Output the children of the current page who have comments, as well as the the first 50 characters of each comment, in reverse date order:

{report-table}
  {expanding-reporter:content:all comments|as=comment}
    {local-reporter:content:children}
    {text-sort:comment:page > content:title}
    {date-sort:content:creation date|order=descending}
  {expanding-reporter}
 
  {report-column:title=Page}{report-info:expanded:item > content:title|link=true}{report-column}
  {report-column:title=Comment Summary}{report-info:expanded:comment > content:body > text:first 50|render=wiki}{report-column}
{report-table}

grouping-reporter

Allows results of another reporter to be grouped by any keychain value in each item.

This reporter provides group-by and statistical analysis capabilities for reports. It processes the results of the contained reporter and performs grouping and (optionally) statistical analysis with the companion grouping-stats macro.

Number of blogposts grouped by creator:

{report-table}
  {grouping-reporter:content:creator|as=Creator}
    {content-reporter:space=@all|type=news}
      {text-sort:content:creator > user:name}
    {content-reporter}
  {grouping-reporter}

  {report-column:title=User Name}{report-info:grouped:Creator}{report-column}
  {report-column:title=# of news items created}{report-info:grouped:@items > collection:size|format=#,##0}{report-column}
 
  {report-empty}_No blogs posted by anyone_{report-empty}
{report-table}

Sorters

list non exhaustive

MacroDescriptionExample
date-sortThis will sort the results by the specified date key value.

Views absteigend sortieren:

{date-sort:viewdate|order=descending}
text-sortThis will sort the results by the specified text key value.

Views nach Benutzername aufsteigend sortieren:

{text-sort:username}

Filters

list non exhaustive

MacroDescriptionViews
user-filter

Filters out results based on a user property. Users can be filtered by a combination of specific user names, group membership and space permissions.

Alle getrackten Views ausser von User "admin":

{user-filter:username|users=-admin}
number-filterThis filter will ensure that the specified  prefix:key  value is a number, and that it matches the required criteria.

Nur Seiten mit getrackten Views auflisten:

{number-filter:viewtracker:totalviews|required=true}
date-filterThis filter will ensure that the specified  prefix:key  value is a date, and that it matches the required criteria.

Alle Views seit 1.Okt 2010:

{date-filter:viewdate|minValue=1-Oct-2010|format=dd-MMM-yyyy}

Suppliers

list non exhaustive

Introduction Viewtracker Supplier

→ Documentation

Viewtracker Supplier

Details

NameViewtracker Supplier
Prefixviewtracker (required)
Supported contentPages, Blog Posts, Spaces, Users
Provided byViewtracker Plugin from version 1.1.0

Keys Supported

KeyContent TypesReturn TypeDescription
allAnyList  of ViewsReturns the list of all views.
totalviewsAnyTextReturns the total number of views.
totalusersAnyTextReturns the total number of users.
allusersAnyTextAll users: can be rendered afterwards

View Supplier

Details

NameView Supplier
Prefixview (optional)
Supported contentTracked Views
Provided byViewtracker Plugin from version 1.1.0

Keys Supported

KeyContent TypesReturn TypeDescription
usernameTracked ViewTextReturns the username.
viewdateTracked ViewDateReturns the date of the last view.
viewcountTracked ViewNumberReturns the total number of views by this user


Report Examples

Report of all pages in a space and display the name of the page, total views, total users and a list of all users

Code

{report-table}
  {content-reporter:types=page}{content-reporter}

  {report-column:title=Page}{report-info:title|link=true}{report-column}
  {report-column:title=Total Views}{report-info:viewtracker:totalviews}{report-column}
  {report-column:title=Total Users}{report-info:viewtracker:totalusers}{report-column}
  {report-column:title=Users List}{report-info:viewtracker:allusers|render=wiki}{report-column}
{report-table}

Result

Show the last 5 pageviews of all children

Code

{report-table:maxResults=5}
  {expanding-reporter:viewtracker:all|as=view}
    {local-reporter:page:children}
    {date-sort:viewdate|order=descending}
  {expanding-reporter}
 
  {report-column:title=Date}{report-info:expanded:view > viewdate}{report-column}
  {report-column:title=Page}{report-info:expanded:item|link=true}{report-column}
  {report-column:title=User}{report-info:expanded:view > username|link=true}{report-column}
 
  {report-empty}_No views tracked._{report-empty}
{report-table}

Result

Show all pageviews of all spaces (except pageviews by user "admin") since 1 Oct 2010 grouped by user

Code

{report-table}
  {grouping-reporter:expanded:view > username|as=User}
    {grouping-stats:expanded:view > viewdate|as=Viewdate}
    {expanding-reporter:viewtracker:all|as=view}
      {content-reporter:space=@all}
      {user-filter:username|users=-admin}
      {date-filter:viewdate|minValue=1-Oct-2010|format=dd-MMM-yyyy}
      {text-sort:username}
    {expanding-reporter}
  {grouping-reporter}
 
  {report-column:title=User}{report-info:grouped:User|link=true}{report-column}
  {report-column:title=Last View}{report-info:grouped:Viewdate > stats:max value}{report-column}
  {report-column:title=Pages Viewed}{report-on:@items}{report-info:item|link=true}{report-on}{report-column}
 
  {report-empty}_No views tracked._{report-empty}
{report-table}

Result