Campaign Reports

View Comprehensive reports for your Campaigns.

Overview

Campaign reports provide you with campaign performance at a glance. Using these reports, you can compare campaigns' performance and understand engagement trends. You can email or export the summary report of all campaigns sent out for a specific period or even for a specific 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 4 hours earlier. The report may take up to 6 hours, depending on the other activities happening when requesting the report.

Generate Reports

You can view the campaigns from the campaigns list page. You can either email a report or export the reports to Amazon S3 or Google Cloud Platform bucket.

To view a report:

  1. Navigate to the Campaigns page from the main menu. The Campaign List page opens.
  2. Select the campaigns or select the filter criteria to export the reports for the required campaigns.
1376

Generate Campaign Reports

  1. Click the Email Report icon or the Subscribe to Reports link. The Campaign Report window opens on the right side.

  2. Configure the following settings:

Field

Description

Report name

Enter the name to identify your report uniquely.

Create a report. for

Select from the following options for which you want to create a report:

  • 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

Select the data from the following options that you want to include in the report:

  • Campaign overview
  • Campaign stats
  • Campaign detailed stats
  • Campaign errors

Split all data by

Select the option to split your data. The following are the available options:

  • Day
  • OS
  • Variant type

Note: Split data by day is unavailable if the date range is more than 60 days on the campaigns page.

Frequency

Select the export frequency for your report. The following are the available options:

  • One-time
  • Recurring

Delivery Method

Select from the following delivery options:

  • Email: You must enter the recipient's email address when you select this option.
  • Partner Export: Select any one from the following export partners and then select the bucket where you want to export the reports:
    • Amazon S3
    • Google Cloud Platform

The reports are always exported in CSV format.

1696

Setup Campaign Reports

  1. Click Send Report to send the report immediately or click Subscribe to send the reports at defined intervals.

You can include Campaign stats and Campaign overview in the campaign report for a maximum of 2500 campaigns. Also, you can include Campaign detailed stats in the campaign report for a maximum of 2000 campaigns.

You can view your campaign reports by navigating to FileDir:<accountID>/reports/ from your partner bucket. The report file name will be in the following format: reportName_Timestamp.csv, where Timestamp indicates the time when the report is delivered.

Subscribe to Reports

You may want to subscribe to a report in various scenarios. For example, select and subscribe to 4 campaigns on a monthly recurrence, or only subscribe to push campaigns that you created with a label for a monthly/daily recurrence.
The subscriptions are displayed on the Subscriptions tab of the Campaign Report window. To create a new report or create a new report subscription, refer to Generate Reports.

Edit/Delete Reports

The existing schedule for the reports is displayed on the Subscribe tab. To edit or delete a subscription to a report,

  1. Click Subscribe to Reports on the campaign list page. The Campaign Summary Emails pane appears.
  2. Select the Subscriptions tab
  3. Click the ellipsis icon to edit or delete a report subscription.
570

Edit or Delete a Report Subscription

Reports API

You can use the Get Campaign Report API to programmatically generate campaign reports for your consumption.

Campaign Report Data

The following table provides all the report's columns 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 appears as a column in your report only if you select Campaign overview when 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, and so on 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 colour

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 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 Enhanced Push Delivery 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 reach 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.

πŸ“˜

Send Copy of Push Campaign to App Inbox

When you choose to send a copy of a Push campaign to the App Inbox, it appears as a single campaign on the All Campaigns page on the dashboard. However, you will see two separate entries for the campaign in the campaign reports.

πŸ“˜

Conversion Tracking Rules

To understand how CleverTap tracks conversions, it is essential to note the following rules:

  • User is considered converted if they complete a conversion evnt within the conversion timeline.

  • User is only counted as converted once for a particular conversion event within a campaign. For example, if a user completes the same conversion event multiple times within the same conversion timeline, it will only be counted once.

  • If a user completes a conversion event within the same timeline for multiple campaigns, it is attributed to all the campaigns.

  • A user is considered converted even if they do not open or click the message as long as they complete the conversion event within the conversion timeline. This is known as an influenced conversion.