The WebEngage Knowledge Base Developer Hub

Welcome to the WebEngage Knowledge Base developer hub. You'll find comprehensive guides and documentation to help you start working with WebEngage Knowledge Base as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Scheduled Reports

A step-by-step guide on how to set up scheduled reports for all your campaigns and channels

Designing impressive campaigns that hit the ball out of the park is an exhilarating experience for us marketers. The ups of creating the right message, the downs of struggling with the right creative and the final redemption offered by a handsome ROI and a happy user - driving digital engagement is an emotional rollercoaster ride.

But this is just one side of the story.

There's a murkier side of marketing that most of us dread - generating reports. An average marketer spends 3.5 hours a week on collecting data pertaining to their campaigns and an additional 1 - 2 hours on organizing the stats in a consumable format.

What if you could utilize all this time in being more productive?

In our quest to make campaign reporting a seamless experience, we built Scheduled Reports - customizable and automated reports delivered straight to your inbox!

How It Works

🚧

Please Note

Reports can be configured by only those Admins that have access to Account Management. If you are unable to do so, then please get in touch with the account owner.

In addition to analyzing the performance of a campaign and channel in your dashboard, you can choose to have all the respective details and stats delivered to your (and your teammate's) inbox as a Scheduled Report. Periodic reports can be scheduled for:

  • A specific campaign (How to set it up for Push, In-app, SMS, Web Push, Email campaigns), WhatsApp campaigns)

  • All campaigns sent through a channel (How to set it up)

  • All campaigns across channels - Push, In-app, SMS, On-site Notifications, Web Push, Email, WhatsApp (How to set it up)

  • All reports are emailed to its subscribers as a link to a downloadable CSV file, as per the report's settings.

The following aspects of a Scheduled Report can be customized by you:

Subscribers

While creating a report, you can choose to add multiple account users as subscribers to it. Doing so will ensure that all the added users receive the report, as per its settings.

Account admins can also choose to subscribe to an existing report through the List of Scheduled Reports section, nested under Settings.

Frequency

You can choose to schedule a report for delivery on a Daily, Weekly or Monthly basis, as per your needs. The Frequency of an existing report can be edited anytime you like.

When

The time of delivery of a scheduled report can be specified in an AM-PM format under the field, When. Doing so will ensure that the report is sent to its subscribers at the specified time, in your project's timezone (as specified under General Settings while setting up the account).

Data to Include

Too many data points always lead to chaotic insights. This is why we have made it possible for you to specify the time frame (number of days) for which you'd like to receive campaign stats in a report. It can be determined by selecting a time frame between Last 1 Day - Last 30 Days under Data to Include, while scheduling a report.

  • For example, if you select Last 5 Days for a campaign's report, then it will include 5 rows of data, ranging from Day 1 - 5, indicating the campaign's performance against various performance indicators for each day.

  • Similarly, if you select Last 15 Days for the report - All Email Campaigns Summary, then it will include 15 rows of data for each Email campaign your users have interacted with, within the specified duration.

Data Granularity

At WebEngage, you can create upto 5 versions of a campaign and test each one with a small test segment to determine the copy that resonates with your audience. Thus, depending on your analytical needs, you can choose to analyse:

  • Overall performance of the campaign by selecting Campaign Level.
    OR
  • Performance stats for each variation by selecting Variation Level.

How to Schedule Channel Reports

🚧

You can choose to schedule performance reports for a channel through its List of Campaigns section or through the Settings section of your account. Please follow the steps listed below to schedule your reports through either section.

Schedule Reports can be accessed through the Settings section of your account, as shown below.

Click to enlarge

As shown above, this section:

  • Includes a list of all the campaign and channel reports scheduled by various account admins
  • Allows you to schedule reports for campaigns sent through a channel and all channels combined (Push, In-app, SMS, On-site, Web Push, Email, WhatsApp)

Let's quickly walk you through the details shown against each report:

