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.
1577
  1. Set up the campaign report. Select the report criteria.
564
  • 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.
  • 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.
1577
  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.
561

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.
567
  1. Click Edit or Delete to make changes to a report subscription.
568

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 ColumnCampaign OverviewCampaign StatsCampaign Detailed statsCampaign ErrorsDescription
Campaign IDYesYesYesYesThe unique ID for the campaign.
Campaign NameYesThe name provided for the campaign during its creation.
ChannelYesThe channel such as email, mobile push, that is used for the campaign.
DeliveryYesThe campaign delivery such as action, inaction, one time, and so on.
TypeYesThe type of campaign such as single message, message on user property, or A/B test.
VariantYesThe message variant. Applicable only to A/B test messages and message on user property.
OSYesThe device operating system, such as iOS and Android.
DeviceYesDevices such as mobile, TV, or a Tablet.
DND / Set Campaign FrequencyYesDND or campaign frequency setting configured at the time of campaign creation.
TimezoneYesConfiguration for the delivery in the user timezone.
CutoffYesConfiguration of the cutoff period after which the campaign is not delivered.
FCAP (global campaign limits)YesConfiguration for the maximum number of messages that a user can receive in a day.
ThrottleYesConfiguration for the throttle limits applied to the campaigns.
Safety Check LimitYesThe campaign is not sent to any user if the number of qualified users exceed the limit.
Campaign per Day LimitYesNumber of maximum messages sent per day for the campaign.
Campaign Overall LimitYesNumber of maximum messages sent overall for the campaign.
Estimated ReachYesEstimated qualification of users.
Reach (Send to all / last active)YesSend to all devices or the last active device.
Who QueryYesThe who query defined in the campaign.
Constant Event PropertyYesShows whether the constant event property is applicable or not.
TitleYesThe title of the notification.
MessageYesMessage of the notification.
iOS Rich Media TypeYesMedia type such as, single or carousel for iOS push notifications.
iOS Rich Media URLYesImage URL for iOS push notifications.
iOS Sound FileYesiOS sound or the file URL if custom.
iOS Badge CountYesBadge count on iOS notification.
iOS CategoryYesCategory for iOS push notifications (if applicable).
iOS Deep Link / External URLYesDeep link for iOS push notifications.
iOS Mutable ContentYesShows whether the content is mutable. The values are Yes/No.
Android SubtitleYesSubtitle of the Android push notifications.
Android Image URLYesImage URL for Android push notifications.
Android SummaryYesSummary text for Android push notifications.
Android Large Icon URLYesLarge icon for Android push notifications.
Android Small App Icon ColorYesSmall app icon for Android push notifications.
Android Deep Link / External URLYesDeep link for Android push notifications.
Android Sound FileYesThe values are:

