Confluence Cloud guide
Confluence Page Properties and the Page Properties Report: how they work
In short: Put a Page Properties macro on each page you want to report on, with a two-column table: names on the left, values on the right. Give those pages the same label. On another page, insert a Page Properties Report and enter that label. It lists one row per page and one column per property, 30 rows at a time. Atlassian's Cloud docs now call the two macros content properties and content properties report.
How the two macros work together
The two macros split the work. The Page Properties macro holds a small table of facts on one page, such as an owner, a status and a due date. The Page Properties Report macro, on another page, collects those tables into one table: one row per page, one column per property, and the page title as a link in the first column. Atlassian's Decisions and Product Requirements templates use this pair.
The new names. Atlassian's Confluence Cloud documentation now calls them the content properties macro and the content properties report macro, and says the report "was previously known as the page properties report macro." They work on pages and on live docs. To insert the report, the docs say to type /contentpropertiesreport in the editor. These guides use the old names, because that is what most people still search for.
Set it up in four steps
- Add the properties. On each page you want in the report, insert the Page Properties macro. In its body, make a two-column table: property names in the left column, values in the right. The names become the report's column headings.
- Label the pages. Give each of those pages the same label, for example
project. The label goes on the page, not in the macro. - Insert the report. On the page where you want the summary, insert the Page Properties Report macro and enter that label. Add more filters if you need them, then choose Insert.
- Publish. The report now lists every page that has the label and a Page Properties macro.
To narrow the list further, see How to filter a Page Properties Report.
Which table the report reads
- The table inside the Page Properties macro. That is where the report looks for names and values.
- Vertical or horizontal. Names in the first column and values in the second, or a two-row table with the heading style on the first row: names in the first row, values in the second. Atlassian says the report reads both, even when pages mix them.
- One header row or one header column, not both. In Atlassian's words, the report "can extract data for only one header row or column per content properties macro." What that means for tables with more rows is in Page Properties with multiple rows.
- No macros in the names column. Its text becomes the report's column headings, so Atlassian says not to use macros there.
- Hidden tables still count. The macro's Hidden option hides the table on its own page, but the report still shows its values.
- Several macros on one page. Without an ID, the report reads all of them. Give a macro a Page Properties ID and enter the same ID in the report to read only that one. A report takes one ID.
What you can set in the report
| Setting | What it does |
|---|---|
| Label and other filters | Choose which pages are listed. A label is required; space, parent page, people, title and text filters are optional. |
| Page Properties ID | Reads only Page Properties macros with this ID. |
| Title column heading | Renames the first column ("Title" by default). The column itself is always there and always first. |
| Columns to show | A comma-separated list of the columns to show. Left empty, the report shows all of them. |
| Max results per page | How many rows show before the report adds page controls: 30 by default, and 30 at most. |
| Sort by, Reverse Sort | One column to sort all results by ("Modified" by default), and a box to reverse the order. See How to sort a Page Properties Report. |
| Show Comments Count, Show Likes Count | Add each page's number of comments or likes as a column. |
The 30-row cap is a Cloud limit. Atlassian's Data Center documentation gives 30 only as the default, not as a maximum, and says the macro can display up to 3,000 pages. Many answers you find online describe Data Center, so check which one they mean.
Where the built-in report stops
The most common complaints are open requests in Atlassian's public tracker:
- Readers can't filter the rows on the published page (CONFCLOUD-29421, open since 2013), and no filter looks at a property's value. Workarounds.
- Clicking a column header sorts only the rows on screen (CONFCLOUD-78373). Workarounds.
- A table with several rows of values gives one row in the report (CONFCLOUD-40835). Workarounds.
- No more than 30 rows at a time (CONFCLOUD-78762), no column widths (CONFCLOUD-67089), and the Title column can't be removed or moved (CONFCLOUD-83231).
Where our app fits
We make Page Properties Report & Export for Confluence, a Marketplace app for Confluence Cloud, so this part describes our own product. It reads the same Page Properties macros, vertical and horizontal, and lists one row per page and one column per property, like the built-in report. On top of that:
- Readers click any header to sort every row, type in a filter box, and download the rows as Excel or CSV.
- Editors choose pages by label (or no label), space, parent page, Page Properties ID or extra CQL, and set each column's order, name and width.
- A report lists up to 1,000 pages by default and up to 5,000, with Show more.
- If the page already has the built-in report, Copy its settings takes over its CQL, columns, sort and ID in one click.
A Confluence administrator installs it once. It is free for sites with up to 10 users. Every setting is in the user guide.
All guides
- How to filter a Confluence Page Properties Report
Filter a Page Properties Report in Confluence Cloud by label, space, parent page, people or text, and what to do when you need to filter by a property value.
- How to sort a Confluence Page Properties Report
Use Sort by and Reverse Sort in the Confluence Cloud Page Properties Report, why a click on a column header sorts only 30 rows, and what you can't sort by.
- Page Properties with multiple rows or several tables on one page
What the Confluence Cloud Page Properties Report shows when a properties table has several rows of values, or a page has several Page Properties macros.
Frequently asked questions
What is the difference between Page Properties and the Page Properties Report?
The Page Properties macro holds a table of facts on one page. The Page Properties Report macro, on another page, collects those tables from every page with a given label into one table, with one row per page.
Was the Page Properties Report renamed?
Atlassian's Confluence Cloud documentation now calls it the content properties report macro and says it was previously known as the page properties report macro. The Page Properties macro is now the content properties macro.
Why is my Page Properties Report empty?
Atlassian suggests three checks: the label is spelled correctly and is on pages that have a Page Properties macro, the Page Properties macros on those pages are set up correctly, and your other filters, such as a parent page, don't narrow the search too far.
Do I need a label for a Page Properties Report?
In the built-in report, yes: the Label filter is required. An open suggestion, CONFCLOUD-74571, asks Atlassian to make it optional.
Can I hide the Page Properties table on the page?
Yes. Turn on the macro's Hidden option. The table disappears from its own page, but the report still shows its values.
Sources
- Insert the content properties macro — Atlassian Support, Confluence Cloud: the table, horizontal layout, labels, ID, Hidden, notes
- Insert the content properties report macro — Atlassian Support, Confluence Cloud: filters, display options, troubleshooting
- Page Properties Report Macro (Confluence Data Center) — Atlassian documentation for Data Center: number of items, up to 3,000 pages
- CONFCLOUD-29421: Allow filtering on rows within the view mode of the page properties macro — Suggestion, gathering interest
- CONFCLOUD-78373: Clicking on column name does not sort across all pages in Page properties report macro — Bug, gathering impact
- CONFCLOUD-40835: Have Page Properties Macro pull multiple columns/rows from one macro — Suggestion, gathering interest
- CONFCLOUD-78762: Page properties Report max results per page increase — Suggestion, gathering interest
- CONFCLOUD-67089: Page Properties Report Macro - Ability to define column widths — Suggestion, gathering interest
- CONFCLOUD-83231: Ability to customise the column order in Content Properties Report macro — Suggestion: the title column is always first and can't be removed
- CONFCLOUD-74571: Allow page properties report without label — Suggestion, gathering interest