Nomenclature for Reports
Learn the naming conventions and formats used for reports.
This document explains the naming conventions and formats used in Reports. This guide helps you interpret data specific to each channel.
Important Points to Remember
File Protection
The reports generated for campaign data are password-protected to ensure the security and confidentiality of the information. Only authorized users with a password can access these reports.
Forgot your Report Password?
If you lose the report password, you can retrieve it by navigating to Profile > Account Configuration > Report Password.
Naming Convention
The naming convention for report filenames is structured to provide clear identification.
Report | Naming Convention |
---|---|
Format | JobID_Scheduled_[Campaign/Journey]Multi[Channel][Summary/Detailed][Frequency-type]\_[Frequency]\_Encoding.zip |
Example | 1234567-Campaign_ID-12345_Apn_Detailed_20240802-cWFfbWFudWFsMV8xNzIyNTY5Mzgy |
Refer to the table below to understand the naming convention for the report title.
Filename Component | Description |
---|---|
JobID | Unique identifier for the report generation job. |
Scheduled | Indicates whether the report is scheduled. |
[Campaign/Journey]Multi[Channel] | Specifies whether the report is for a campaign or a journey. |
Summary/Detailed | Indicates whether the report is summary or detailed. |
[Frequency-type]_[Frequency] | Describes the frequency of the report (For example, daily or weekly). |
Encoding | Refers to the encoding format used (For example, zip). |
Number of Files for Campaigns and Journeys
Our reporting system covers both campaigns and journeys. Campaign reports include a detailed file for each channel (like Email or SMS) and a summary file for all channels. Journey reports provide multiple detailed files based on the journey's complexity, plus a summary file for an overview.
Naming Conventions
- For campaigns, files are named based on the channel, For example., Email_Detailed.zip, SMS_Summary.zip.
- For journeys, files are named according to the journey and node specifics, For example, Journey_Node1_Detailed.zip.
Email Subject Line Format for Reports
- One-Time Download Email Subject Line
Format: One-time Download: <Campaign or Journey name>, <Filename datapoints>
Example: One-time Download: Loyal users offer, Campaign_ID-38_Email_Summary_20221103- Recurring Download Email Subject Line
Format: Scheduled Report: ,
Example: Scheduled Daily Report: Email Summary sync, Campaign_Multi_Email_Summary_Daily_T-1_20221103
Nomenclature for Column Placement
- The first column of the downloaded report displays the Primary key.
- After the basic fields (like Primary Key, Email, Mobile, Campaign name, and so on), you will find additional metrics specific to each channel. For example, in Email reports, you'll see metrics like Subject, Status, and Segment names after the basic fields.
CE Dashboard Data VS User Level Detailed Report
CE Dashboard Data
Based on type engagement strategies, the CE Dashboard data is categorised into:
- Journey Data Report
In the Journey, metrics are tracked based on unique Transaction IDs (TRIDs) rather than total interactions.
What is TRID?
A TRID (Transaction ID) is a unique identifier for each user’s interaction with journey, consisting of the User ID, Automation ID, and timestamp of the event. TRIDs allow tracking of multiple interactions from the same user across various devices.
TRID is the combination of the following components:
CID: Panel Client ID
MID: Message ID
UID: User ID
AID: Automation ID
ADAT: Activity Date and TimeWhy TRID Matters:
This ensures that each unique interaction is accurately counted and prevents misleading data. Even though the same user may interact multiple times with the campaign, they will be counted appropriately based on each separate instance of engagement.
Use Case: Email Node Interaction:
If a user receives 5 email messages through different nodes in a Journey, the Sent count in the Journey dashboard will show 5, as each email sent is considered a unique interaction. However, If the user opens only 3 out of these 5 emails, the Open count will reflect 3 on the Journey dashboard.
- Campaign Data Report
In the Campaign dashboard, metrics like Sent, Delivered, Opens, and Clicks are based on unique user interactions. It means that even if the same user engages with the campaign multiple times across different devices, they are counted as a single unique interaction.
Use Case: Campaign Interaction:
If a campaign is sent to 3 users:
- User 1 has 2 devices.
- User 2 has 1 device.
- User 3 has 3 devices.
The Sent count in the Campaign Dashboard shows 3, as each unique user is counted once, regardless of how many devices they use. If these users interact with the campaign, User 1 interacts with it on both devices, so the system counts it as 1 unique interaction. User 2 interacts on 1 device, counted as 1 unique interaction. User 3 interacts on 3 devices, but they are still counted as 1 unique interaction.
User Level Detailed Report
This report captures every interaction at the user level, including multiple interactions on different devices. This means that if a user interacts with the campaign on multiple devices, each device interaction is counted separately.
Example:
If User 1 views the campaign on 2 devices, User 2 views the campaign on 1 device, and User 3 uses his 3 devices to view the campaign, the detailed report will show 6 interactions (2 + 1 + 3).
Important
The User Level Detailed Report Data cannot be compared directly with the Summary Report Data, as the the detailed report records all interactions across devices.
Metrics and Formulas for UI Pages & Reports
This sheet outlines the detailed performance metrics, their descriptions, and the corresponding formulas for various UI pages and reports on the platform.
Sample Reports
This sheet includes sample reports (both detailed and summary) for all the communication channels.
Campaign Type | Channel | Summary Report | Detailed Report |
---|---|---|---|
Campaigns | Email Summary Report | Email Detailed Report | |
Campaigns | Email: Split | NA | Split Email Report |
Campaigns | Email: AMP | NA | AMP Email Report |
Campaigns | Email: A/B Testing | NA | A/B Testing Email Report |
Campaigns | SMS | SMS Summary Report | SMS Detailed Report |
Campaigns | Web Push | Web Push Summary Report | NA |
Campaigns | App Push | App Push Summary Report | App Push Detailed Report |
Campaigns | App Push | NA | A/B Testing Campaign App Push Report |
Campaigns | App Push | NA | Split Campaign App Push Report |
Campaigns | App Push | NA | Multi Message App Push Report |
Campaigns | Whatsapp Summary Report | NA | |
On-site | Web Message | Web Message Summary Report | Web Message Detailed Report |
On-site | In app Message | In app message Summary Report | In app message Detailed Report |
Journey | All channels | Journey Summary Report | NA |
Journey | App Push | NA | Journey Detailed Report |
Journey | NA | Journey Detailed Report | |
Journey | RCS | NA | Journey Detailed Report |
Journey | SMS | NA | Journey Detailed Report |
Journey | NA | Journey Detailed Report |
This sheet includes sample reports for all features.
Feature | Report |
---|---|
List | List Report |
Blacklist Contact | Blacklist Contact Report |
Segment | Segment Report |
Content Personalization | Content Personalization Report |
User Data Table | User Data Table Report |
Event Data | Event Data Report Schedular |
Updated 19 days ago