CleverTap

Overview

imageimage

Accurately attribute impressions, ad clicks, app installs, and in-app events to evaluate campaign performance for each of your partners.

EVENTS SENT TO DATA PARTNER

The events Branch sends to third party data tools varies based on the events the partner supports as well as whether or not you've implemented the Branch SDK to measure said events.

[INSERT DATA PARTNER NAME] supports the following events:

  • Installs
  • Lifecycle Events
  • Commerce Events
  • Content Events
  • Custom Events

Non-referred events, clicks, web session starts, and pageviews will be excluded. Branch also sends all the data that is attached to the link that drove the referred event. This will allow you to analyze which campaigns, channels, etc. are helping you acquire and engage users.

1. Complete Data Integration Prerequisites

🚧

DEVELOPER REQUIRED

BRANCH

Clevertap

2. Retrieve Keys/Credentials from Your Partner

Before you can enable the integration in your Branch dashboard, you need to retrieve your credentials from your Clevertap account.

Branch requires these credentials to not only authenticate, but to ensure your Branch data is being sent to the correct account.

Branch requires the following credentials:

  • Account ID
  • Account Token
  • Account Passcode

To find your CleverTap Account Credentials:

  1. Log in to your CleverTap account and navigate to Settings by clicking the cog at the top of the screen, then Settings Dashboard.

    imageimage

  2. Ensure you're looking at the correct app for your integration, then click the eye icon to show your account credentials.

    imageimage

  3. Copy these account credentials into the Branch dashboard as instructed below.

3. Enable the Integration

To enable the integration:

  1. In the left-hand navigation, under the Exports section, click Data Feeds.
  2. On the Data Feeds Manager page, click the Data Integrations tab at the top.
  3. Search for and click on your data partner.
  4. Provide the necessary credentials on the data partner's Export page.
  5. Click Enable.

4. Pass ID/Metadata to Branch

Clevertap requires you to pass through the correct identifiers to the Branch SDKs. In order to do so, retrieve the ID from the Clevertap SDK and pass this value to Branch using the following method:

  • setRequestMetadataKey() method of the Branch SDKs:
///Inside `didFinishLaunchingWithOptions`

Branch *branch = [Branch getInstance];
[CleverTap autoIntegrate];
[[Branch getInstance] setRequestMetadataKey:@"$clevertap_attribution_id"
value:[[CleverTap sharedInstance] profileGetCleverTapAttributionIdentifier]];
///Inside `didFinishLaunchingWithOptions`

CleverTap.autoIntegrate()
if let branch = Branch.getInstance() {
    branch.setRequestMetadataKey("$clevertap_attribution_id", value:CleverTap.sharedInstance()?profileGetCleverTapAttributionIdentifier() as NSObject!);
}
///Before you initialize in your Application `#onCreate` or Deep Link Activity’s `#onCreate`

Branch branch = Branch.getInstance();
branch.setRequestMetadata("$clevertap_attribution_id",
cleverTapInstance.getCleverTapAttributionIdentifier());

5. View Branch Data in Clevertap

imageimage

imageimage

For more information on Clevertap's reporting, please refer to their Behavioral Analytics documentation.

Troubleshooting

Testing your CleverTap integration

The simplest way to test your integration is working end to end is to open your app from a Branch link then verify the data appears in CleverTap. After doing this, you will know how you to test more advanced scenarios.

  1. Create a Branch Quick Link at https://dashboard.branch.io/quick-links.
  2. Click that Branch link to open your app.
  3. In your Branch dashboard, verify you see the open event show as a "referred session" with a "session referring link URL" in your Branch dashboard under "Liveview > Events"