Document Stats Report Macro

Overview

Permissions

Anyone can see this report.

View-only users will only see results for content that has reached the Approved ( final=true ) state, even if there are subsequent draft state edits to that content.

Adding the report

To add the report to a page choose the Document Stats Report macro.

In the editor, choose Insert → Other Macros → Reporting → Document Stats Report or type {Document Stats ... on the page and select {document-stats-report}
Choose Edit the macro
Choose report filters and display column settings

The document-stats-report macro can also be used with the Confluence chart macro to display the count in visually.

Customizing the report

Edit the Document Stats report macro to customize the report by

You can choose to filter the state count for the content by

label(s)
parent
space(s) using the spacekey

If multiple labels are added the report will display the state information for content with each label. If you wish to display information for content that must have all the specified labels, add the & (and ampersand) operator in front of the first label in the list

The macro can be also be customized for

one or more states

Note that the report will also include the state count for content if the workflow history was retained when the workflow was removed.

Customize the displayed columns

Filter the report

In the macro editor select options to filter the report. These include options to filter by state, space key, workflow, label or parent page - see table below).

Report filters

The filters are listed alphabetically in the macro editor.

Setting	Default	Notes
Label	blank	Should the report be filtered by content label(s)? leave empty to include all content list one label name to filter to specific label list multiple label names, separated by commas, to filter to content with any of those labels If using a list of labels, you can prefix the list with `&` (ampersand) to require that content has all the labels. Otherwise it will report pages containing any of the listed labels.
Parent page	blank	Report limited to child pages only of the space home page or specified page. leave empty to include all content in the space (does not include the home page as this is the default parent) specify a page title to include only its child pages
Spaces	blank	Which space(s) should be included in the report? If specifying a parent page you cannot list multiple space keys. The report will default to the child pages of the added parent page.
State(s)	blank	Should the report be filtered to a specific state or state(s)? A comma-separated list of workflows to be displayed. The count for all the content in the states in the scope of the macro editor settings are displayed. leave empty to include all content in all states limit report by listing one or more state names in a comma-separated list The report will include the state count for content where the workflow has been removed but the workflow history has been retained
Workflow	blank	Should the report be filtered to a specific workflow or workflows(s)? A comma-separated list of workflows to be displayed. leave empty to include all content in all states in all workflows limit report by listing one or more workflow titles in a comma-separated list If left empty then the report will include the state count for content where the workflow has been removed but the workflow history has been retained