Click to enlarge

  • Report: This column lists all the campaign performance reports that have been scheduled for your account, along with a summary of each report's settings including, Frequency, When & Data to Include.

  • No. of Subscribers: Indicates the number of account users that are currently subscribed to a report.

    • Only for campaign reports: As highlighted above, you can click on the hyperlinked number to preview a list of subscribers.
  • Status: Indicates your status of subscription to a report. You can choose to subscribe to a report by selecting Subscribe from the report's overflow menu, as shown below.

  • Actions: The overflow menu nested under this column allows you to Modify, Delete, Subscribe to / Unsubscribe to the corresponding report. (How to modify & delete a report)

Now, let's show you how you can schedule a consolidated report for campaigns sent through a channel and all channels combined:

Step 1: Click the Plus icon

As shown below, in doing so you will be prompted with a pop-up allowing you to customize the report's settings.

Click to enlarge

Step 2: Select a Report

As shown above, here you can choose from a list of pre-defined channel reports that you can customize as per your needs.

📘

The following reports can be selected here:

  • All Push Campaigns Summary: Helps you analyze all the Push campaigns your users engaged with, throughout the time frame specified under Data to Include..

  • All In-app Campaigns Summary: Helps you analyze all the In-app campaigns through which users were engaged, within the time frame specified under Data to Include..

  • All SMS Campaigns Summary: Helps you analyze all the SMS campaigns through which users were engaged, within the time frame specified under Data to Include..

  • All On-site Campaigns Summary: Helps you analyze all the On-site campaigns through which users were engaged, within the time frame specified under Data to Include..

  • All Web Push Campaigns Summary: Helps you analyze all the Web Push campaigns through which users were engaged, within the time frame specified under Data to Include..

  • All Email Campaigns Summary: Helps you analyze all the Email campaigns through which users were engaged, within the time frame specified under Data to Include..

  • All WhatsApp Campaigns Summary: Helps you analyze all the WhatsApp campaigns through which users were engaged, within the time frame specified under Data to Include..

  • All Campaigns Across Channels Summary: Helps you collectively analyze and compare all the campaigns your users engaged with, throughout the time frame specified under Data to Include..

Step 3: Specify Frequency of Delivery

As shown below, you can choose to have a report delivered on a Daily, Weekly or Monthly basis, as per your needs.

Click to enlarge

Step 4: Specify Delivery Time (When)

As shown above, you can choose to have the report delivered at a specific time of the day. The same can be defined in an AM/PM format against the field, When.

Step 5: Specify Time Frame (Data to Include)

Too many data points always lead to chaotic insights. This is why we have made it possible for you to specify the time frame (number of days) for which you'd like to receive campaign stats. As shown below, you can select a time frame between Last 1 Day to Last 30 Days against Data to Include.

Click to enlarge

Step 6: Select Level of Data Granularity

As shown above:

  • Select Campaign Level Granularity to analyse the overall impact of all campaign variations.

  • Select Variation Level Granularity to analyse the individual performance of each variation and identify the top performer.

Step 7: Add Subscribers

As shown above, you can choose from a list of all the team members who have access to your WebEngage dashboard. However, if a team member is not a part of your WebEngage account, then you will not be able to add them as a Subscriber.

Next, click the Schedule button. In doing so, a notification will pop-up on the bottom right corner of the page, confirming that the report has been scheduled.

🚧

Scheduling Report for a Campaign

Please click on the respective links for a step-by-step guide on how you can schedule reports for Push, In-app, SMS, Web Push, Email campaigns), and WhatsApp campaigns.

Understanding Report Stats

(Applicable to all Scheduled & Downloaded Reports)

