---
title: "Workflow Report Macro - Approvals"
canonical: "https://support.appfire.com/space/CDML/650120822/Workflow%20Report%20Macro%20-%20Approvals"
format: markdown
---
> Macro (aura-html)


> Macro (excerpt-include)



## Overview

> Macro (excerpt)
> 
> Keep track of content reviews across multiple spaces.

The **approvals** report is used to display lists of content review information. It's great for keeping track of the content reviews taking place across multiple spaces.

## Permissions

By default, this report is only available to users who can [Add content](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650217543) (pages or blog posts) to the space.

Admins can make it available to everyone by changing the **[Workflow Activity and Drafts Visibility](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649956239)** setting.

## Adding the report

To add the report to a page

- choose **Workflow Report** in the macro browser  
> Macro (inline-media-image)
- set the **Type** setting to **approvals**
- choose **Save**
- **Publish** the page

  
Here's how the macro looks on your page.

![image](media://ada3f211-3817-4562-a673-44e935706f1e)

Filters can be applied to the report by a user on the page.

| Filter | Description |
| --- | --- |
| **​View** | View Pending, Approved or Rejected​ approvals |
| **Approvals** | Which approval (name) to filter by |

## Report Columns

| Report Column | Description |
| --- | --- |
| ​Title | Page title​ |
| Last updated by | User who last modified the page |
| Updated | Timestamp of page modification |
| State | Workflow state page is currently in |
| Status | Displays one or more approval status icon(s) for approvals *in the current state* for each page and a hyperlink to the content version at the time when the approval became active.<br>This is **only shown** when a named approval is selected in the filter options above the report header. Details for the status will also be displayed in the last (No name) column of the report.<br>### Status icon<br>Choose the **Pending** filter along with the named **Approvals** filter<br>- active pending approval are displayed with a  :check_mark: (tick in circle)<br>The active pending status icon will also include<br>- last approval decision :yellow_star: (star) is displayed indicates awaiting approval or the last approval decision for this approval was approved
- last approval decision ❌  (cross) is displayed indicates the last approval decision for this approval was rejected<br>If the approval is not active but pending (for example the approval limits reviewers to assignees and none have been assigned) the last approval decision will be displayed without the green tick.<br>Choose the** Approved** or **Rejected** filter is along with the named **Approvals** filter<br>- completed Rejected approvals are displayed with a rejected decision icon (large red cross)
- completed Approved approvals are displayed with an approved decision icon (green tick in check box)<br>### Version link<br>A link to the page version that existed when the approval became active. If no further edits have yet been made then the link will be to the **(**<span style="color: #3366ff">**Current**</span><span style="color: #000000">**)**</span><span style="color: #000000"> version. </span><br><span style="color: #000000">If further edits have been made choosing the link displays a message warning the user that a more current version exists.</span> |
| (No name) | Details of the Approval status showing any action required and recent activity related to the approval.<br>Only shown when an approval is selected in options above header. |

The report content can be customized by editing workflow report macro settings.

> 📝 The on-page report filters will still be available for users unless the report macro is edited to **Hide Headers**.

## Customizing the report

You can customize the report macro with the following macro settings.

The settings can be used to display a report that lists approvals includes customizing the report

- for specific a **spaceKey**(s)
- on content with specific **Label**(s)
- on content with a named parent (**parent page filter**)
- by **Approval** name
- for the current approval status for pending, approved or rejected (**Filter** )
- for a specific **Approver**

The report can also be customized to sort on a specific column, the sort order and the maximum number of entries.

| Setting | Default | Notes |
| --- | --- | --- |
| **Space Key(s)** | *Current space* | Which space(s) should be included in the report?<br>- Leave empty to report on the current space
- Specify one [space key](https://confluence.atlassian.com/doc/space-keys-829076188.html) to report on a specific space
- List multiple [space keys](https://confluence.atlassian.com/doc/space-keys-829076188.html), separated by commas, to report on multiple spaces
- Specify `any` to report on all spaces. |
| **Approval** | approval name (required) | > ⚠️ **You must specify the name of a content review for this report to work.**<br>The name is defined by the [approval macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649662337), and is shown in the [workflow popup](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649659846) during [content reviews](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650313809). |
| **Max Entries** | 20 | The number of results to show per page.**†** |
| **Filter** | pending | Which stage of the content review should the content be in?<br>- **pending** – the review is not yet complete
- **approved** – the review was approved
- **rejected** – the review was rejected |
| **Label** |  | Should the report be filtered by content label(s)?<br>- Leave empty to include all content
- Specify one label name to filter to a specific label
- List multiple label names, separated by commas, to filter to content with any of those labels<br>If using a list of labels, you can prefix the list with `&` (ampersand) to require that content has all the labels. |
| **Parent Page Filter** |  | Should the report be filtered to a specific parent page and the child pages of the specific page?<br>- Leave empty to include all content in the space
- Specify a page title to include the specified page and its child pages |
| **Approver** |  | Should the report be filtered to content that the specified user can currently review?<br>- Leave empty to include all content
- Specify a username to filter to results which that user can review
- Specify `@self` to filter to results that the current user can review |
| **Sort** | modified | Which column of the report should results be sorted by? |
| **Sort Order** | descending | Should the sort be in ascending or descending order? |
| **† **The macro has a 500-page limit for each report. If a larger report is required it may be useful to use the [CQL REST API](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649921636). |

## See also

[User Guide](https://appfire.atlassian.net/wiki/spaces/CDML/pages/648907144)

- [Content reviews](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650313809)

[Workflow Authoring Guide](https://appfire.atlassian.net/wiki/spaces/CDML/pages/648611901)

- [Reviews](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650153766)