Scenario
A report that shows the count of all direct children pages and descendant (indirect children) pages of a page.
Result
Recipe
Apps | Reporting for Confluence Cloud |
---|---|
Macros | Reporting |
Estimated time | 5 minutes |
Steps
To build the report shown in Result above, follow these steps:
Create a new page for the report and give it a suitable title. Then insert a Reporting macro.
In the Reporting window, under Query, type the Confluence Query Language (CQL) syntax that will allow you to search for the parent page, whose children and descendants you want to report on. Refer to this Atlassian article for more information on the CQL syntax.
The example CQL below:type=page AND title="Get Started"
will match all pages with the title "Get Started" in the current space. Click Search and confirm that your CQL syntax is matching the parent page.Now continue to the Add expansions section, which helps you retrieve more data from your query. Check the following boxes to retrieve all children and descendants pages of the “Get Started” page: children and then page after expanding under children, similarly descendants and then page after expanding.
Let’s build the first column for the report (leftmost column), which will contain the Parent page. Go to the Add report blocks section to add the first block, which will be your first column too.
Make sure that Basic is selected in the dropdown, then click on Add block.
Click on the Block box and type Parent Page next to Block title and next to Value, select content.title to show the title of the parent page. For this example, it is Get Started.
Look at the screenshot to see how the block’s settings and preview should appear:
Next, let’s add the second column of the report, which displays the count of direct child pages under the Get Started (parent) page.
Again, under Add report blocks choose Basic in the dropdown, then click on Add block.
Click on the Block box and type Direct Children Count next to Block title and next to Value, select content.children.page.size to show the number of direct children of the Get Started page. For this example, it is 3.
Repeat step 5 for the last column, which displays the count descendant pages (indirect children) under the Get Started (parent) page. Type All Descendants Count for the Block title and choose content.descendants.page.size.
Note that descendant pages also include direct children pages in their count. This means that if under the Get Started Page, you have five total pages, the descendants will show that you have five pages under the Get Started page, no matter if they are direct children pages or you need to drill down 3 levels to reach them.
Check the Preview and Save your report
Publish the page, and you're done.