Amplitude Export

Analytics Partner

Overview

Amplitude, an analytics and business intelligence platform, helps make informed decisions for targeting users. Integration CleverTap with Amplitude allows you to export your CleverTap event data to your Amplitude dashboard. You can use this event data for further analysis.

Integrate Amplitude with CleverTap

This process involves the following two steps:

  1. Find Amplitude Project Details.
  2. Configure CleverTap Dashboard.

Find Amplitude Project Details

  1. Log in to your Amplitude account.
  2. Navigate to the Settings page.
  3. Navigate to Org Settings > Projects.
  4. Click on a project to find the API Key under the General tab.
3552

Finding API Key

Configure CleverTap Dashboard

To configure the CleverTap dashboard:

  1. Navigate to Settings > Partners > Partner List from the CleverTap dashboard. Select Amplitude from the list.

    Navigate to the Partner Page

    Navigate to the Partner Page

  2. A popup opens on the right side of the screen. Enter the following details and click Integrate:

Field

Description

Partner Nickname

Enter the Nickname for your integration.

API key

The unique code for Amplitude to verify your credentials. For more information about obtaining the key, refer to Find Amplitude Details.

Data Residency

The Data Residency is the physical/geographical storage location of data for each project.

  • Select from the following available options:
    • Europe (default)
    • Standard
Device ID MappingThis field is mapped to Amplitude's device_id field for identification when sending data from CleverTap to Amplitude.
User ID MappingThis field is mapped to Amplitude's user_id field for identification when sending data from CleverTap to Amplitude.

After successful integration, navigate to the the Export tab on the Partner List page.

Amplitude Export

Amplitude Export

Create New Export

This section lists steps to create a new export from the CleverTap dashboard.

To create a new export:

  1. Navigate to Settings > Partners > Exports from the CleverTap dashboard.
  2. Click Create Export and select Amplitude.
Create Export

Create Export

The Export to Amplitude window displays.

Enter Export Details

Enter Export Details

  1. Configure the following settings:
    • Partner Nickname: Nickname for the partner. To edit the nickname, go to Partner List.
    • DATA TYPE & IDENTIFIER PRIORITY: Select the events from the available options to export. For more information, refer to Export Details.
    • FREQUENCY: Select from one of the following options:
      • One time: A single export for the selected export type. You can export data up to the last 60 days. You create an export for a specific day, date range, previous month, current month, and more.
      • Recurring: Set up a recurring export that exports all the new events/user profiles captured in the last window. You can export as frequently as every 4 hours and up to once every 24 hours.
      • Date to export data: The export starts at 12:00 a.m. on the specified date by default.
  2. Click Export. The Export to Amplitude window closes, and the following message displays at the top of the Exports page:
Amplitude Export Initiated

Amplitude Export Initiated

CleverTap processes the export, and you can now see the newly created export for Amplitude.

New Amplitude Export Displays on Export Page

New Amplitude Export Displays on Export Page

The status for each export is displayed as PENDING as soon as the export is created. The status changes to RUNNING after the processing starts. In the case of One time export, the status changes to DONE when the export is complete.

Stop Export

You can also stop the export that you have created. Hover over the export. The Stop button appears. Click the Stop Stop export button for the export request you want to stop.

Stop Amplitude Export

Stop Amplitude Export

The Stop export? window appears. Click Stop to confirm your action.

You now return to the Exports page, and the Amplitude data export stopped message displays at the top. The status of the export is displayed as STOPPED.

Amplitude Export Stopped

Amplitude Export Stopped

Edit an Export

You might need to modify an export to meet specific business requirements or while waiting for the next run. This section describes editing a Live Data Streaming and Recurring export in the RUNNING and PENDING (awaiting next run) state.

πŸ“˜

Points to Remember

  • In case of running exports, the new changes will apply to the next run.
  • You cannot edit a One-time export, regardless its status (RUNNING, PENDING, DONE, or STOPPED).
  • You cannot change the export from User Profile to Event and vice-versa.
  • You cannot modify exports marked as DONE or STOPPED.
  • Export changes for Live DataStreaming take 10-15 minutes to take effect.

To edit an export:

  1. On the CleverTap dashboard, go to Partners > Exports.
  2. Hover over the required export. The View, Edit, and the Stop buttons appear.
Click the Edit Export Icon

Click the Edit Export Icon

  1. Click the Edit button. The Export to Amplitude section appears.
