Skip to main content

Singular Integration with Swaarm

How to set up the tracking link template and postback URLs for Singular integration with Swaarm.

Overview

If you are not yet integrated with Singular, contact their integration team for the setup process. If you are already integrated, request your current tracking and postback link configuration and replace it with the Swaarm-supported parameters and macros below. In most cases, you can update the integration yourself by logging into Singular, going to Partner Configuration, opening your integration, and re-saving it.

ℹ️

For the full list of Swaarm tracking link macros → Advertiser Tracking Details
For Singular's tracking link macros → Singular Tracking Link Macros

For the additional postback link macros supported by Singular → here


Singular Tracking Link Structure

Singular tracking links follow the structure [SUBDOMAIN].sng.link/[DNS_ZONE], where the subdomain and DNS zone together make up the domain.

Screen_Shot_2023-01-24_at_16.02.07.png

Example without parameters:

https://examplesubdomain.sng.link/C59c0/47bm?

Attribution Link Template

ℹ️ The templates below are suggested starting points - you're free to add or remove parameters and macros based on your company's specific needs.

Complete tracking link with Swaarm macros

https://examplesubdomain.sng.link/C59c0/47bm?cl={id}&psid={publisher.id}&pssid={publisher.subId}&idfa={device.ids.idfa}&aifa={device.ids.gaid}&pcn={offer.name}&pcid={offer.id}&ip={user.ip}&ua={user.ua}&psn={publisher.app}

Tracking link parameter mapping

Singular Parameter

Definition

Swaarm Macro

cl

Click or transaction ID (mandatory)

{id}

ip

IP of the device at click time

{user.ip}

ve

OS version of the device (numeric/decimal only)

{user.os_version}

idfa

iOS Advertising ID (unhashed)

{device.ids.idfa}

aifa

Android Advertising ID (GAID)

{device.ids.gaid}

ua

User agent of the device

{user.ua}

lc

Language preference (e.g. en-US)

{user.language}

pssid

Sub Publisher ID

{publisher.subId}

pcn

Campaign name

{offer.name}

pcid

Campaign ID

{offer.id}

psid

Publisher ID

{publisher.id}

p

Device platform (Android/iOS)

{user.os}

psn

Publisher app name

{publisher.app}

pcrn

Creative name/ID

{publisher.creative}


Postback Link Templates

Singular supports install and event postbacks separately, differentiated by the event_id parameter. Revenue and Fraud postbacks are also supported as optional separate templates.

  • Replace {yournetwork} in the postback domain with your own Swaarm postback domain.

  • Singular macro {cl?Network Name} must be updated by replacing Network Name with the exact partner name under which your integration is configured in Singular.

Install postback

https://track.{yournetwork}.swaarm-clients.com/postback?click_id={cl?Network Name}&gaid={AIFA}&idfa={IDFA}&city={EVENT_CITY}&conversion_timestamp={UTC}&country={EVENT_COUNTRY}&os_name={PLATFORM}

Event postback

https://track.{yournetwork}.swaarm-clients.com/postback?event_id={EVTNAME}&click_id={cl?Network Name}&gaid={AIFA}&idfa={IDFA}&city={EVENT_CITY}&conversion_timestamp={UTC}&country={EVENT_COUNTRY}&os_name={PLATFORM}

Revenue postback

https://track.{yournetwork}.swaarm-clients.com/postback?event_id={EVTNAME}&click_id={cl?Network Name}&gaid={AIFA}&idfa={IDFA}&city={EVENT_CITY}&conversion_timestamp={UTC}&country={EVENT_COUNTRY}&os_name={PLATFORM}&aggregated_event_value={AMOUNT}&event_value={EVTATTRS}

Fraud postback

https://track.{yournetwork}.swaarm-clients.com/postback?status=rejected&rejection_reason={FRAUD_REASON_EXTERNAL}&click_id={cl?Network Name}&gaid={AIFA}&idfa={IDFA}&city={EVENT_CITY}&conversion_timestamp={UTC}&country={EVENT_COUNTRY}&os_name={PLATFORM}

Event Setup

Events are tracked based on the Singular event name. Set the Adv. EventType ID on the corresponding Swaarm event to match the Singular event name ({EVTNAME}) exactly.


Singular Postback Parameters

Swaarm Parameter

Definition

Singular Macro

Macro Definition

click_id

Swaarm click ID for the attributed conversion

{cl?Network Name}

Network click ID passed via Singular's cl parameter

gaid

Google AID of the device

{AIFA}

Unhashed Android advertising identifier

idfa

IDFA of the iOS device

{IDFA}

Unhashed iOS advertising identifier

publisher_id

Swaarm Publisher ID

{psid?Network Name}

Source site/app ID for the click, if passed

event_id

Event ID attributed in the advertiser's SDK

{EVTNAME}

Event name (rejected revenue events become __iapinvalid__)

city

City of the device

{EVENT_CITY}

Device location at the time of the event

country

Two-character country code

{EVENT_COUNTRY}

Device location at the time of the event

os_name

Operating system

{PLATFORM}

iOS or Android

aggregated_event_value

Transaction amount

{AMOUNT}

Revenue postbacks only — amount rounded to two decimals

event_value

JSON object with custom event data

{EVTATTRS}

Event attributes payload collected by the SDK

conversion_timestamp

Conversion timestamp recorded by the SDK

{UTC}

Install/event timestamp in UNIX seconds

click_timestamp

Click timestamp recorded by the SDK

{CLICK_UTC}

Click timestamp in UNIX seconds

Did this answer your question?