Integrating the Singular SDK

The Singular SDK can be easily integrated within your App using our SDK documentation.

All the tools for building the integration can be found within Settings → SDK Keys.

SDK Key

This key is used by our servers to identify your account, you will need this value to successfully integrate our SDK.

Developer Account

Using developer account during the Development & QA process helps keep your main account data clean. Each Singular customer gets a Developer Account credentials that can be found in the SDK Keys section:

The developer account contains a separate SDK key that can be used in development versions of your app:

Important: Remember to switch to the main SDK Key before deploying to the App Store

Available SDKs

SDK Console

The SDK Console displays calls for session and event data sent by the Singular SDK or direct use of the Singular Server to Server API. It is a tool for application developers to verify if their instrumented events and sessions are being received by the Singular platform.

To add a device:

Select the Platform and Keyspace of the device that you want to test

Insert the identifier and click "Add"

Once the Device is added, the event logs will start collecting data. You can view event logs for multiple devices at once by selecting the Show/Hide Button:

Please note, you can add up to 20 devices at once.

To Delete a device, simply hover over the Device ID and click the "Delete" button. This will clear all event logs from the screen, but will not clear the attribution.

You can clear a device's attribution by clicking the "Forget" button. This will re-set the attribution for a specific device so you can re-test with the same device.

Once a device is registered, events trigged in the app via the SDK will appear in the console . You can drill down on a specific line item to view more details:

Automatically Tracked Events:

Aside from your explicitly tracked sessions and events, there are some events that are tracked automatically by the SDK and may become useful in debugging/understanding the data in some scenarios:

SDK Event Name

Description

__installReferrer__

Android Only - This event contains the payload of the Android install referrer (when available). If the Android install referrer is implemented, this event is automatically sent shortly after the Android SDK initialization. This event is used as part of the Singular attribution process.

__iAd_Attribution__

iOS Only - This event contains the payload of the Apple Search Ads API response (when available). This event is sent shortly after the Android SDK initialization. This event is used as part of the Singular attribution process.