Quick start

Owned by
Nirosan
Last updated: Sept 07, 2023 by
Nisha Shantilal
3 min read

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

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

Step 1 - Create a page

Provide a suitable title and some descriptive text, like the example shown above.

Step 2-  Create a Report

  1. Add a Reporting macro.

  2. Start with some simple CQL syntax and search for the type of content you are trying to report on (refer to this page for more information on the CQL syntax). The example below will match all the pages within a specific space.

     

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 if you enable this, it may significantly increase reports' loading times.

  1. In the Expansions section, use the checkbox list to find and choose the expansions which contain the metadata you are looking for. For this example, we are using "metadata.likes.users". 

     

  2. Now continue to the Report Builder section.

    1. Choose Basic, then click on Add.

       

    2. We'll start by building the first column on the left, which will contain the page titles. Click on "Block 0", then under Title, key in "Title", and under Value, select "title" from the dropdown. Click Update to continue.

       

    3. Next, we'll add the second column, which will display the number of likes. This time, choose Text, then click on Add.

       

    4. Click on "Block 1", then under Title, key in "Likes", and in the editor field below it, insert the value {{content.metadata.likes.count}} by clicking on it in the list on the right side of the editor. Add some static text so that it looks like the example below. Click Update to continue.

       

       

  3. Fine-tune your results with the Filters section. In this example, here we are limiting the report to a maximum of 5 results using `[:5]`. Click Apply to continue.

     

  4. Under Report Type, you can 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).

     

  5.  And finally, we'll add some error handling by filling out the Empty Report section. This text is shown if the report has no results. For this example, we'll enter "No matching pages were found. Please try again later."

     

  6. Save your report, Publish the page,  and you're done.  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.