NA
Default OS sound
* file URL, if the file is custom
Android Notification Tray PriorityYesShows the priority of display in tray of android device.
Android Notification Delivery PriorityYesServer priority for Android push notifications.
Collapse NotificationYesShows whether the notification is collapsible or not.
Notification ChannelsYesCommunication channel, for which the user consent is received.
Badge IDYesBadge ID for Android push notifications.
Badge IconYesBadge count Android push notifications.
Send to App Inbox as WellYesApplicable only for push. Sent to app inbox as well or not.
Time to LiveYesTime for the notification to live in the user device.
SMS / Email / WA Service ProviderYesThe service provider.
Start DateYesStart date of the campaign.
Start TimeYesDisplays the start time of the campaign. Displays the time value if the campaign is set to best time.
Conversion EventYesThe conversion is tracked for this event in the campaign.
Conversion Time (in minutes)YesTime period within which conversion is tracked for the campaign.
Campaign URLYesThe URL of the campaign to access it on Clevertap dashboard.
StatusYesCurrent status of the campaign.
Created ByYesThe creator of the campaign.
Created TimeYesTime of creating the campaign.
LabelsYesThe Labels / tags used to identify and organize campaigns.
AmplifiedByInboxYesShows whether the campaign was amplified by sending it to inbox as well or not.
AmplifiedByPushYesIf push amplification is applied or not.
Web PriorityYesPriority of web notifications. It can be high, medium, or low.
Run DateYesApplicable for day-wise reports only. Displays the run date.
Total Sent (users)YesDisplays the total count for the sent users. Shows as N/A for channels that are not supported, such as in-app.
Total Viewed (users)YesDisplays the total count for the users who viewed the notification.
Total Clicked (users)YesDisplays the total count for the users who clicked the notification.
Total Sent (events)YesTotal events. Total devices (if Send to all is applied).
Total Viewed (events)YesTotal events. Total devices (in case of Send to all is applied).
Total Clicked (events)YesTotal events. Total devices (in case of Send to all is applied).
ErrorsYesErrors.
Click Through ConversionsYesTotal converting users (as per funnel, including clicked step).
Click Through Conversions %YesTotal converting users / Total sent users.
Click Through Conversion RevenueYesRevenue as per the revenue property related to Total conversions.
Total Control Group CountYesTotal number of users in control group.
Total Control Group ConversionsYesTotal number of control group users converting.
Total Control Group Conversions %YesTotal number of control group users converting / Total number of users in control group.
Total Control Group RevenueYesRevenue as per revenue property related to conversion.
Unique Sent (users)YesUnique users who were sent notification.
Unique Viewed Within Conversion TimeYesUnique users who viewed the notifications within the set conversion time.
Unique Clicked Within Conversion TimeYesUnique users who clicked the notifications within set conversion time.
Unique Converted Within Conversion TimeYesUnique users who converted within the set conversion time.
Revenue Within Conversion TimeYesRevenue as per the revenue property related to conversion.
View Through ConversionsYesUsers who were sent a message and they converted. Referred as influenced conversions on the dashboard.
View Through Conversions %YesInfluenced conversion (above) / Total sent users.
View Through Conversions RevenueYesRevenue as per the revenue property related to conversion.
System Control Group ConversionsYesTotal number of system control group users converting.
System Control Group Conversions %YesTotal number of system control group users converting / Total number of users in system control group.
System Control Group RevenueYesRevenue as per the revenue property related to conversion.
Campaign Control Group ConversionsYesTotal number of campaign control group users converting.
Campaign Control Group Conversions %YesTotal number of campaign control group users converting / Total number of users in campaign control group.
Campaign Control Group RevenueYesRevenue as per the revenue property related to conversion.
Custom Control Group ConversionsYesTotal number of custom control group users converting.
Custom Control Group Conversions %YesTotal number of custom control group users converting / Total number of users in custom control group.
Custom Control Group RevenueYesRevenue as per the revenue property related to conversion.
Custom Control Group NameYesName of the custom control group.
System Control Group CountYesTotal number of users in system control group.
Custom Control Group CountYesTotal number of users in custom control group.
Campaign Control Group CountYesTotal number of users in campaign control group.
Invalid FCM KeyYesCampaign error description.
App Uninstalled (Android)YesCampaign error description.
Wrong FCM API keyYesCampaign error description.
Invalid APNS CertificateYesCampaign error description.
APNS ErrorYesCampaign error description.
APNS Format ErrorYesCampaign error description.
APNS Account Temporarily BlacklistedYesCampaign error description.
App Uninstalled (iOS)YesCampaign error description.
Invalid ProfilesYesCampaign error description.
Duplicate APNS TokenYesCampaign error description.
Invalid Token - FCMYesCampaign error description.
Unknown Error - FCMYesCampaign error description.
Dispatch ErrorYesCampaign error description.
Internal Error Due to AmplificationYesCampaign error description.
Global Frequency Cap ExceededYesCampaign error description.
Campaign Frequency Cap ExceededYesCampaign error description.
Campaign Limit Reached for DayYesCampaign error description.
Campaign Limit Reached for RunYesCampaign error description.
Profile Not ReachableYesCampaign error description.
Campaign StoppedYesCampaign error description.
User DNDYesCampaign error description.
Duplicate Profile for ChannelYesCampaign error description.
APNS Bad Topic ErrorYesCampaign error description.
APNS Disallowed TopicYesCampaign error description.
APNS Bad Device TokenYesCampaign error description.
APNS Device Token and Topic MismatchYesCampaign error description.
APNS Inactive Device Token for TopicYesCampaign error description.
APNS Wrong Environment CertificateYesCampaign error description.
APNS Bad CertificateYesCampaign error description.
APNS Idle TimeoutYesCampaign error description.
APNS Missing Certificate TopicYesCampaign error description.
APNS Bad PriorityYesCampaign error description.
FCM Payload Too LargeYesCampaign error description.
User Not ReachableYesCampaign error description.
User Not QualifiedYesCampaign error description.
Notification during Campaign DNDYesCampaign error description.
Campaign Cut-off Time ReachedYesCampaign error description.