Campaign Reports

Overview

Comprehensive reports are viewable for all campaigns you send out of CleverTap. You can use these reports to analyze campaign performance, compare performance across campaigns, and understand engagement trends.

Campaign reports provide the capability to monitor a campaign's performance at a glance. You can email a summary report of all campaigns sent out in a particular date range or split it by day. This report includes metrics, such as campaign deliveries, engagements, conversions, and errors. To optimize dashboard performance, the data in the report is cached and you can receive data that has been generated up to four hours earlier. Also, it is possible that the report is sent to you within six hours depending on the other activities happening at the time of requesting the report.

Generate Reports

You can view the campaigns from the campaigns list page. To view a report, perform the following steps:

  1. From the dashboard, navigate to Campaigns.
  2. Select the campaigns for the report or select using the filter criteria.
  3. Click the email icon or the Subscribe to Reports icon. Then, the Campaign Summary Emails screen displays.
  1. Set up the campaign report. Select the report criteria.
  • Create a report for - Select a report for the following:
    • Selected campaigns: Generates reports only for the campaigns selected from the list.
    • All campaigns with filters applied: Generates report for all the campaigns displayed after applying filters on the campaigns list page.
  • Data to include - Determine what data to include in the report:
    • Campaign overview: Provides an overview of all the campaigns in the report.
    • Campaign stats: Provides important stats for the selected campaigns.
    • Campaign detailed stats: Shows all campaign-related stats, such as total campaigns sent, the total number of devices, and so on.
    • Campaign errors: Displays all the campaign errors.
  • Split all data by - Split data by the required parameters:
    • Day: Shows reports by each day.
    • OS: Shows reports by OS, that is Android and iOS.
    • Variant type: Shows report by the variant type for AB test campaigns.
  • Split all data by - Split data by the required parameters:
  • Frequency: Displays report based on the selected frequency.
    • One-time: Sends report only once.
    • Recurring: Sends recurring reports on the selected days or dates.

You can have a one-time report or a recurring report and subscribe to it based on the selected frequency.

For a report subscription, you are redirected to the Subscribe tab. The report is emailed to you on the selected days.

This report summarizes data on all campaigns that were sent out the previous week in CleverTap.

Subscribe to Reports

You may want to subscribe to a report in various scenarios. For example, select and subscribe to four campaigns on a monthly recurrence, or only subscribe to push campaigns that you created with a label for a monthly/daily recurrence.

To view your existing subscriptions, click the Subscribe to Reports link from the Campaigns list page. The subscriptions are displayed on the Subscriptions tab.

To create new report subscriptions, perform the following steps:

  1. Select the required campaigns from the Campaigns list page.
  1. Click the Subscribe to Reports link from the campaigns list page. The Campaign Summary Emails screen displays.
  2. From the setup tab, select the required options and click Send Report.
  3. Your existing subscription to reports is displayed on the Subscriptions tab.

Edit or Delete Reports

The existing schedule for the reports is displayed on the Subscriptions tab.

  1. To edit or delete a subscription to a report, click Subscribe to Reports on the campaign list page. The Campaign Summary Emails screen displays.
  2. Click the vertical ellipsis.
  1. Click Edit or Delete to make changes to a report subscription.

Reports API

You can get the campaign report API to programmatically generate campaign reports for your consumption.

Campaign Report Data

The following table provides all columns part of the report based on the selected data group. For example, the first column Campaign ID will be part of each report, irrespective of the data group. However, the campaign name will display as a column in your report, only if you select Campaign overview while requesting the report.

Report Column
Campaign Overview
Campaign Stats
Campaign Detailed stats
Campaign Errors
Description

Campaign ID

Yes

Yes

Yes

Yes

The unique ID for the campaign.

Campaign Name

Yes

The name provided for the campaign during its creation.

Channel

Yes

The channel such as email, mobile push, that is used for the campaign.

Delivery

Yes

The campaign delivery such as action, inaction, one time, and so on.

Type

Yes

The type of campaign such as single message, message on user property, or A/B test.

Variant

Yes

The message variant. Applicable only to A/B test messages and message on user property.

OS

Yes

The device operating system, such as iOS and Android.

Device

Yes

Devices such as mobile, TV, or a Tablet.

DND / Set Campaign Frequency

Yes

DND or campaign frequency setting configured at the time of campaign creation.

Timezone