Edit the Export

Edit the Export

  1. Edit the export details and click Update export.

πŸ“˜

Modify Export Frequency

When you change the export frequency, the export cycle resets and begins at midnight (12:00 a.m.) on the specified date following the new schedule.

For example, if the last export occurred at 4:00 p.m., the next export cycle will start at midnight (12:00 a.m.) and continue according to the new 12-hour schedule thereafter.

Filter Exports

This section describes the different ways you can filter exports.

Filter by Export Details

To filter by export details:

  1. Click the Filter button at the top right corner.
  2. You can filter exports by Partner, Type, Format, Status, or Frequency.
  3. To clear the filter, click Reset all.
Filter Exports

Filter Exports

Filter Exports by Date Range

You can also filter the exports based on the export date.

To filter exports by export date range:

  1. Click the Filter button at the top right corner.
  2. Click the Exported on button.
    The Calendar widget appears.
Calendar Widget

Calendar Widget

  1. Choose the custom date range and click Apply.
    The exports are filtered accordingly.

Filter Exports by Pagination

To choose how many export items you view per page:

  1. Use the Items per page drop-down at the bottom of the Exports page.
  2. Options include 10, 20, 30, or 40. By default, the Exports page shows 20 exports.

Export Details

Select from one of the following options to export events from CleverTap to the Amplitude dashboard:

All events

Export data for all defined events, including System and Custom events.

Selected events

Select the specific events you want to export from CleverTap to the Amplitude dashboard.

Engagement Events

Select this option to export the following engagement events:

CleverTap Event Name

Event Description

Notification Sent

The event is tracked when the notification is successfully sent from CleverTap to the communication channel you select for your campaign.

Notification Viewed

This event is tracked when a user views an email, in-app notification, or a web notification sent from CleverTap.

Notification Clicked

This event is tracked only when a user clicks on a notification sent via CleverTap. It is recorded when a user clicks on a mobile push, in-app, email, web popup, or web push message sent via the CleverTap dashboard or through the campaign API.

Push Impressions

This event is tracked when a Push notification sent from CleverTap is delivered on a user’s device.

Notification Replied

This event is tracked when a user replies to a WhatsApp message.

Push Unregistered

The event is raised when the user unregisters to receive Push Notifications.

Control Group

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

Channel Unsubscribed

The event is raised when a user unsubscribes to receive further communication through a channel.

Reachable By

  • The debug event is raised when the user becomes reachable by a communication channel such as SMS, email, or mobile push, or when there are changes to the existing communication channel.
  • Tracked for a profile when:
    • Push token is added/changed.
    • Email ID is added/changed.
    • Phone number is added/changed.
Push ImpressionsThis event is tracked when a push notification sent from CleverTap is delivered on a user’s device. The funnels on the Push campaign statistics page reflect the count for this event.
Notification DeliveredThis event is recorded when communication is delivered to the user's device
AB Experiment RenderedThis event is recorded when communication is delivered to the user who is part of an A/B experiment campaign
AB Experiment StoppedThis event is recorded when AB experiment is stopped.
AB Experiment Rolled OutThis event is recorded when AB experiment is started
Geocluster EnteredThis event is recorded to mark when a device enters a geofence.
Geocluster ExitedThis event is recorded to mark when a device exits a geofence.
Reply SentThis event is recorded when an agent (CleverTap user) replies to a message from the end-user.
App UninstalledThis event is recorded when a user uninstalls your application.
Webhook DeliveredThis event is recorded when a Webhook campaign is delivered successfully
State TransitionedThis event is recorded for Lifecycle Optimizer when a user transitions from one stage to another.
UTM VisitedThis event is tracked when a user clicks on a link from a marketing campaign that has a UTM parameter defined on it.

FAQs

Q. Do CleverTap data exports allow special characters?

A. Yes, CleverTap data exports allow the following special characters:

  • CleverTap's export system supports Unicode (UTF-8) character encoding. It facilitates the accurate representation of text in various languages and scripts. For example, Indian regional languages, Arabic, Korean, Russian, Japanese, Chinese, Spanish, Greek, Indonesian, etc.
  • It replaces the following characters with a hyphen to avoid issues in output file generation:
    • Whitespace
    • Tab
    • Slash
    • null (\0)
  • Control characters are replaced with ?. For more information, refer to Control Character.
  • Supports emoji characters; however, some emojis (UTF-16) may not render properly.