Quick start

Here's a quick start guide to working with Reporting.

Description

In this example, we will build a simple report that shows the number of likes on pages within a space.

Guide

Create a page and provide a suitable title and some descriptive text, like the example above.
Add a Reporting macro.
Start with some simple CQL syntax and search for the type of content you are trying to report on.
For example, the query type=page and space=RC will match all the pages within the space RC.
For details about the CQL syntax, refer to Atlassian’s page Advanced Searching using CQL.

Fetching all results

By default, Reporting will only return the first 200 results from a query. This is done for performance reasons. There is a Fetch all results option below the query box, but be aware that enabling it may significantly increase the report loading time.

In the Expansions section, use the checkbox list to find and choose the expansions that contain the metadata you are looking for. For this example, we are using metadata.likes.users.
In the Report Builder section, configure the first column of the report, which will contain the page titles.
1. From the dropdown menu, select Basic and click Add to create the report block that will represent the column.
  Block 0 appears.
2. Click Block 0 to configure it.
3. In the Title box, enter Title.
4. From the Value menu, select title.
5. Click Update.
Still in the Report Builder section, configure the second column of the report, which will contain the number of likes.
1. From the dropdown menu, select Text and click Add to create the report block that will represent the column.
  Block 1 appears.
2. Click Block 1 to configure it.
3. In the Title box, enter Likes.
4. From the Value menu, select content.metadata.likes.count.
5. Click Update.
In the Filters section, fine-tune your results.
In this example, enter [:5] to limit the report to a maximum of 5 results and click Apply.
In the Report Type section, choose how you want your results to be shown on the page.
The options are Table (used for this example), List (bullet list), and Block (paragraph).
In the Empty Report section, configure the text shown if the report has no results.
For this example, enter No matching pages were found. Please try again later.
Save the macro and Publish the page.

The report is limited to 200 results. So if your search matches more than 200 results with data, only the first 200 will be shown.