Confluence Cloud guide

How to filter a Confluence Page Properties Report

In short: The built-in report filters pages, not rows. Its filters choose which pages appear: label (required), space, parent page, creator, contributor, mentioned user, title, page text and type. No filter looks at a property's value, such as Status = Done, and readers can't filter the table on the page. Workarounds: a label for each value, the Including text filter, or one report per group.

The filters the built-in report has

When you insert or edit the report, you choose its pages with CQL filters (Confluence Query Language): choose Add a filter and pick one. Atlassian's documentation for Confluence Cloud lists these:

FilterReturnsMore than one value
Label (required)Pages with these labelsAny of them in one filter; all of them with a second Label filter
In spacePages from these spacesAny of them
With ancestorPages anywhere below this page in the page treeAny of them
With parentOnly the direct children of this pageOne page only
CreatorPages created by these peopleAny of them
ContributorPages created or edited by these peopleAny of them
Mentioning userPages that @mention these peopleAny of them
With titlePages with this text in the titleOne word or phrase
Including textPages that contain this textOne word or phrase
Of typePages, live docs, blog posts or attachmentsAny of them

Your editor may show newer names for some of them: Atlassian renamed With ancestor to Include all subpages in the Cloud report (CONFCLOUD-77847). Atlassian's documentation doesn't describe a field for typing your own CQL; you build the query from these filters.

Filter by labels: any, all, or not

  • Any of several labels (OR): put all of them in the same Label filter.
  • All of them (AND): add a second Label filter and put one label in each.
  • Leave a label out (NOT): type a minus sign before it, for example -archived.

The label goes on the pages that hold the Page Properties macro, not on the page with the report. The built-in report can't run without one; an open suggestion, CONFCLOUD-74571, asks Atlassian to make the label optional.

Filter by space or part of the page tree

Add In space to list pages from one or more spaces. Several spaces in one filter means any of them.

To report on one project's pages only, combine the label with With ancestor (every page below a page, at any depth) or With parent (only its direct children). For example: label project, with ancestor Projects 2026.

Filtering by a property value, such as Status = Done

This is what most people are looking for, and the built-in report can't do it. Its filters look at the page as a whole: its labels, its place, its people, its title and its text. None of them reads the values in the Page Properties table. Row filtering has been requested since 2013 and is still an open suggestion (CONFCLOUD-29421).

Workarounds without an app:

  1. A label for each value. Add a label that mirrors the value, such as status-done, and add it to the report as a second Label filter. This works well, but someone has to change the label whenever the value changes.
  2. The Including text filter. Enter the value, such as Approved. It matches the text anywhere on the page, not only in the property. Atlassian also lists a bug where this filter matches parts of words, even when you put the term in quotes (CONFCLOUD-82822). Use a value that is unlikely to appear anywhere else on the page.
  3. One report per group. Put several reports on the page, each with its own label or parent page, such as one per team or one per status label.

Letting readers filter the table

The built-in report has no filter box. Readers see every row the editor's filters let through, 30 at a time. To narrow the rows, someone has to edit the page and change the filters.

Several Marketplace apps add filtering. Stiltsoft, for example, says its Table Filter macro can filter a Page Properties Report (in a comment on CONFCLOUD-29421). Ours is described below.

Filtering with our app

We make Page Properties Report & Export for Confluence, so this part describes our own product. It filters at both levels:

  • Which pages: labels (any or all of them, or none), this space, listed spaces or all spaces, anywhere or below a parent page, optional blog posts, a Page Properties ID, and an extra CQL condition.
  • Which rows, saved by the editor: filters on any column, such as Status is Done or Owner is not empty. The operators are contains, does not contain, is, is not, is empty and is not empty. A row must match every filter.
  • Which rows, for each reader: a filter box above the table. It ignores case and accents, so "chloe" finds "Chloé".

The rows that match download as Excel or CSV. Each reader sees only the pages they are allowed to read. The settings are explained in the user guide.

Frequently asked questions

Can I filter a Page Properties Report by a column value?

Not in the built-in report. Its filters choose pages by label, space, place in the page tree, people, title and text, not by the values in the Page Properties table. Use a label for each value, the Including text filter, or an app.

How do I show only pages that have two labels?

Add a second Label filter and put one label in each. Several labels in the same Label filter mean any of them.

How do I leave out pages with a certain label?

Type a minus sign before the label in the Label filter, for example -archived.

Can I type my own CQL in the built-in report?

Atlassian's documentation describes building the query from filters with Add a filter; it doesn't describe a field for your own CQL. Our app has an Extra CQL field that is added to its search with AND.

Why does the Including text filter return too many pages?

It matches the text anywhere on the page, not only in the Page Properties table, and Atlassian lists a bug where it also matches parts of words, even in quotes (CONFCLOUD-82822).

Read next

Sources

  1. Insert the content properties report macro — Atlassian Support, Confluence Cloud: CQL filters and the AND, OR and NOT operators
  2. Insert the content properties macro — Atlassian Support, Confluence Cloud: the label goes on the page with the properties
  3. CONFCLOUD-77847: New Page Property Report macro to cater migrating customer from server — "Include all subpages" is the new name for "With ancestor"
  4. CONFCLOUD-74571: Allow page properties report without label — Suggestion, gathering interest
  5. CONFCLOUD-29421: Allow filtering on rows within the view mode of the page properties macro — Suggestion, gathering interest, opened in 2013; includes Stiltsoft's comment of December 2022
  6. CONFCLOUD-82822: Page Properties does sub string matches instead of exact ones — Bug, gathering impact