File Path and Naming Convention

MoEngage provides two primary options for archiving message data: exporting to an S3 bucket or an SFTP server. Each option has its own directory structure and file naming convention. Select the appropriate tab below to view the details for your configured archival method.

S3 Bucket Archival SFTP Server Archival

The following are the default file paths and file naming conventions for archived messages exported to an S3 bucket.

One-Time Campaign Periodic Campaign Event-Triggered and Business Event Triggered Campaign Inform Alert
Channel and Platform File Path and File Naming Convention
Email

File Path: 

<bucket_name>/{{db_name}}/{{date}}/email/<file>

File Name:

{{id}}_{{cid}}_{{time}}_email.eml

SMS

File Path:

<bucket_name>/{{db_name}}/{{date}}/sms/<file>

File Name:

{{id}}_{{cid}}_{{time}}_sms.json

Push - Android

File Path:

<bucket_name>/{{db_name}}/{{date}}/push/<file>

File Name:

{{id}}_{{cid}}_{{time}}_push_android.json

Push - iOS

File Path:

<bucket_name>/{{db_name}}/{{date}}/push/<file>

File Name:

{{id}}_{{cid}}_{{time}}_push_ios.json

Push - Web

File Path:

<bucket_name>/{{db_name}}/{{date}}/push/<file>

File Name:

{{id}}_{{cid}}_{{time}}_push_web.json

However, you can customize the file naming conventions based on your requirements, whether in the MoEngage S3 bucket or your S3 bucket.

  • You can add any of the following attributes to the file path or file name:
    Attribute Description
    {{cid}} MoEngage Campaign ID
    {{channel}} Channel type
    {{db_name}} Workspace name
    {{date}} Date of archival
    {{id}} ID
    {{moe_transaction_id}} MoEngage transaction ID
    {{time}} Time of archival
    {{moe_event_id}} MoEngage event ID
    {{alert_ID}} Alert ID is for Inform. In the case of Inform, there is no campaign ID.
  • You can change the order of the attributes in the file name. For example, consider the file naming convention for one-time Email campaigns.

    Default:

    MoeCampaignID_ID_epochtime_email.eml

    Customized:

    ID_MoeCampaignID_epochtime_email.eml (here, ID comes before the MoeCampaignID)

Was this article helpful?
0 out of 0 found this helpful

How can we improve this article?