Viewtracker - Analytics for Confluence
Space shortcuts

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note
titlePlease note:

We don't supply support for  custom  configured do not offer support for custom configured Space Usage Reports. 


On this page:

Table of Contents

Space Usage Report with Reporting Plugin

Include Page
Custom Space Usage Reports do not work. How can I make them work?
Custom Space Usage Reports do not work. How can I make them work?

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

Include Page
BVVIEWSUPP:Compatibility Matrix
BVVIEWSUPP:Compatibility Matrix

Introduction Reporting Plugin

→ Documentation

Overview

Report Frames

MacroDescriptionExample
report-blockWill display the report results in a series of blocks.


Code Block
{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.


Code Block
{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.


Code Block
{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

Info

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:

Code Block
{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:

Code Block
{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:

Code Block
{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:

Code Block
{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

Info

list non exhaustive


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

Views absteigend sortieren:

Code Block
{date-sort:viewdate|order=descending}


text-sortThis will sort the results by the specified text key value.

Views nach Benutzername aufsteigend sortieren:

Code Block
{text-sort:username}


Filters

Info

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":

Code Block
{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:

Code Block
{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:

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


Suppliers

Info

list non exhaustive


Introduction Viewtracker Supplier

→ Documentation

Excerpt Include
BVVIEWSUPP:Viewtracker Supplier
BVVIEWSUPP:Viewtracker Supplier
nopaneltrue


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

Code Block
{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

Code Block
{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

Code Block
{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