Content Reporter

Owned by
Nirosan
Last updated: Jan 05, 2024 by
Elena Amandola (Deactivated)
2 min read

Description

Reports on Confluence content (pages, news, comments, attachments, etc.).

The content can be filtered by space, type, scope, or labels, as well as any custom filters specified in the body of the macro.

The macro will load slowly in a site with a lot of content. Use Local Reporter macro where possible.

Parameters

Name

Required

Migratable to Cloud?

Default Value

Description

Name

Required

Migratable to Cloud?

Default Value

Description

space(s)

 

  • (X)

 

 

  • NO

 

@self

The comma-separated list of spaces to search in.

Each space may be prefixed by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded).
May be one of the following:

  • @self - (default) The space the current content is in.

  • @personal - Personal spaces only.

  • @global - Global spaces, that is, non-personal spaces.

  • @favorite - Favourite spaces only.

  • @all - All spaces, both global and personal.

  • SPACE KEY - Any other space key may be specified explicitly.

type(s)

 

  • (X)

 

 

  • NO

 

all

The comma-separated list of content types to allow.

Each type may be prefixed by either a '+' (to indicate it is require) or '-' (to indicate it must be excluded). May be any of the following: 

  • page

  • news

  • comment

  • attachment

  • spacedescription

label(s)

 

  • (X)

 

 

  • NO

 

 

The comma-separated list of labels to filter on. Each label can be prefixed with either a '+' (AND operator) or '-' (NOT operator). If no prefixes are included, the default operator would then be OR.

e.g.:

  • "+asia, +europe, -americas" would list content which have the "asia" AND "europe" labels but NOT the "americas" label.

  • "asia, +europe, -americas" would list content which has the "europe" label but NOT the "americas" label. Take note that because the "asia" label has no prefix but the other labels do, it will be ignored.

  • "asia, europe, americas" would list content which have at least one of these labels.

scope

 

  • (X)

 

 

  • NO

 

 

Comma-separated list of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendants or ancestors: 

  • > children - The direct children of the specified page. e.g.: 'My Page > children'

  • > descendants - All descendants of the specified page. e.g.: 'My Page > descendants'

  • > ancestors - All ancestors of the specified page. e.g.: 'My Page > ancestors'

This is independent of the space parameter, so if you wish to limit the scope for a page in another space, you will need to put that space key as the prefix, even if you already specified it in the space parameter.

e.g.: "KEY:My Page > children'.

time

 

  • (X)

 

 

  • NO

 

 

Allows the specification of a period of time to search within.

e.g.: 7d will only allow content modified in the last 7 days.

matchAll

 

  • (X)

 

 

  • NO

 

true

If set to false, content matching any of the criteria will be returned. Otherwise, the content must match all criteria. 

Editor View

  • Not applicable.

Macro Edit View

  • Not applicable.

Notes

  • Scoping a page with an open bracket '(' on the title of the Content Report macro will only function correctly if the open bracket is encapsulated with double quotes "(". For example:

    • “Use Open (bracket) > children”

    • Use Open (bracket) > children

  • Check out Best practices when using Reporting.

Tutorial Examples