Skip to main content

Schedule Analytics dashboard reports

Steps to set up recurring email and SFTP deliveries for your Analytics dashboards, including scheduling, format, and filter options.

Written by Sharon Quill

You can schedule any Analytics dashboard to be delivered automatically on a recurring basis. Deliveries can be sent by email or to an SFTP destination.

Schedule a new email delivery

  1. In Analytics, open the dashboard you want to schedule.

  2. Click File, then click Deliveries & Alerts.

  3. In the New delivery panel, set the following:

    • Delivery: Select Schedule for recurring delivery or Alert for condition-based delivery.

    • Send: Select Entire dashboard or a chart in the dashboard.

    • Destination: Select Email or SFTP.

    • Delivery name: Enter a name to identify this delivery.

  4. Complete the Schedule, Dashboard, and Email tabs as described below, then click Save.

🤓 Tip: To validate the email settings, click the Test now button to trigger the schedule and send the dashboard to the configured email addresses.

Screenshot of the File menu with the Deliveries & Alerts selection below it.

Screenshot of the New delivery panel showing the Delivery, Send, Destination, and Delivery name fields at the top with the Schedule, Dashboard, and Email tabs below. Alt text: The New delivery panel in Analytics showing Schedule selected as the delivery type, Entire dashboard in the Send field, Email in the Destination field, and Program Overview as the delivery name.

Schedule tab

Use the Schedule tab to set when and how often the delivery runs.

  1. Select a frequency: Now, Daily, Weekly, Monthly, or Custom.

  2. Under Send on, select the days of the week you want the delivery to run.

  3. Under At, select the time.

  4. In Times are in, select your time zone.

📌 Note: Delivery times are approximate and will happen within 15 minutes of the specified time.

Screenshot of the Schedule tab showing Daily selected, Monday through Friday highlighted under Send on, 9:00 AM in the At field, and EDT in the timezone selector. Alt text: The Schedule tab of the New delivery panel with Daily frequency selected, weekdays selected for Send on, and 9:00 AM EDT as the delivery time.

Dashboard tab

Use the Dashboard tab to set the format and display options for the delivered report.

  1. In Format, select the file format for the delivery. Available options are PNG (Image), PDF, XLSX (Excel), and CSVs (in ZIP file).

  2. Select any display options that apply.

  3. Under Controls and Filters, set the date range and comparison period for the data included in the delivery.

Option

What it does

Expand tables

Expands any tables in the dashboard so all rows are visible in the delivery.

Arrange dashboard tiles in a single column

Stacks dashboard tiles vertically in the delivered file.

Hide title

Removes the dashboard title from the delivered file.

Include a link back to the dashboard

Adds a link to the live dashboard in the delivery.

Show filter values in dashboard

Displays the active filter values in the delivered file.

Use cached results if available

Uses the most recently cached data instead of running a fresh query at delivery time.

Screenshot of the Dashboard tab showing PNG (Image) selected as the format, Include a link back to the dashboard and Show filter values in dashboard checked, and the Controls and Filters section with date range dropdowns. Alt text: The Dashboard tab of the New delivery panel showing format and display options, with two date range filters set under Controls and Filters.

Email tab

Use the Email tab to set the recipients and message for the delivery.

  1. In File Name (without extension), enter a name for the delivered file. Leave blank to use the default.

  2. In Recipients, add the email addresses to receive the delivery.

  3. Optionally, select Personalize content with the recipient's user attributes to tailor the delivered dashboard data to each recipient.

  4. In Subject, enter the email subject line. This defaults to the delivery name.

  5. In Body, enter an optional message to include in the email.

Screenshot of the Email tab showing the File Name, Recipients, Personalize content checkbox, Subject, and Body fields. Alt text: The Email tab of the New delivery panel showing fields for file name, recipients, subject line, and body text.

⚠️ Important: The dashboard delivery emails have a sender of Omni Analytics <[email protected]>. You may need to work with your IT team or email admin to allowlist this email address to ensure these emails are not blocked by your email provider.

Schedule a delivery to SFTP

When you select SFTP as the destination, the Email tab is replaced by an SFTP tab. The Schedule and Dashboard tabs work the same way as for email delivery.

