Overview

Segment.io, a Customer Data Platform service provider, provides the capability that simplifies collecting and using data from the users of your digital properties (websites, apps, and so on). With Segment, you can collect, transform, send, and archive your first-party customer data.

Integrate Segment with CleverTap

This process involves the following two steps:

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

Find Segment Project Details

To find your project details:

1. From your Segment.io workspace, navigate to Connections > Catalog.
2. Search for CleverTap in the Sources Catalog, select CleverTap, and click Add Source.
3. Enter a nickname for the Source and configure any other required settings. The nickname is used as a label in the Segment app. And, Segment creates a related schema name in your warehouse. Segment suggests using a nickname that reflects the source and distinguishes environments, such as CleverTap_Prod, CleverTap_Staging, or CleverTap_Dev, though it can be anything.
4. Click Add Source to save your settings.
5. Copy the Write key from the Segment dashboard. You will need it when configuring the CleverTap dashboard.

Configure CleverTap Dashboard

To configure the CleverTap dashboard:

1. Log in to your CleverTap account and navigate to the Settings > Partners > Partner List page.

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

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

Create New Export

To create a new export:

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

The Export to Segment pop-up displays.

3. Configure the following settings:
   • Partner Nickname: Nickname for the partner. To edit the nickname, go to Partner List.
   • DATA TYPE & IDENTIFIER PRIORITY: Select the type of data that you want to export from the available options. 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 frequency to export all the new events at regular intervals. You can export event data 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.
4. Click Export. The Segment export has initiated message displays at the top of the Exports page:

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

The status for a newly-created export is displayed as PENDING. The status changes to RUNNING after the processing starts and DONE when the export is complete.

Stop Export

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

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

You are navigated back to the Exports page, and the Segment data export stopped message displays at the top. The status for the data export now displays as 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.

3. Click the Edit button. The Export to Segment section appears.

4. Edit the export details and click Update export.

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 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.

   

3. 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 Segment dashboard:

• All system events
• Selected events
• Engagement events

All System Events

When you select this option, the following defined system events are exported:

For more information about these events, refer to Events.

Selected Events

With this option, you can select the specific system events (from those listed in the above table) that you want to export from CleverTap to the Segment dashboard.

Engagement Events

When you select this option, the following engagement events are exported:

• Notification Sent
• Notification Viewed
• Notification Clicked
• Push Impressions
• Notification Replied
• Control Group
• Channel Unsubscribed
• Push Impressions
• Notification Delivered
• AB Experiment Rendered
• AB Experiment Stopped
• AB Experiment Rolled Out
• Geocluster Entered
• Geocluster Exited
• Reply Sent
• App Uninstalled
• Webhook Delivered
• State Transitioned
• UTM Visited

For more information about these events, refer to Events.