Yes

Configuration for the delivery in the user timezone.

Cutoff

Yes

Configuration of the cutoff period after which the campaign is not delivered.

FCAP (global campaign limits)

Yes

Configuration for the maximum number of messages that a user can receive in a day.

Throttle

Yes

Configuration for the throttle limits applied to the campaigns.

Safety Check Limit

Yes

The campaign is not sent to any user if the number of qualified users exceed the limit.

Campaign per Day Limit

Yes

Number of maximum messages sent per day for the campaign.

Campaign Overall Limit

Yes

Number of maximum messages sent overall for the campaign.

Estimated Reach

Yes

Estimated qualification of users.

Reach (Send to all / last active)

Yes

Send to all devices or the last active device.

Who Query

Yes

The who query defined in the campaign.

Constant Event Property

Yes

Shows whether the constant event property is applicable or not.

Title

Yes

The title of the notification.

Message

Yes

Message of the notification.

iOS Rich Media Type

Yes

Media type such as, single or carousel for iOS push notifications.

iOS Rich Media URL

Yes

Image URL for iOS push notifications.

iOS Sound File

Yes

iOS sound or the file URL if custom.

iOS Badge Count

Yes

Badge count on iOS notification.

iOS Category

Yes

Category for iOS push notifications (if applicable).

iOS Deep Link / External URL

Yes

Deep link for iOS push notifications.

iOS Mutable Content

Yes

Shows whether the content is mutable. The values are Yes/No.

Android Subtitle

Yes

Subtitle of the Android push notifications.

Android Image URL

Yes

Image URL for Android push notifications.

Android Summary

Yes

Summary text for Android push notifications.

Android Large Icon URL

Yes

Large icon for Android push notifications.

Android Small App Icon Color

Yes

Small app icon for Android push notifications.

Android Deep Link / External URL

Yes

Deep link for Android push notifications.

Android Sound File

Yes

The values are:

  • NA
  • Default OS sound
  • file URL, if the file is custom

Android Notification Tray Priority

Yes

Shows the priority of display in tray of android device.

Android Notification Delivery Priority

Yes

Server priority for Android push notifications.

Collapse Notification

Yes

Shows whether the notification is collapsible or not.

Notification Channels

Yes

Communication channel, for which the user consent is received.

Badge ID

Yes

Badge ID for Android push notifications.

Badge Icon

Yes

Badge count Android push notifications.

Send to App Inbox as Well

Yes

Applicable only for push. Sent to app inbox as well or not.

Time to Live

Yes

Time for the notification to live in the user device.

SMS / Email / WA Service Provider

Yes

The service provider.

Start Date

Yes

Start date of the campaign.

Start Time

Yes

Displays the start time of the campaign. Displays the time value if the campaign is set to best time.

Conversion Event

Yes

The conversion is tracked for this event in the campaign.

Conversion Time (in minutes)

Yes

Time period within which conversion is tracked for the campaign.

Campaign URL

Yes

The URL of the campaign to access it on Clevertap dashboard.

Status

Yes

Current status of the campaign.

Created By

Yes

The creator of the campaign.

Created Time

Yes

Time of creating the campaign.

Labels

Yes

The Labels / tags used to identify and organize campaigns.

AmplifiedByInbox

Yes

Shows whether the campaign was amplified by sending it to inbox as well or not.

AmplifiedByPush

Yes

If push amplification is applied or not.

Web Priority

Yes

Priority of web notifications. It can be high, medium, or low.

Run Date

Yes

Applicable for day-wise reports only. Displays the run date.

Total Sent (users)

Yes

Displays the total count for the sent users. Shows as N/A for channels that are not supported, such as in-app.

Total Viewed (users)

Yes

Displays the total count for the users who viewed the notification.

Total Clicked (users)

Yes

Displays the total count for the users who clicked the notification.

Total Sent (events)

Yes

Total events. Total devices (if Send to all is applied).

Total Viewed (events)

Yes

Total events. Total devices (in case of Send to all is applied).

Total Clicked (events)

Yes

Total events. Total devices (in case of Send to all is applied).

Errors

Yes

Errors.

Click Through Conversions

Yes

Total converting users (as per funnel, including clicked step).

Click Through Conversions %

Yes

Total converting users / Total sent users.

Click Through Conversion Revenue

Yes

Revenue as per the revenue property related to Total conversions.

