> For AI agents: [llms.txt](https://docs.trustedauth.com/llms.txt) provides a Markdown index of this documentation.

# Manage usage reports

You can view, generate, and schedule Usage Reports that provide information about the use of your Tenant accounts. The system uses aggregate data in the report information, which includes information such as the number of users, and the number of voice/SMS credits.

## Role requirements

To generate or schedule Usage Report, Service Provider Administrators need a custom Role with at least **Export Reports** and **Scheduled Task Management** permissions. To create a custom role, you must have the Super Administrator role or a custom role that allows you to create new roles.

### Create a custom role

You must be a **Super Administrator** or have a custom role that allows you to create a custom role to complete this procedure.

1. Go to Menu icon **>** **Members > Roles**. The **Roles List** page appears.

2. Click Circle Plus icon. The **Add Role** page appears.

3. Enter a **Name** for your custom role. For example, **Manage Service Provider Reports**.

4. Enter a **Description** for your custom role.

5. Choose one of the following options:

   - Select **Manage All Roles** to allow those assigned this role to manage all users.
   - Do not select **Manage All Roles** and from the **Select** **Roles to Manage** drop-down list, select the roles that you want the users assigned this role to manage.

   For example, if you want to create a custom role called _Report Manager_ that allows the role to manage all users assigned the Auditor role, select _Auditor_ from the drop-down list.

info
When you select a role, it appears in the **Administrator is allowed to manage these roles** list. To add more roles, select the next role from the drop-down list.

6. Set the **System Entities** and permissions, as follows:

7. For the **Export Reports** System Entity, click **All**.

8. For the **Scheduled Task Management** System Entity, click **All**.

9. Click **Add** to create the role.

## Generate usage reports

### Generate usage report for a single tenant

1. Click Menu icon **>** **Service Provider > Tenants. The** **Tenants List** **page appears.**
2. Click Ellipsis Vertical icon next to the account.
3. Select **Generate Usage Report**. The **Generate Usage Report** dialog box appears.
4. Enter a **Name** and **Description** for your report.
5. Select a **file delimiter** for the report, Comma (,) or Pipe (|) for the CSV file.
6. Select the **Period** for the report. If you choose **Custom**, use the calendar to select start and end dates.
7. Optional. Select **Schedule Report** to create a user report on-demand at the schedule period.
8. Click **Confirm**.

### Generate a report for all tenants

1. Click Menu icon **>** **Service Provider > Tenants. The** **Tenants List** **page appears.**
2. Click Ellipsis Vertical icon at the top of the page and select **Generate Usage Report**.
3. Select **Generate Usage Report**. The **Generate Usage Report** dialog box appears.
4. Enter a **Name** and **Description** for your report.
5. Select a **file delimiter** for the report, Comma (,) or Pipe (|) for the CSV file.
6. Select the **Period** for the report. If you choose **Custom**, use the calendar to select start and end dates.
7. Optional. Select **Schedule Report** to create a user report on-demand at the schedule period.
8. Click **Confirm**.

### Generate a report from a filter list

1. Click Menu icon **> Service Provider > Tenants**. The **Tenants List** page appears.
2. Click Search icon to enable filtering.
3. The **Filters** dialog box appears.
4. Select your filter options and click **Apply**.
5. You are returned to the **Tenants List** page. The page displays your filter results.
6. Click Ellipsis Vertical icon at the top of the page and select **Generate Usage Report**.
7. Select **Generate Usage Report**. The **Generate Usage Report** dialog box appears.
8. Enter a **Name** and **Description** for your report.
9. Select a **file delimiter** for the report, Comma (,) or Pipe (|) for the CSV file.
10. Select the **Period** for the report. If you choose **Custom**, use the calendar to select start and end dates.
11. Optional. Select **Schedule Report** to create a user report on-demand at the schedule period.
12. Click **Confirm**.

### Export Tenants Reports

1. Click Menu icon **>** **Service Provider > Tenants**. The **Tenants List** page appears.
2. Click Arrow Down To Line icon next to the report to export the report or archive to a CSV file.
3. Click **Export**.
4. If the export is taking too long and you want to cancel the export, click Circle X icon and then click **Cancel** on the **Cancel Report** prompt.
5. If you do want to cancel the report, click **Submit** to cancel the prompt.
6. If required, click **Cancel** to cancel the export.

### Schedule Usage Reports

1. Go to Menu icon **>** **Scheduled Reports**. The **Scheduled Tasks** page appears.
2. Click Circle Plus icon. The **Create Scheduled Report** dialog box appears.
3. Enter a **Name** for the scheduled task.
4. Optional. Enter a **Description** for the scheduled task.
5. In the **Email** field, enter the email address of the user who will receive the scheduled task report once it has been generated.
6. Select **Usage Report** from the **Task Type** drop-down list.
7. Select a **Recurrence** from the drop-down list.
8. Select the **Day of the Week** for the scheduled task.
9. Select the **file delimiter** used in the CSV file.
10. Select **Enable the scheduled report**.
11. Click **Confirm**.
12. The scheduled report appears in the **Schedule Reports** page.

### Enable, disable, edit, and delete Scheduled Reports

#### Enable, disable, edit, and delete Scheduled Reports

1. Click Menu icon **>** **Scheduled Reports**. The **Scheduled Reports** page appears.
2. Do the following, as required for the Scheduled Report:
   - Click Square icon **Disable** to disable the Scheduled Report and then click **Confirm** on the prompt.
   - Click Play icon **Enable** to enable the Scheduled Report and then click **Confirm** on the prompt.
   - Click Trash icon **Delete** to delete the Scheduled Report. Click **Delete** on the prompt.

#### Edit a Scheduled Report

1. Click Menu icon **>** **Scheduled Reports**. The **Scheduled Reports** page appears.
2. Click the **Name** of the Scheduled Report. The **Edit Scheduled Report** dialog box appears.
3. Edit the fields as required. See the procedure in [Schedule Usage Reports](#schedule-usage-reports) for more information.
4. Click **Confirm**.