Create scheduled reports

You can create scheduled reports to automatically generate and deliver analytics data on a recurring schedule to configured destinations.

Before you begin

Before you begin, ensure that:

  • You have at least one active Analytics service configured in your IBM® API Connect environment
  • Analytics storage is enabled
  • You have the appropriate permissions to create scheduled reports at your desired scope

About this task

Scheduled reports automate the delivery of analytics data. They generate and send reports at defined time intervals without manual intervention. Unlike engagement rules, scheduled reports focus only on time-based report generation and delivery.

Reports can be sent to multiple destination types:

  • Webhook - Generic HTTP endpoint for custom integrations
  • Slack - Slack channels via webhook for team notifications
  • Email - Email recipients (to, cc, bcc) for direct delivery
  • PagerDuty - Incident management platform for operational alerts

Scheduled reports can be configured at different organizational levels:

  • Cloud Manager - Reports across the entire cloud instance
  • API Manager - Reports for a specific provider organization
  • Catalog scope - Reports for a specific catalog within an organization
Important: At cloud scope, you can only create scheduled reports. Full engagement rules with triggers and actions are not supported at the cloud scope level.

Procedure

  1. Log in to your API Manager or Cloud Manager.
  2. Click the Engagement icon Engagement icon.
  3. Click Scheduled Reports.
  4. Click Create and provide the following details:
    • Report name: A descriptive name for your scheduled report
    • Schedule: Specify the schedule as a number followed by a unit.
      • Use h for hours and d for days. For example: 2h (every 2 hours), 1d (daily).
    • Report type: Select an analytics report type
    • Destination: Select a destination type. Only destinations that you configured are available. For more information, see Creating a notification task
    • Parameters: Select parameters based on the analytics data range that you require.
  5. Click Create.

Results

Your scheduled report is now created and will run according to the specified schedule. The report will automatically generate analytics data and deliver it to the configured destination at each scheduled interval.