> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heygarth.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Schedule Report

> Set up automated reports that are generated and delivered to you on a recurring schedule.

The **Schedule Report** page is where you set up automated reports that are generated from your metric dashboards and delivered to you on a recurring schedule. This page lives under **Administration → Scheduler → Schedule Report** in the left sidebar.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/na-f445b234/images/reports-schedule.png" alt="Reports Schedule page showing the Reports tab" />
</Frame>

At the top of the page, two tabs let you switch between:

* **Alerts** — threshold-based alerts, covered separately in the **Schedule Alert** guide.
* **Reports** — the view covered in this guide, listing every report you've scheduled.

The count next to the **Reports** tab (e.g. "40") shows how many reports currently exist.

## Viewing existing reports

The table on the **Reports** tab lists every report that has been scheduled, along with when it last ran and whether it's currently active.

| Column           | What it shows                                                                                                                                       |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Report Name**  | The report's name, with a colored status dot, an icon, and a label showing its delivery channel (for example, **Email**) underneath.                |
| **Scheduled At** | How often the report runs (for example, "Every minute").                                                                                            |
| **Last Run**     | A relative time since the report last ran (e.g. "4 days ago"), with the exact date and time underneath.                                             |
| **Status**       | A toggle plus label showing whether the report is **Active** or **Inactive** — flip the toggle to turn the report on or off directly from the list. |
| **Actions**      | **👁 View**, **✏️ Edit**, and **🗑️ Delete** icons for that report.                                                                                 |

Use the **All Reports** count chip, the **All** status dropdown, and the **Search Reports** box to filter the list down to what you're looking for, and the refresh icon to reload the table with the latest data.

## Creating a new report

Click **+ Schedule Report** in the top right of the page to open the **Schedule New Report** form.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/na-f445b234/images/schedule-new-report-general-contents.png" alt="General Information and Report Contents sections of the Schedule New Report form" />
</Frame>

### General Information

| Field           | Required | Details                                                                                   |
| --------------- | -------- | ----------------------------------------------------------------------------------------- |
| **Report Name** | Yes      | A unique name so you can identify this report later (for example, "Daily Sales Report").  |
| **Description** | No       | A short explanation of what this report contains, for your own and your team's reference. |

### Report Contents

This section defines what data the report will pull in.

| Field                | Required | Details                                                                                                       |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| **Select Dashboard** | Yes      | The metric dashboard this report will be generated from (for example, **dora**).                              |
| **Projects**         | No       | Narrows the report to a specific project. The list of projects shown depends on the dashboard selected above. |
| **Data Grain**       | Yes      | How many days of data the report should include — **7 Days**, **15 Days**, or **90 Days**.                    |

### Schedule Configuration

This section defines how often the report should be generated and sent.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/na-f445b234/images/schedule-new-report-schedule-notification.png" alt="Schedule Configuration and Notification Methods sections of the Schedule New Report form" />
</Frame>

| Field             | Required | Details                                                                                                                                                                |
| ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Schedule Type** | Yes      | How the report's schedule should be set — for example, **Recurring (every)**, which repeats on a fixed interval as defined below.                                      |
| **Timezone**      | Yes      | The timezone the schedule should run in (for example, **UTC**).                                                                                                        |
| **Frequency**     | Yes      | How often the report should run, made up of two parts: **Every** (the interval, e.g. Day, Hour, Minute) and **At** (the specific time it should run, e.g. `13:29:37`). |

### Notification Methods

This section controls how the report is delivered, and what's included in it.

**Notification Channels** (required) — check one or more of **Email**, **Slack**, or **Teams**. You must select at least one channel to receive reports.

**Executive Summary** — toggle this on to include an AI-generated executive summary alongside the report. This adds a concise overview highlighting key insights and metrics, making it easier for stakeholders to quickly understand the data without digging through the full report.

Selecting a channel adds a settings card for it below. For **Email**, the **Email Settings** card (shown with an **Active** badge and an **✕** to remove it) asks for:

| Field              | Required | Details                                                                                                                                         |
| ------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| **TO**             | Yes      | The primary email address (or addresses) the report should be sent to (for example, "[executives@company.com](mailto:executives@company.com)"). |
| **CC (Optional)**  | No       | Additional email address(es) to CC on the report.                                                                                               |
| **BCC (Optional)** | No       | Additional email address(es) to BCC on the report.                                                                                              |

<Note>
  Recipients in the TO, CC, and BCC fields are separated by a comma "," or a semicolon ";". Slack and Teams show their own settings card, with fields specific to those channels, once checked.
</Note>

Once all required fields (marked with a red **\***) are filled in, click **Save Report** in the top right to create the report. Click **Cancel** to discard your changes and return to the Reports list.