Each time a campaign is sent to your users, we track it's impact through Performance Indicators like Deliveries, Failures, Clicks, Conversions, Revenue and so on. In all Scheduled & Downloaded Reports you will receive stats for these Performance Indicators as an Events View.

  • This means: You will be able to analyze the performance of a campaign/channel based on the stats gleaned for it within the specified time frame, even if the campaigns were sent before the time frame specified under Data to Include.

  • For a Campaign Report: If the campaign is still Running, then the stats will be shown for all users engaged till present. If it has Ended, then stats will be shown for all users that have been engaged through the campaign for up to 45 days from its End Date.

    • For a Channel Report: Stats will be shown for all users engaged through the channel within the selected time frame, even if the campaigns were sent before the selected period.

Please note that only unique stats are included your channel and campaign reports.

🚧

Why a Report's Stats May Seem Different from Dashboard's Stats

Stats can be analyzed in the following views in your dashboard:

Funnel View: Data is shown only for the messages (of a campaign)/ campaigns (of a channel) that are 'sent' with the selected time frame.

Events View: Data is shown for all 'users that have been engaged through the campaign/channel within the selected time frame, irrespective of when the campaign was 'sent'.*

The default view of stats shown across your dashboard is a Funnel view. All Reports contain stats in an Events view. Hence, a report's stats may seem inconsistent with those shown in your dashboard.

You can toggle to Event's View in your dashboard (as shown here) to dig deeper into the stats of a Report, for a campaign.

The following details are included in all Scheduled and Downloaded Reports:

Column Header

Whats It Means

Campaign Name

As defined at Step 1: Audience, while creating the campaign.

Campaign ID

A unique ID is assigned to each campaign created in your dashboard.

Variation Name

Depending on the number of versions created for a campaign's message, this could be any of - Variation A/ B/ C/ D/ E.

Variation ID

A unique ID is assigned to each message variation created for a campaign.

Channel

Indicates the channel through which the campaign was sent.

Type of Campaign

This could be any of - One-time, Triggered, Recurring, Transactional, Journey or Relay.

Segment Name

Indicates the campaign's target segments, as defined at Step 1: Audience, while creating it.

(Field will remain blank if campaign has been sent through a Journey.)

Segment ID

A unique ID is assigned to each segment created in your dashboard. In case you specify multiple segments as the campaign's target audience, we'll list all the ID against this field.

(Field will remain blank if campaign has been sent through a Journey OR is being sent to All Users.)

Journey Name

If the campaign has been sent through a Journey then its name will be shown here.

(Field will remain blank if campaign has been sent directly through the channel.)

Journey ID

A unique ID is assigned to each Journey created in your dashboard.

(Field will remain blank if campaign has been sent directly through the channel.)

Campaign Tags

Tags help you categorize your campaigns as per their purpose or any other parameter that make them easier to search for in your dashboard. You can add these through Campaign's Overview.

Start Date

Indicates the date on which the Triggered/ Recurring/ Transactional/ Journey campaign was launched or sent to its target audience for the first time.

Send Date (for one-time campaigns)

Indicates the date on which the was One-time campaign sent.

Conversion Event

Indicates the action users are expected to perform on your app after receiving the campaign, as specified at Step 4: Conversion Tracking, while creating it.

Conversion Deadline

Indicates the duration till which the campaigns' Conversion Event will be tracked, as specified at Step 4: Conversion Tracking, while creating it.

Control Group

All related details are shown only if Control Group was enabled for the campaign or its while creating it.

Total in Control Group

Indicates the number of users included in the campaign's Control Group.

Unique Control Group Conversions

Indicates the number of users of the Control Group that have performed the campaign's Conversion Event.

Unique Control Group Conversion Rate

Indicates organic conversion rate of users who did not receive the campaign as they were a part of the Control Group.

🚧

Performance Indicators shown in a Report for each Channel & its Campaign

Click the respective channel to access a list of all the stats included in your report, like Deliveries, Failure reasons, Queuing reasons, Impressions, Clicks and so on.

Push
In-app
SMS
On-site Notifications
Web Push
Email
WhatsApp

