Nomenclature for Reports
Learn the naming conventions and formats used for reports.
This document explains the naming conventions and formats used for Reports. This guide helps you understand and manage reports easily.
Key areas include:
- Report Filename Format: How report files are named, including dates, campaign IDs, and metrics, to identify their content and purpose.
- Sample Reports for Communication Channels: Examples of report formats for various communication channels, including Email, SMS, APN, Whatsapp, and so on. These samples help you understand how to interpret data specific to each channel.
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.
Naming Nomenclature
The naming convention for reports is structured to provide clear identification and organization. The format is as follows:
JobID_Scheduled_[Campaign/Journey]Multi[Channel][Summary/Detailed][Frequency-type]\_[Frequency]\_Encoding.zip
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 journey and mentions the channel. |
| Summary/Detailed | Indicates whether the report is summary or detailed. |
| [Frequency-type]_[Frequency] | Describes the frequency of the report (e.g., daily, weekly). |
| Encoding | Refers to the encoding format used (e.g. 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, e.g., Email_Detailed.zip, SMS_Summary.zip.
- For journeys, files are named according to the journey and node specifics, e.g., Journey_Node1_Detailed.zip.
Column Placement Logic
If a Primary Key (PK) other than Email or SMS is selected, the first column of the downloaded report will display the chosen primary key. Channel-specific attributes are listed after the common fields (Primary Key, Email, Mobile). For instance, if the channel is Email, attributes such as Email Subject, Open Rate, and others will appear following the common fields. Refer to the table below for the order of metrics based on different primary keys.
The following sheet provides all the sample reports (detailed and summary) based on the selected communication channel.
Report filename format (Email, SMS, APN, BPN campaign reports & all journey reports)
Note: In-app, Web message & WhatsApp reports will not have above convention
One-time download:
<Jobid>-<Mode of communication><_ID><_Channel><_Report type><_Date of request>-<Random string>.zip
e.g. 20388-Campaign_ID-2442_Email_Summary_20230207-cG9kMl9ha3NoYXRhMV8xNjc1Nzc4MjI0.zip
e.g. 20388-Campaign_ID-2442_Email_Summary_20230207-cG9kMl9ha3NoYXRhMV8xNjc1Nzc4MjI0.zip
Recurring download:
<Jobid>-Scheduled<_Mode of communication><_ID><_Channel><_Report type><_Frequency><_Date of request>-<Random string>.zip
e.g. 20388-Campaign_Multi_Email_Summary_20230207-cG9kMl9ha3NoYXRhMV8xNjc1Nzc4MjI0.zip
Legends
- Job ID - Unique ID created for every request
- Mode of communication - Campaign or Journey
- ID - Unique ID for the campaign/journey that the report is requested for (Applicable for single campaign/journey downloads only). In case of multiple campaigns/journeys download - this will be replaced with Multi as a keyword
- Channel - Email/SMS/App push/Web push
- Report type - Summary/Detailed for campaigns, Detailed summary/Custom detailed/Nodewise/Datewise for journeys
- Frequency - Daily/Weekly/Monthly appended with the data requested (T-1, T-3, etc.)
- Date of request - Date of requesting the report
- Random string - an internal string to ensure data security
Email Subject line format for reports (Email, SMS, APN, BPN Campaigns and Journeys)
One-time download email subject line
One-time Download: <Campaign or Journey name>, <Filename datapoints>
e.g. One-time Download: Loyal users offer, Campaign_ID-38_Email_Summary_20221103
Recurring download email subject line
Scheduled <Frequency> Report: <Scheduler name>, <Filename datapoints>
e.g. Scheduled Daily Report: Email Summary sync, Campaign_Multi_Email_Summary_Daily_T-1_20221103
Legends
Note
- Campaign or Journey name - Campaign/Journey name
- Datapoints -
Type of export: One-time download or Recurring download
Filename data points:
Mode of communication - Campaign or Journey
ID - Unique ID for the campaign/journey that the report is requested for (Applicable for single campaign/journey downloads only). In case of multiple campaigns/journeys download - this will be replaced with Multi as a keyword
Channel - Email/SMS/App push/Web push
Report type - Summary/Detailed for campaigns, Detailed summary/Custom detailed/Nodewise/Datewise for journeys
Frequency - Daily/Weekly/Monthly appended with the data requested (T-1, T-3, etc.)
Date of request - Date of requesting the report - Frequency - Daily/Weekly/Monthly
- Job ID, Status & panel name will be part of the email body
Custom Detailed Report (email)
Note
- By default, the summary report you download will include data from the past 7 days. You can also choose to download reports for specific time periods, such as a day, week, month, or a custom range.
- Above note is applicable only for all IA2.0 customers
- In accordance with our data retention policy, you can only access data from the past year for download.
Updated 8 months ago