Singular (formerly known as Apsalar)

Overview

Singular, a marketing analytics platform, empowers businesses to drive growth by delivering attribution, cost aggregation, marketing analytics, creative reporting, and workflow automation. This document provides information about integrating Singular and CleverTap. This integration helps track the following information from Singular:

  • Install events: These events can be organic install events and inorganic install events.
  • Custom events: These events can include any events (other than install events) that are provided by the attribution partner and tracked in the app. The following events are tracked for Singular Revenue events and Fraud Data.

To learn more about these events and their default attribution settings on the CleverTap dashboard, refer to Types of Data.

Integrating Singular

To enable Singular integration with the CleverTap dashboard:

  1. Add CleverTap Credentials to Singular Dashboard:
    To activate integration with CleverTap from the Singular dashboard, follow the steps listed under Partner Configuration in Singular documentation.
  2. Integrate Singular.
  3. Setup for Organic Install and Custom Events.

Integrate Singular

Singular SDK's implementation requires CleverTap ID configured as a Singular custom userId.

๐Ÿšง

Warning

Only the events with the clevertapId parameter in postback are processed.

The integration steps vary for Android and iOS. The steps for both are listed below.

For Android App

  1. To track attribution and events data in your Android app, perform the steps listed in Singular Android SDK Integration Guide.
  2. Set the value of CleverTap ID as the Singular Global Property. To do so, add the following code to your Android app code. For more information, click here.

For SDK version 4.2.0 and above

The getCleverTapAttributionIdentifier method is deprecated for CleverTap Android SDKs version 4.2.0 and above. Use the new getCleverTapID method to get the CleverTap ID on the OnInitCleverTapIDListener to set GlobalProperty of Singular.

cleverTapInstance.getCleverTapID(new OnInitCleverTapIDListener() {
   @Override
   public void onInitCleverTapID(final String cleverTapID) {
       // Callback on main thread
      SingularSDK.setGlobalProperty("CLEVERTAPID", cleverTapID, true);
   }   
});

For SDK version 4.1.1 and below

String attributionID = cleverTapInstance.getCleverTapAttributionIdentifier();
SingularSDK.setGlobalProperty("CLEVERTAPID", attributionID, true);

For iOS App

To integrate Singular with CleverTap for an iOS app:

  1. To track attribution and events data in your iOS app, perform the steps listed in Singular iOS SDK Integration Guide.
  2. Add the below code to your iOS app code. For more information about setting Singular Global Property, refer to Singular documentation.
[CleverTap autoIntegrate];
[Singular setGlobalProperty:@"CLEVERTAPID" value:[[CleverTap sharedInstance] profileGetCleverTapAttributionIdentifier] overrideExisting:YES];

Setup for Organic Install and Custom Events

After successful integration, Singular sends inorganic install events data to CleverTap. To receive additional events, proceed as follows:

  1. Navigate to Settings > Partners and scroll down to the Attribution partners section.
2868

CleverTap Attribution Partners

  1. Click the Edit icon against the Singular partner.
    On clicking, Attribution partner - Singular popup appears on the right side of the screen.
2374

Attribution Partner - Singular

  1. Select the required option from the following available options. Selecting any of these options indicates that the CleverTap accepts event data when shared by the partner.
    • Custom events
    • Organic install events

๐Ÿšง

Duplication of Events

If you select Organic install events for more than one attribution partner, a warning for duplication of events displays, as shown in the following figure. We strongly recommend tracking the organic install events from only one attribution partner.

1124

Duplication of Events

  1. Click Save. On clicking, the following message displays at the top of the screen: Changes saved. Admins are notified of this via email.

Viewing Data in Dashboard

You can now view the event data in the CleverTap dashboard. To do so, proceed as follows:

  1. From the CleverTap dashboard, navigate to Analytics > Events.
  2. Apply the required filters for the selected event. The filters vary depending upon the type of event.
  • For Install Events: All the install events are tracked under the UTM Visited event.
1686

Filter Install Events

  • For Custom Events: Revenue and Custom events received from Singular are prefixed with AP in CleverTap.