The following additional details are included in all Scheduled and Downloaded Reports where Variation Level Data Granularity is selected:

Column Header

Whats It Means

Layout Name

Indicates the name of the ready-to-use template selected for creating the Push/ In-app/ Web Push campaign variation.

SSP/ ESP/ WSP

Title/ Subject Line

The first 200 characters are indicated for all campaigns variations except SMS and WhatsApp messages.

Message

The first 200 characters of the message is indicated for all campaign variations.

Default CTA Label

Indicates the primary call-to-action text for all In-app, On-site, Web Push and carousel-style Push campaigns.

Default CTA Link

Indicates the primary button link for all Push, In-app, SMS, On-site and Web Push campaigns.

Image

Indicates the banner image for all Push, On-site, Web Push campaigns.

  • Indicates the background image for all In-app campaigns.

Key-Value Pairs

  • Indicates all the JSON key-value pairs added to your Push campaign at Step 3: Message.

  • Indicated for SMS, Email and WhatsApp only if you're using a Private SSP / Private ESP / Private WSP to send the respective campaigns.

Sender ID (only for SMS)

Indicates the Sender ID used to send the campaign, as added at Step 3: Message.

From Name (only for Email)

Indicates the sender's name, as added at Step 3: Message while creating the campaign.

From Email Address (only for Email)

Indicates sender's email address, as added at Step 3: Message while creating the campaign.

Template Name (only for WhatsApp)

Indicates the name of whitelisted message template used to create the campaign.

Understanding the Date of Report Stats

A combination of the Frequency of report delivery and the time frame of Data to Include help determine the exact dates for which the campaign performance stats are included in a report. Let's go over a use-case to understand this better:

👍

How Frequency and Data to Include Determine the Stats Included in a Report

Let's assume that you subscribe to the report - All Push Campaigns Summary on May 1, at 3 pm. Here's what it's settings look like:

  • Frequency: Daily

  • When: 6 pm

  • Data to Include: 7 Days

This means:

  • The first report (sent at 6 pm, May 1) will include a day-wise summary of the performance of all the Push campaigns your users interacted with over the last 7 Days, April 24 - 30 in which:

    • Day 1 will show campaign stats for April 24
    • Day 2 will show campaign stats for April 25 and so on.
  • The second report (sent at 6 pm, May 2) will include a day-wise summary of the Push campaigns your users interacted with between April 25 - May 1 (last 7 days) and so on.

  • Thus, each subsequent report will include data collected only 7 days prior to the actual date of report delivery.

How to Modify a Scheduled Report

As shown below, all account admins can choose to modify or delete a report by selecting Change Settings or Delete, respectively from a report's actions menu.

Click to enlarge

Change Settings

As shown below, select Change Settings from the actions menu to modify a report. In doing so, you will be prompted by a pop-up allowing to alter all the aspects of the Scheduled Report.

Click to enlarge

For example, in the above visual, we have added more subscribers to the Weekly report - All Email Campaigns Summary.

Delete

Click to enlarge

Step 1: As shown above, select Delete from the actions menu to disable the Schedule Report permanently.

  • In doing so, you will be prompted by a pop-up asking you confirm your decision.

Step 2: Click the Delete button on the pop-up.

  • A notification will pop-up on the bottom right corner of the page, confirming that the segment has been deleted.

Custom Reports

Different businesses have different needs, and this is why we've never been a fan of the 'one-solution fits all' approach. Presenting, Custom Reports - highly detailed reports pertaining to all your campaigns, channels, journeys, users, segments, funnels, cohorts and uninstalls, as requested by you!

While the Scheduled Reports should take care of all your regular analytical needs, you can always request Custom Reports for any additional data points you need. Please get in touch with your Customer Success Manager or drop in a few lines at [email protected] with all your requirements, we'll be delighted to assist you.

Updated 7 months ago

Scheduled Reports


A step-by-step guide on how to set up scheduled reports for all your campaigns and channels

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.