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.
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 | 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 | 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 |
Updated 15 days ago