Total Control Group Count

Yes

Total number of users in control group.

Total Control Group Conversions

Yes

Total number of control group users converting.

Total Control Group Conversions %

Yes

Total number of control group users converting / Total number of users in control group.

Total Control Group Revenue

Yes

Revenue as per revenue property related to conversion.

Unique Sent (users)

Yes

Unique users who were sent notification.

Unique Viewed Within Conversion Time

Yes

Unique users who viewed the notifications within the set conversion time.

Unique Clicked Within Conversion Time

Yes

Unique users who clicked the notifications within set conversion time.

Unique Converted Within Conversion Time

Yes

Unique users who converted within the set conversion time.

Revenue Within Conversion Time

Yes

Revenue as per the revenue property related to conversion.

View Through Conversions

Yes

Users who were sent a message and they converted. Referred as influenced conversions on the dashboard.

View Through Conversions %

Yes

Influenced conversion (above) / Total sent users.

View Through Conversions Revenue

Yes

Revenue as per the revenue property related to conversion.

System Control Group Conversions

Yes

Total number of system control group users converting.

System Control Group Conversions %

Yes

Total number of system control group users converting / Total number of users in system control group.

System Control Group Revenue

Yes

Revenue as per the revenue property related to conversion.

Campaign Control Group Conversions

Yes

Total number of campaign control group users converting.

Campaign Control Group Conversions %

Yes

Total number of campaign control group users converting / Total number of users in campaign control group.

Campaign Control Group Revenue

Yes

Revenue as per the revenue property related to conversion.

Custom Control Group Conversions

Yes

Total number of custom control group users converting.

Custom Control Group Conversions %

Yes

Total number of custom control group users converting / Total number of users in custom control group.

Custom Control Group Revenue

Yes

Revenue as per the revenue property related to conversion.

Custom Control Group Name

Yes

Name of the custom control group.

System Control Group Count

Yes

Total number of users in system control group.

Custom Control Group Count

Yes

Total number of users in custom control group.

Campaign Control Group Count

Yes

Total number of users in campaign control group.

Invalid FCM Key

Yes

Campaign error description.

App Uninstalled (Android)

Yes

Campaign error description.

Wrong FCM API key

Yes

Campaign error description.

Invalid APNS Certificate

Yes

Campaign error description.

APNS Error

Yes

Campaign error description.

APNS Format Error

Yes

Campaign error description.

APNS Account Temporarily Blacklisted

Yes

Campaign error description.

App Uninstalled (iOS)

Yes

Campaign error description.

Invalid Profiles

Yes

Campaign error description.

Duplicate APNS Token

Yes

Campaign error description.

Invalid Token - FCM

Yes

Campaign error description.

Unknown Error - FCM

Yes

Campaign error description.

Dispatch Error

Yes

Campaign error description.

Internal Error Due to Amplification

Yes

Campaign error description.

Global Frequency Cap Exceeded

Yes

Campaign error description.

Campaign Frequency Cap Exceeded

Yes

Campaign error description.

Campaign Limit Reached for Day

Yes

Campaign error description.

Campaign Limit Reached for Run

Yes

Campaign error description.

Profile Not Reachable

Yes

Campaign error description.

Campaign Stopped

Yes

Campaign error description.

User DND

Yes

Campaign error description.

Duplicate Profile for Channel

Yes

Campaign error description.

APNS Bad Topic Error

Yes

Campaign error description.

APNS Disallowed Topic

Yes

Campaign error description.

APNS Bad Device Token

Yes

Campaign error description.

APNS Device Token and Topic Mismatch

Yes

Campaign error description.

APNS Inactive Device Token for Topic

Yes

Campaign error description.

APNS Wrong Environment Certificate

Yes

Campaign error description.

APNS Bad Certificate

Yes

Campaign error description.

APNS Idle Timeout

Yes

Campaign error description.

APNS Missing Certificate Topic

Yes

Campaign error description.

APNS Bad Priority

Yes

Campaign error description.

FCM Payload Too Large

Yes

Campaign error description.

User Not Reachable

Yes

Campaign error description.

User Not Qualified

Yes

Campaign error description.

Notification during Campaign DND

Yes

Campaign error description.

Campaign Cut-off Time Reached

Yes

Campaign error description.

Updated 4 months ago


Campaign Reports


Suggested Edits are limited on API Reference Pages

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