Save and Schedule Reports

 Note

When you create new reports and dashboards, you are prompted to save in a Space. Please read about Spaces before starting this tutorial.

In this tutorial, you will save a customized report to a new dashboard and send dashboard data to an email address.

Save a Customized Report to a New Dashboard

  1. Open your messaging project and go to Reports » Performance Analytics.
  2. Go to a dashboard and select a report you would like to customize and save. In this example we will select the Weekly Active Users count from the Overview dashboard.
  3. Click the ellipsis icon and select Explore From Here.
  4. Make these changes in the left side menu:
    • In Opens » Dimensions, click the row for Date.
    • In Message IDs » Dimensions, click Pivot for Any Push Attributed (Yes/No).
  5. Make these changes in the Visualization row:
    • Click the Column visualization.
    • Click and select Stacked.
  6. Click next to Run and select Save to Dashboard.
  7. Enter a Title and choose where to save the content.
  8. Click New Dashboard, enter a dashboard name, then click OK. Your new dashboard will be listed.
  9. Click Save to Dashboard. The next screen will show a confirmation banner. Click the link in the banner to open the the saved report.

Open Saved Reports and Dashboards

  1. Click the Spaces menu icon located to the right of in the header row of any dashboard or report.
  2. On the left side of the menu, select from the Personal, Group, or Shared space icons, then click the name of a listed dashboard or report.

Schedule Sending Dashboard Data

 Important

Best Practice

Since Performance Analytics is an on-demand system, it is important that your scheduled requests do not adversely impact other customers. When scheduling an export of user-level data:

  1. Filter appropriately so that results are not excessive or a larger data set than necessary.
  2. Select a weekend day to limit your impact on other users.

If you are interested in integrating with other business systems, we highly recommend using our Ret-Time Data Streaming integrations, which will scale to your needs. See our Partner Integrations.

Both dashboards and reports can be scheduled to send data to email, webhook, AWS S3, or an SFTP server. In this example we are emailing a dashboard to a Slack address.

  1. Open a saved dashboard from the Spaces menu.
  2. Click and select Schedule....
  3. Enter a name for the schedule.
  4. (Optional) Adjust schedule settings. See Report Scheduling Options for detail.
    • Destination:
      • Email: Your account's email address is populated by default. If you have additional recipients, enter each email address and click Add. Follow the instructions to get your Slack-generated email address, then enter it here.
      • Webhook: Enter the webhook URL.
      • Amazon S3: Enter the S3 values for Bucket, Access Key, Secret Key, and select a region.
      • SFTP: Enter the host and path, e.g., sftp://mysftp.com/home/ftpuser/, and the SFTP user username and password.
    • Format: Select the data's delivery format. Options are dependent on whether you are scheduling a report or a dashboard, and the selected Destination.
    • Delivery: Frequency of delivery.
    • Filters: Filter by activity window in hours by user attribute, or filter by region events by date or user attribu
    • Advanced Options: Schedule based on results, limit to table results or include all results, apply formatting, and/or select delivery time zone. Additional options may be available depending on report format.
  5. Click Send Test to preview before saving. It will send according to the defined Destination settings.
  6. Click Save All.

Scheduling Options

These are options are available when configuring scheduling.

Destinations:

  • Email: The data or visualization is delivered to the email addresses entered.

  • Webhook: Webhooks are a modern, increasingly common way to trigger exchanges between internet based services. They generally require some technical or developer knowledge to use, but with a product like Zapier, webhooks can let Performance Analytics data be delivered to a wide range of locations. Only a webhook URL is required.

  • Amazon S3: Amazon S3 buckets are a common way to store large amounts of data. You or your company will need to have created an S3 bucket with Amazon before you can use it with Performance Analytics. Options include:

    • Limits: If you choose "Results in Table", whatever row limitations you’ve set up in the saved report will be obeyed. If you choose “All Results” all the rows of the query will return, regardless of the saved report settings, and regardless of the typical 5,000 row limit for Performance Analytics. This can be desirable for retrieving very large datasets, but you should use caution to ensure the query is not too large for your database.
      • Bucket Name: The name of your Amazon S3 bucket.
      • Path (optional): The folder that you want to save your data too, if any.
      • Access Key: The Access Key ID to your S3 bucket, provided by Amazon.
      • Secret Key: The Secret Acess Key to your S3 bucket, provided by Amazon.
      • Region: The Amazon services region where your S3 bucket is hosted.

Format:

The Format dropdown menu options vary based on whether you are scheduling a report, or a dashboard, and the selected destination.

  • HTML attachment: The data table of your report as an HTML file attachment.

  • TXT (tab-separated values) attachment: The data table of your report as a tab-delimited text file attachment.

  • Inline Visualization (Email only): The visualization of your report in the body of the email.

  • Inline Tables (Email only): The data table of your report in the body of the email.

  • CSV attachment: The data table of your report as a comma-separated text file attachment.

  • JSON attachment: The data table of your report as a JSON file attachment.

  • Inline JSON (Webhooks only): The data table of your report submitted directly in the webhook request.

  • Excel Spreadsheet attachment: The data table of your report as an Excel file attachment.

Report-only Scheduling Options

Values:

  • Unformatted: Performance Analytics does not apply any special formatting of your query results, such as rounding long numbers or adding special characters your Performance Analytics developers may have put in place. This is often preferred when data is being fed into another tool for processing.

  • Formatted: The data will appear more similar to the Explore experience in Performance Analytics, although some features, such as linking, aren’t supported by all file types.

Send if:

  • Based on results: You can choose to send a report only if there are results, there are no results, or in either case. This option lets you only receive emails when the filters of your report are met or not met.

  • Results changed since last run:: This option help cuts down on unnecessary emails. Performance Analytics will send an email only if the query results have changed since the last email was sent.

Limit:

  • All Results: This will override checking the Send if option to include results changed since last run.