/
Document Stats Report Macro

Document Stats Report Macro

Owned by Robert Alexander Marshall
Last updated: Jan 17, 2025 by Alain Martínez
3 min read
1 Overview | 2 Permissions | 3 Adding the report | 4 Customizing the report | 5 Report filters

Overview

Permissions

Anyone can see this report.

Adding the report

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

In the editor, either

  • choose Insert  → Other Macros → Reporting → Document Stats Report 

  • or type {Document Stats ...  on the page and select {document-stats-report}

  • choose  Edit

cdac_documentstats_editoption.png

  • choose report filters and the display column settings

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

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 space key

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

You can customize the macro to display one or more states.

The report also includes 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

Version

Setting

Default

Notes

Version

Label

blank

Should the report be filtered by content label(s)?

  • leave empty to include all content

  • list one label name to filter to a specific label

  • list multiple label names, separated by commas, to filter to content with any of those labels

Using a list of labels, you can prefix the list with the  & (the and ampersand) to require that the content has all the labels. Otherwise, it reports 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

 

Ancestor page

blank

The report is limited to the descendant pages of the specified page.

  • use @self to report on the descendant pages of the current page

  • specify a page title to include only its descendant pages

If specifying an ancestor page, you cannot list multiple space keys. The report defaults to the descendant pages of the added page.

v2.4.0+ DATA CENTER

Spaces

blank

Which space(s) are in the report?

  • when specifying a parent page, you cannot list multiple space keys

The report defaults 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 is 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 includes the state count for content where the workflow was removed, but the workflow history was retained.

 

Workflow

blank

Should the report be filtered to a specific workflow(s)?

A comma-separated list of workflows to be displayed.

  • leave empty to include all content in all states in all workflows

  • limit report data by listing one or more workflow titles in a comma-separated list

If left empty, the report consists of the state count for content where the workflow was removed, but the workflow history was retained.