Singular cloud mode

RudderStack supports server-to-server (S2S) API integration with Singular.

Refer to the Singular documentation for the Singular API endpoint reference.

RudderStack supports two types of track events that you can send to Singular via cloud mode:

• Session events
• Custom events

Session events

RudderStack lets you specify the event names to be used as session events in the dashboard settings:

RudderStack sends the session events to Singular via its launch API.

RudderStack considers an event as a session event only if it is specified in the dashboard settings or if it one of the following three lifecycle events:

• Application Installed
• Application Opened
• Application Updated

RudderStack automatically tracks the above three lifecycle events if lifecycle event tracking is enabled.

Supported mappings

This section lists the mappings of the RudderStack event properties to the relevant Singular fields.

The following table lists the mapping of the attributes automatically captured by RudderStack for the mobile platforms (Android and iOS):

To anonymize your IP, you can send a dummy IP in the context.ip field. RudderStack uses it as the IP address instead of capturing it automatically from the backend. In case of mobile SDKs, you can leverage the Transformations feature to do this - when sending events via cloud mode.

The following table lists the mapping of the attributes that must be passed via the event properties:

These properties are not persisted in the SDK and must be passed with every event.

The following table lists the mapping of the attributes that must be passed via the event properties just once:

These properties are persisted in the SDK and must be passed just once.

For more information on setting the device token, refer to the relevant SDK documentation:

• Android
• iOS

RudderStack supports only fcm for mapping the device token.

Custom events

RudderStack sends all events other than the session events as custom events via Singular’s evt endpoint.

Supported mappings

The following table lists the mapping of the attributes automatically captured by RudderStack for the mobile platforms (Android and iOS):

Singular prefers aifa over andi (in Android) and idfa over idfv (in iOS).

The following table lists the mapping of the attributes that must be passed via the event properties:

The following table lists the mapping of the user-defined attributes specific to revenue events:

If you set any one out of the value, revenue, or total properties, RudderStack automatically considers the event as a revenue event, unless it is explicitly mentioned by the is_revenue_event property.

A few important considerations in case of custom events are listed below:

• RudderStack takes the user agent from context.userAgent for Android and from the event properties in case of iOS.
• RudderStack stores the extra attributes passed in the custom event in Singular’s e field.

FAQ

How can I verify if the events are successfully delivered to Singular?

To verify if the events are successfully delivered to Singular, you can use RudderStack’s Destination live events feature.

You can also verify the event delivery by going to your Singular dashboard and following these steps:

1. Go to Settings > Console. You should see a list of tracked devices:

2. To add a new device, click the Add Device option and choose the relevant settings:

3. Finally, click the eye icon associated with the tracked device to start seeing the events in real-time.

You should be able to see a real-time log of all events sent to Singular:

For more customizable and granular reports, you can go to Attribution > Export Logs in the Singular dashboard. Note that this report is not real-time and takes some time to generate.

Questions? Contact us by email or on Slack