Event

Singular has built the only unified marketing intelligence platform that delivers attribution, cost aggregation, creative reporting and workflow automation in one place, giving marketers access to unparalleled data granularity.

This integration was previously available under the name ‘Apsalar’, which was recently acquired by Singular. It also replaces the deprecated Singular event integration. If you are still using the deprecated integration, you can find docs here.

mParticle provides two methods of integrating with Singular: embedded kit and server-to-server.

Supported Features

• User Analytics
• Deep Linking

Embedded Kit Integration

Mobile

By including the Singular kit in your mParticle SDK, every Singular feature represented in the mParticle SDK is supported, including deep linking/deferred deep linking.

• Android
• Apple

To use the Deferred Deep Linking functionality, you will need to set a timeout in the Configuration Settings. This defaults to 60 seconds.

You can access the Singular deep link from within your app using mParticle’s deep linking APIs:

[[MParticle sharedInstance] kitInstance:@(MPKitInstanceSingular) completionHandler:^(id  _Nullable kitInstance) {
        [[MParticle sharedInstance] checkForDeferredDeepLinkWithCompletionHandler:^(NSDictionary<NSString *,NSString *> * _Nullable params, NSError * _Nullable error) {
            //check for SINGULAR_DEEPLINK_KEY
        }];
}];

MParticle.getInstance().checkForDeepLink(new DeepLinkListener() {
    @Override
    public void onResult(DeepLinkResult result) {
        if (result.getServiceProviderId() == ServiceProviders.SINGULAR) {
            //handle Singular link
        }
    }

    @Override
    public void onError(DeepLinkError error) {

    }
});

Web

The mParticle-Singular Web Kit enables event forwarding from the mParticle SDK to the Singular SDK.

When this connection is enabled in the mParticle platform, the mParticle SDK will initialize the Singular SDK and forward events.

Server to Server Integration

mParticle forwards events to Singular via their Server-to-Server API. If you choose to forward ‘Launch’ events to Singular, a Launch event will be sent each time a session begins in your app. Singular will interpret the first Launch event for a device as an Install event. All App events, Screenview events and Commerce events will be forwarded. If you are using the mParticle SDKs in your app, standard device information will be forwarded automatically, along with a dictionary of product attributes, for commerce events, or event attributes, for app events and screenviews.

Prerequisites

To activate mParticle’s Singular integration, you will need the API Key for each app that you’d like to setup. Please contact your Singular account representative if you need help locating your API Key. To use the embedded kit, you will also need your API Secret.

mParticle forwards events to Singular via their Server-to-Server API. If you choose to forward ‘Launch’ events to Singular, a Launch event will be sent each time a session begins in your app. Singular will interpret the first Launch event for a device as an Install event. All App events, Screenview events and Commerce events will be forwarded. If you are using the mParticle SDKs in your app, standard device information will be forwarded automatically, along with a dictionary of product attributes, for commerce events, or event attributes, for app events and screenviews.

Data Processing Notes

• Event Names may be truncated to 32 characters.
• Singular allows a maximum of 400 unique event names
• For the additional attributes JSON object, keys are restricted to a maximum of 255 characters, and values to a maximum of 500 characters.
• The entire query string cannot exceed 4000 characters. Any attributes that would cause this limit to be exceeded will be dropped.

See Singular’s documentation for the latest information about event limitations.

Event Data Mapping

Basic fields sent for all events

These parameters will be sent automatically with every event.

Additional Parameters for Launch event

These parameters will be sent automatically with Launch events.

Additional Parameters for App Events

mParticle will forward App events, Commerce Events and Screenview events to Singular with the following attributes.

Additional Attributes

Any additional attributes for each event will be forwarded as a JSON object. For Commerce events, a products array will be sent which includes id, name, brand, category, and quantity for each product. For non-commerce events, any available event attributes will be forwarded.

Configuration Settings

Connection Settings