CleverTap Email Service Provider (ESP) Attribution Integration

Follow
Avatar
Shikha Sharma
Updated

Singular's integration with CleverTap lets you measure app installs and re-engagements with CleverTap emails that wrap your deep-link-enabled Singular Links.

While link wrapping usually breaks the deep link experience, this integration allows you to serve deep links as well as measure attributions to both installs and app opens from emails driving users into your mobile app.

The integration is based on a deep-link-enabled click tracking domain (CTD) configured in CleverTap. When emails that include Singular Links are served to your users, CleverTap automatically wraps any Singular Link used in your email. Users who don't have the app installed will be redirected to the fallback configured in your Singular Links. Users who install the app are measured as an app install attributed to the Singular Link.

Returning users will be deep-linked into the app, where deep link handling is handled through your Singular SDK implementation. These users are measured as Re-Engagements to the Singular Link.

Prerequisites

  • Singular Links for iOS and Android
  • Singular SDKs
    • iOS SDK 11.0.0+
    • Android SDK 11.0.0+

Setup Instructions

1

Set Up a Custom Tracking Domain (CTD)

  • Ensure that both iOS Universal Links and Android App Links are supported via HTTPS, and the ESP domain(CTD) is properly configured in the AASA (Apple App Site Association) file for iOS and the assetlinks.json file for Android.

    For example,

    iOS, https://click.companyname.com/.well-known/apple-app-site-association

    Android, https://click.companyname.com/.well-known/assetlinks.json.

     
2

Update Singular SDK Implementation

Register the CleverTap custom tracking domain as an ESP domain, prior to initializing the Singular SDK. This allows the Singular SDK to recognize the custom tracking domain opening the app, allowing the Singular SDK to handle the deep link and attribution the re-engagement.

iOS:

SingularConfig* config = [[SingularConfig alloc] initWithApiKey:apiKey andSecret:secretKey];
config.espDomains = @[@"click.mydomain.com"];

Android:

SingularConfig config = new SingularConfig(apiKey, secretKey)
.withESPDomains(Arrays.asList("click.mydomain.com"));

Additionally, Singular SDK's implementation requires CleverTap ID configured as a Singular custom userId. To implement the same, please visit CleverTap documentation. 
3

Set Up CleverTap on the Singular dashboard and create links to use in the Emails: 

To activate integration with CleverTap from the Singular dashboard, follow the steps listed under Partner Configuration in Singular documentation.

Create a Singular Link for your email, using the same Singular Link subdomain (e.g... "https://<yoursubdomain>.sng.link") used in previous steps.

  • Verify that it has the proper deep link destination(s) enabled and it is configured for ReEngagement Tracking.
  • Be sure to append any reporting parameter you'd like to use for reporting via link parameters.  See all supported granularity parameters.

Place the Singular Link in your email. When users click on this link, CleverTap will wrap this link with your CTD. In the case of a returning user clicking the link, the user will deep link into the app, and the Singular SDK will measure the app open engagement since the CTD is registered in the Singular SDK.

Notes and Tips:

  • Attributions for CleverTap emails work just like any other attributions based on Singular Links. For more information, se Singular Links and Tracking Link Parameters.
  • If your deep link is not working:
    • Ensure your custom tracking domain and destination paths are properly configured in CleverTap. This includes uploading the proper Apple App Site Association file for your app.
    • Ensure that the Singular Link embedded in your emails is also configured with deep linking. You can tell if a Singular Link has deep linking enabled if it has a _dl= parameter in the URL.