Before you start, you'll need:

  • The address of your SFTP server, including the path (for example, sftp://hostname/my/path).

  • The port number (default is 22).

  • A username and password for your SFTP server.

Steps

  1. In Analytics, open the dashboard you want to schedule.

  2. Click File, then click Deliveries & Alerts.

  3. In the New delivery panel, set the following:

    • Send: Select Entire dashboard or a chart in the dashboard.

    • Destination: Select SFTP.

    • Delivery name: Enter a name to identify this delivery.

  4. Complete the Schedule and Dashboard tabs as described above.

  5. Click the SFTP tab and complete the fields described in the table.

  6. Click Save.

🤓 Tip: To validate the SFTP settings, click the Test now button to trigger the schedule and deliver the dashboard to the configured SFTP server.

Field

What to enter

Address

The full SFTP address including the path, for example sftp://hostname/my/path.

File Name (without extension)

A name for the delivered file. Leave blank to use the default.

Port

The port number for your SFTP server. The default is 22.

Username

Your SFTP username.

Password

Your SFTP password.

Screenshot of the New delivery panel with SFTP selected as the destination, showing the SFTP tab with the Address, File Name, Port, Username, and Password fields. Alt text: The SFTP tab of the New delivery panel showing fields for the SFTP server address, file name, port number, username, and password.

Schedule a delivery to Amazon S3

When you select Amazon S3 as the destination, the Email tab is replaced by an Amazon S3 tab. The Schedule and Dashboard tabs work the same way as for email delivery.

Delivering to Amazon S3 uses cross-account IAM role assumption. Before you start, you'll need to complete a one-time setup in your AWS account.

Before you start, you'll need:

  • An AWS account with permissions to create IAM roles.

  • An S3 bucket to deliver content to, or permissions to create one.

Step 1: Retrieve the IAM role details from Analytics

  1. In Analytics, open any published dashboard.

  2. Click File, then click Deliveries & Alerts.

  3. In the New delivery panel, set Destination to Amazon S3.

  4. Click the Amazon S3 tab.

  5. Note the following values — you'll need them to complete the AWS setup:

    • Deliverer role ARN — the identity Analytics uses to access your S3 bucket.

    • External ID — your organization's unique identifier for this integration.

⚠️ Important: Do not use your own account ARN as the deliverer role ARN.

Step 2: Create an IAM permissions policy in AWS

  1. In a new browser tab, go to the AWS console.

  2. Go to IAM, then click Policies.

  3. Click Create policy.

  4. In the Policy editor section, click the JSON toggle.

  5. Paste in the following policy, replacing YOUR-BUCKET-NAME with the name of your S3 bucket:

    • { 
        "Version": "2012-10-17", 
        "Statement": [ 
          { 
            "Effect": "Allow", 
            "Action": [ 
              "s3:PutObject", 
              "s3:CreateMultipartUpload", 
              "s3:UploadPart", 
              "s3:CompleteMultipartUpload", 
              "s3:AbortMultipartUpload" 
            ], 
            "Resource": "arn:aws:s3:::YOUR-BUCKET-NAME/*" 
          } 
        ] 
      }

  6. Click Next.

  7. Enter a name for the policy.

  8. Click Create policy.

Step 3: Create an IAM role in AWS

  1. In the AWS console, go to IAM, then click Roles.

  2. Click Create role.

  3. Select Custom trust policy and paste in the following, replacing the placeholder values with the Deliverer role ARN and External ID from Step 1:

    • { 
        "Version": "2012-10-17", 
        "Statement": [ 
          { 
            "Effect": "Allow", 
            "Principal": { 
              "AWS": "<Deliverer role ARN>" 
            }, 
            "Action": "sts:AssumeRole", 
            "Condition": { 
              "StringEquals": { 
                "sts:ExternalId": "<External ID>" 
              } 
            } 
          } 
        ] 
      }

  4. Click Next.

  5. Select the permissions policy you created in Step 2.

  6. Click Next.

  7. Enter a name for the role.

  8. Click Create role.

  9. Open the newly created role and copy its ARN — you'll enter this in Analytics in the next step.

📌 Note: The External ID is the same for all Amazon S3 deliveries in your organization. You only need to configure your IAM trust policy once.

Step 4: Configure and save the delivery

  1. Return to the New delivery panel in Analytics.

  2. Complete the New delivery, Schedule, and Dashboard tabs as described in the email delivery section above.

  3. Click the Amazon S3 tab and complete the fields described in the table below.

  4. Click Test now to validate the settings before saving.

  5. Click Save.

🤓 Tip: To validate the Amazon S3 settings, click the Test now button to trigger the schedule and deliver the dashboard to the configured S3 bucket.

Field

What to enter

IAM role ARN

The ARN of the IAM role you created in Step 3.

Bucket

The name of your Amazon S3 bucket.

Optional path

The folder within the bucket to save files to, if any.

File name (without extension)

A name for the delivered file. Supports templates such as {{currentDate}} and {{scheduledTaskName}}. Leave blank to use the default.

Region

The AWS region where your S3 bucket is hosted. This must match the bucket's actual region.

Schedule a delivery to a webhook

When you select Webhook as the destination, the Email tab is replaced by a Webhook tab. The Schedule and Dashboard tabs work the same way as for email delivery.

Before you start, you'll need a webhook URL for Analytics to send requests to. Create this in your chosen webhook platform before setting up the delivery.

📌 Note: Your webhook must return an HTTP 200 status response upon delivery. A different response status may cause delivery retries or failures.

Steps

  1. In Analytics, open the dashboard you want to schedule.

  2. Click File, then click Deliveries & Alerts.

  3. In the New delivery panel, set the following:

    • Send: Select Entire dashboard or a chart in the dashboard.

    • Destination: Select Webhook.

    • Delivery name: Enter a name to identify this delivery.

  4. Complete the Schedule and Dashboard tabs as described in the email delivery section above.

  5. Click the Webhook tab and complete the fields described in the table below.

  6. Click Test now to validate the settings before saving.

  7. Click Save.

🤓 Tip: To validate the webhook settings, click the Test now button to trigger the schedule and send the dashboard to the configured webhook URL.

Field

What to enter

URL

The webhook URL to send the delivery to.

File name (without extension)

A name for the delivered file. Leave blank to use the default.

Edit, duplicate, pause, or delete a scheduled delivery

  1. In Analytics, open the dashboard with the delivery you want to change.

  2. Click File, then click Deliveries & Alerts.

  3. Find the delivery in the list and click the three-dot menu next to it.

  4. Click Edit to update the settings, Duplicate to copy the schedule, Pause to suspend the schedule, or Delete to remove the schedule.

  5. If editing or duplicating, make your changes and click Save.

📌 Note: Click Resume to resume a paused scheduled delivery.


Get help

For additional assistance, please contact Paytronix Support.

Related Articles
Did this answer your question?