document-stats-report macro

Overview

The document-stats-report page macro creates a simple report that displays the number of pages and blog posts currently in each workflow state.

Where to use it?

Optional.

One or more document-stats-report macros can be used in wiki pages, blog posts, and, in some cases, comments - see Reporting Guide > Reporting Macros > Document Stats Report Macro.

It can also be used in any macro that supports wiki content in its Macro body (check relevant macro documentation for details).

Compatible with the Confluence chart macro.

Parameters

Parameter

Required

Default

Notes

Ver

Parameter

Required

Default

Notes

Ver

label

No

blank

Reports on the pages and blog posts with at least one of the listed labels. Content must be a child page of the specified parent page or a child page of the specified space(s) home page

  • default (blank) is any page or blog post

  • add one or more labels added as a comma-separated list

    • reports on page and blog posts with any of the added labels

  • add the (the and ampersand) before the first label value in a list to require pages and blog posts to have all the labels in the added list



parent

No

blank

Report on child pages of a specified page

  • default (blank)

    • parent page is the current space homepage

  • single parent page title

    • if left blank and a single space key is listed then the report defaults to the child pages of the specified space home page

  • use @self for child pages of the current page



space

No

blank

Report on child pages of space home page

  • default (blank)

    • the current space

  • single space or comma-separated list of spaces identified by spacekey

If a parent page is specified you cannot list multiple space keys. The report defaults to the child pages of the added parent page.



state

No

blank 

Reports on the count of pages and blog posts in a workflow state that is a child page of the specified parent page or the listed space(s) home page.

  • default (blank)

    • pages and blog posts with an applied workflow in any state

  • comma-separated list of state names

Report displays the states and the count for each state in the order the states are added to the macro (from v6.16.4+)



workflow

No

blank

The count of pages and blog posts in a workflow state for a named workflow or workflows (in the scope of the macro parameters is listed).

  • default (blank)

    • page and blog post in any state of ALL workflows in the space

  • comma-separated list of workflow titles

 If no workflow title value is added the count for all states for all workflows in the current space is reported including cpages and blog posts where the workflow has been removed but the workflow history has been retained.



See also

Workflow Authoring Guide

Reporting Guide

Developer Guides