Overview

This document provides information about the file format and the name format of the files exported to different Datawarehouse partners.

Event Export

File Name Format

The example below shows the file name format for event export:

<export request id>-<timestamp of the export run>-<event name>-<yyyymmdd>-<file index>-<database-id>.json

• Export request ID: Indicates the export request ID generated when you create a request in the CleverTap dashboard.
• Timestamp of export run: Indicates when the export was run.
• Event name: Indicates the event type that is included in the file.
• File index: We chunk the data across multiple files for larger exports. We limit file sizes to 100 MB chunks to make them more consumable. The file index indicates the file number in the file series.
• Database ID: Indicates the database ID of the CleverTap from where the file was exported.
• File format: Indicates the format of the file exported to the S3 bucket.

File Data Format

Event Export Schema

Event Properties

Notification Sent

This event is tracked when a campaign message is sent to a user. This event is always recorded, even if the user does not open or click on the message. This event is recorded for Email, Mobile Push, SMS, Web Push, and Facebook Audience campaigns. It is available under the Event page on the dashboard but not displayed under the user profile.

Notification Viewed

This event is tracked when a user views an Email, In-App notification, or Web notification sent from the CleverTap dashboard.

Notification Clicked

This event is tracked only when a user clicks on the campaign sent via CleverTap.

Push Impression

This event is raised when a push notification is delivered/rendered on the device.

Notification Replies

This event is raised when a user replies to any WhatsApp campaign.

Notification Delivered

This event is captured when messages get delivered to the user's WhatsApp app. (Raised only for WhatsApp).

Reply Sent

This event is recorded when an agent (CleverTap user) replies to a message from the end user.

App Installed

This event is recorded when the user installs the application.

App Launched

This event is recorded every time the user launches the application.

App Uninstalled

This event is recorded every time the user uninstalls the application.

Webhook Delivered

This event is recorded when a Webhook campaign is delivered successfully.

Channel Unsubscribed

This event is raised when a user unsubscribe from any groups in an Email.

Custom Control Group

This event is raised when a campaign is activated with a Control group.

System Control Group

This event is raised when a campaign is activated with a Control group.

Custom & Journey Control Group (Journeys)

This event is raised when a Journey Campaign is activated with a Control group.

System Control Group (Journeys)

This event is raised when a Journey Campaign is activated with a Control group.

Geocluster Entered

This event is raised when a user enters a Geo Cluster.

GeoCluster Exited

This event is raised when a user enters a Geo Cluster.

AB Experiment Stopped

This event is raised when the A/B experiment is stopped.

AB Experiment Rolled Out

This event is raised when the A/B experiment is sent to users.

AB Experiment Disqualified

This event is raised when a user is disqualified from the A/B experiment.

AB Experiment Rendered

This event is raised when the A/B experiment is rendered to a user.

State Transitioned

This event is recorded for lifecycle optimizer when a user transitions from one stage to another.

Session Concluded

This event is raised when a user session is completed.

UTM Visited

This event is tracked when a user clicks on a link from a marketing campaign that has a UTM parameter defined on it.

User Profile Export

File Name Format

<export request id>-<timestamp of the export run>-<event name>-<yyyymmdd>-<file index>-<database-id>.json

• File Name Format for User Profile Export:
  The example below shows the file name format for user profile export:
  • Account ID: Indicates the integer value for your CleverTap project ID.
  • Request ID: Indicates the export request ID generated when you create a request in the CleverTap dashboard.
  • Timestamp of export run: Indicates when the export was run.
  • Database ID: Indicates the database ID of the CleverTap from where the file was exported.
  • File format: Indicates the format of the file exported to the S3 bucket.

<account id>-<request id>-<timestamp of the export run>-<database-id>-<file format>.gz

File Data Format

Files are split by event names for event exports and each file will have all event data for the given period for the event.

JSON

The first line of the file contains the event name. After the first line, each line in JSON describes the timestamp, object id, and event properties.

{
	"profile": {
		"identity": "dqsndckfk234"
	},
	"ts": 20171109000015,
	"eventProps": {
		"ct_connected_to_wifi": "false",
		"ct_bluetooth_version": "ble",
		"ct_bluetooth_enabled": "false",
		"ct_sdk_version": 30107,
		"ct_latitude": -6.1975594,
		"ct_longitude": 106.52913,
		"ct_os_version": "5.1.1",
		"ct_app_version": "2.30.1",
		"ct_network_carrier": "3",
		"ct_network_type": "4G"
	}
}

CSV

CSV files are comma-delimited and have each event in separate rows.

XML

XML has the timeStamp, eventName, followed by eventProperties.

<Event>
    <ts>20200220130735</ts>
    <eventName>Export Custom Event</eventName>
    <profile>
        <all_identities>[email protected]</all_identities>
        <platform>Web</platform>
        <email>[email protected]</email>
    </profile>
    <deviceInfo>
        <browser>Others</browser>
    </deviceInfo>
    <eventProps>
        <entry>
            <key>CT Source</key>
            <value>API</value>
        </entry>
        <entry>
            <key>Category</key>
            <value>Mens Watch</value>
        </entry>
        <entry>
            <key>Product name</key>
            <value>Casio Chronograph Watch</value>
        </entry>
        <entry>
            <key>Price</key>
            <value>59.99</value>
        </entry>
        <entry>
            <key>Currency</key>
            <value>USD</value>
        </entry>
    </eventProps>
</Event>

Parquet

Parquet has a timestamp, eventName, and eventProperties for each event.

📘

Parquet File Format

Parquet is an open-source file format for Hadoop. Parquet stores nested data structures in a flat columnar format.