Singular Partner Integration Guide¶

Singular Account Setup¶

Singular Reporting API Key¶

To interact with Singular in Superfine, embedding the Singular Reporting API Key is necessary. To optain that key, please refer to the Singular documentation or follow the below steps.

Log in to Singular.
Navigate to Developer Tools > Reporting API Keys. Copy that Reporting API Key to your clipboard.

Superfine Setup¶

To add a new Singular account in Superfine, follow these steps:

Go to Configure > Partners.
Click the Partners button, choose Singular and proceed by selecting Next.
Paste your Singular Reporting API Key (required) in the previous steps into Reporting API Key.
Provide an account name (optional) for this Singular account. This will make it easier for you to distinguish your Singular account among other ones.
Click Save and your Singular account will be successfully added to Superfine. To edit or remove your Singular account, click the ••• icon next to that account and choose the corresponding action.

Singular Internal BI Setup¶

By setting up Internal BI in Partner Configuration, the postbacks from Singular will be sent back to Superfine so they will be processed to analyze users' attribution data. To set up this, please follow the below steps:

Go to Attribution > Partner Configuration in Singular, click Add Partner, search and choose Internal BI in the Singular partner lists.
Select your preffered app and site.
In the App-specific Configuration section, add the Superfine postback URL below to the Postback URL field:

https://log.superfine.org/tracking/singular/install

Also, the Click-through attribution lookback window should be 7 days.
In the Install, Re-engagement, and Event Postbacks section, include the Install, Re-engagement, __REVENUE__* and __SESSION__* options in the list to guarantee the delivery of all required postbacks to Superfine. Ensure the Revenue option is selected for the __REVENUE__* event.
Update all Postback settings to include the following parameters.

{NESTED_PB_PARAM|bi_postback_url}{JSON}fb_ad_name={FB_A_NAME}&install_utc_timestamp={INSTALL_UTC}&match_type={MATCH_TYPE}&app_name={APP_NAME}&campaign={CID}&fb_adset_name={FB_AS_NAME}&site={SITE}&fb_ad_id={FB_A_ID}&currency={CURRENCY}&singular_id={APID}&fb_adset_id={FB_AS_ID}&is_organic={SITE=Organic}&limit_ad_tracking={DNT}&city={CITY}&network={COALESCE|{NETWORK},Organic}&os_version={OS_VERSION}&click_utc_timestamp={CLICK_UTC}&twitter_campaign_id={TWTR_C_ID}&creative={CREATIVE}&platform={PLATFORM}&event_utc_timestamp={UTC}&app_version={APP_VERSION}&click_ip={IP}&idfv={IDFV}&twitter_tweet_id={tweet_id}&event_name={EVTNAME}&twitter_campaign_name={TWTR_C_NAME}&fb_campaign_name={FB_C_NAME}&aifa={AIFA}&device_brand={DEVICE_BRAND}&fb_campaign_id={FB_C_ID}&is_reengagement={IS_RE_ENG}&is_viewthrough={IS_VIEWTHROUGH}&twitter_line_id={TWTR_G_ID}&singular_click_id={CLID}&device_model={DEVICE_MODEL}&country={COUNTRY}&amount={AMOUNT}&longname={LONGNAME}&idfa={IDFA}&is_first_event={IS_FIRST_EVENT}&user_id={COALESCE|{CUSTOM_USERID|user.custom_user_id},{USERID|user.user_id}}&partner_campaign={COALESCE|{pcid},{pcn},{pc}}&partner_sub_campaign={COALESCE|{pscid},{pscn},{psc}}&partner_site={COALESCE|{ps},{SITE}}&partner_sub_site={pss}&campaign_group={GID}&android_id={ANDI}&tracker_campaign_name={pcn}&tracker_campaign_id={pcid}&tracker_sub_campaign_name={pscn}&tracker_sub_campaign_id={pscid}&tracker_creative_name={pcrn}&tracker_creative_id={pcrid}&tracker_publisher_site_name={psn}&tracker_publisher_site_id={psid}&tracker_publisher_sub_site_id={pssid}&tracker_publisher_sub_site_name={pssn}&tracker_name={CID}&tracker_publisher_sub_id={COALESCE|{pssn},{pss},{pssid}}&tracker_publisher_id={COALESCE|{ps},{psid},{psn},{pasid},{pshid}}&fraud_status={TERNARY|{NESTED_PB_PARAM|fraud_postback_enabled},true,{FRAUD_STATUS},}&fraud_reason={TERNARY|{NESTED_PB_PARAM|fraud_postback_enabled},true,{FRAUD_REASON_INTERNAL},}
Click Save and your Internal BI setup will be completed.