Integrate with Branch

If you’re using Branch to manage links & routing to your app(s), you can integrate it with impact.com to track, report, and pay out on various events.

How it works

  • In the Branch dashboard, you’ll add impact.com as an Ad Partner to your account, which enables the standard postbacks. Additional postbacks can be configured to suit your use case.
  • Once integrated, you'll create a Branch Ad Link, append a necessary query string parameter, then set it as your mobile app(s)'s Download URL in the impact.com platform.
  • From there, you'll be able to test the integration with a test ad that will forward a user to your app's Branch Ad Link. Events that you've configured in the integration and occur in your app will appear as Actions in the impact.com platform.

⚠️

Note

This guide assumes a developer has already implemented the Branch SDK in your app(s) and completed the Universal Ads prerequisite — learn more.

Enable the integration


  1. In the Branch dashboard, select Ads → Partner Management.
  2. In the Ad Partners sidebar, search for impact.
  3. Under More Ad Partners, select Impact.
  4. In the Ad Account Information panel, add your impact.com account info:

    iOS Tracker Input the System App ID of your iOS app.
    Android Tracker Input the System App ID of your Android app.
    Account SID Input your impact.com account’s API Account SID value (case-sensitive).
    Authorization Token Input your impact.com account’s API Auth Token value (case-sensitive).
  5. Select Save & Enable.

Create Branch Ad Link for impact.com


Once the integration is enabled and you've configured postbacks, Create a Branch Ad Link.

⚠️

Note

When creating your ad link, make sure to select Impact as the Ad Partner to ensure the correct query string parameters are appended.

Update Download URL in impact.com

This section assumes you’ve already set up an app. See Set up Mobile App Tracking in the impact.com Help Center for details on configuring a mobile app.

Configure your newly created Branch Ad Link as the Download URL for your app in impact.com.

  1. In the impact.com platform, navigate to
    [Vertical Ellipses] → Settings
    .
  2. In the right column, select Mobile Apps.
  3. In the list, find the mobile app that you want to modify and select
    [Ellipses] → View/Edit.
  4. Find the Download URL line item and paste in the Ad Link from Branch, making sure that all query string parameters are present./li>

Integration options


Postback config

The Postback Config screen is where you can manage the postbacks that Branch is sending to impact.com. Refer to the Postback templates section for common use case examples — the templates can be easily modified with the parameters you want impact.com to receive.

Postback templates

For each example, a parameter denoted in brackets indicates this is a value or variable that you need to add in order for the postback to work.

ParameterDescription
[AccountSID]Your impact.com Account SID value.
[AuthToken]Your impact.com Auth Token value.
[iOS_SystemAppID]For iOS apps, the impact.com System App ID.
[Android_SystemAppId]For Android apps, the impact.com System App ID.
[UUID_Value]If available, the UUID value that the Branch SDK assigns to a user.
[ProgramId]Your impact.com Program ID.
[EventTypeId]Your impact.com Event Type ID.
[EventCode]If the event type is using event codes, the case-sensitive event code.

📘

Tip

For documentation on API calls, see the API Reference section for the PageLoad and Conversions endpoints.

App Open

https://trkapi.impact.com/PageLoad?CampaignId=[ProgramID]&PageUrl=${(last_attributed_touch_data.$original_url)!}&CustomProfileId=[UUID_Value]&EventDate=NOW&AndroidId=${(user_data.android_id)!}&AppleIfa=${ (user_data.idfa)! }&GoogAId=${ (user_data.aaid)! }&ImpactAppId=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="IOS">[iOS_SystemAppID]<#elseif bundle.os == "ANDROID">[Android_SystemAppID]</#if><@break/></#if></@loop>

App Install / Reinstall (Basic Auth Required)

https://[AccountSID]:[AuthToken]@api.impactradius.com/Advertisers/[AccountSID]/Conversions/?ActionTrackerId=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="IOS">[iOS_SystemAppID]<#elseif bundle.os == "ANDROID">[Android_SystemAppID]</#if><@break/></#if></@loop>&AppPackage=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os == "IOS"><@break/><#elseif bundle.os == "ANDROID">${(bundle.android.package_name)!}</#if><@break/></#if></@loop>&AppName=${ (app.name)!}&EventDate=NOW&EventCode=INSTALL&AndroidId=${(user_data.android_id)!}&AppleIfa=${(user_data.idfa)!}&GoogAId=${(user_data.aaid)!}&AppInstallRef=${(last_attributed_touch_data.AppInstallRef)!}&DeviceOs=${(user_data.os)!}&DeviceOSVer=${(user_data.os_version)!}&IpAddress=${(user_data.ip)!}&ClickId=${(last_attributed_touch_data.~click_id)!}&Oid=${(id)!}&CampaignId=[ProgramId]CustomProfileId=[UUID_Value]&subID1=${(last_attributed_touch_data.subID1)!}&subID2=${(last_attributed_touch_data.subID2)!}&subID3=${(last_attributed_touch_data.subID3)!}&ShareId=${(last_attributed_touch_data.ShareId)!}&IntegrationSource=BRANCH

Lead (Basic Auth Required)

https://[AccountSID]:[AuthToken]@api.impactradius.com/Advertisers/[AccountSID]/Conversions/?ActionTrackerId=[EventTypeId]&CampaignId=[ProgramId]&EventCode=[EventCode]&PropertyId=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="IOS">[iOS_SystemAppID]<#elseif bundle.os == "ANDROID">[Android_SystemAppID]</#if><@break/></#if></@loop>&UserAgent=${(user_data.user_agent)!}&AppPackage=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="IOS"><@break/><#elseif bundle.os =="ANDROID">${(bundle.android.package_name)!}</#if><@break/></#if></@loop>&AppName=${ (app.name)!}&EventDate=NOW&CustomProfileId=[UUID_Value]&AndroidId=${(user_data.android_id)!}&AppleIfa${(user_data.idfa)!}&GoogAId=${(user_data.aaid)!}&AppInstallRef=${(last_attributed_touch_data.AppInstallRef)!}&DeviceOs=${(user_data.os)!}&DeviceOSVer=${(user_data.os_version)!}&IpAddress=${(user_data.ip)!}&ClickId=${(last_attributed_touch_data.~click_id)!}&Oid=${(id)!}&subID1=${(last_attributed_touch_data.subID1)!}&subID2=${(last_attributed_touch_data.subID2)!}&subID3=${(last_attributed_touch_data.subID3)!}&ShareId=${(last_attributed_touch_data.ShareId)!}&IntegrationSource=BRANCH

Conversion (Basic Auth Required)

https://[AccountSID]:[AuthToken]@api.impactradius.com/Advertisers/[AccountSID]/Conversions/??ActionTrackerId=[EventTypeId]&EventCode=[EventCode]&CampaignId=[ProgramId]&PropertyId=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="IOS">[iOS_SystemAppID]<#elseif bundle.os == "ANDROID">[Android_SystemAppID]</#if><@break/></#if></@loop>&AppPackage=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="IOS"><@break/><#elseif bundle.os =="ANDROID">${(bundle.android.package_name)!}</#if><@break/></#if></@loop>&AppName=${ (app.name)!}&EventDate=NOW&CustomProfileId=[UUID_Value]&AndroidId=${(user_data.android_id)!}&AppleIfa${(user_data.idfa)!}&GoogAId=${(user_data.aaid)!}&AppInstallRef=${(last_attributed_touch_data.AppInstallRef)!}&DeviceOs=${(user_data.os)!}&DeviceOSVer=${(user_data.os_version)!}&IpAddress=${(user_data.ip)!}&UserAgent=${(user_data.user_agent)!}&ClickId=${(last_attributed_touch_data.~click_id)!}&Oid=${(id)!}&CurrencyCode=${(event_data.currency)!}&branch-custom=1&ItemCategory=[ItemCategory]&ItemSubTotal=${(event_data.revenue)!}&ItemSku=[ItemSku]&ItemQuantity=1&IntegrationSource=BRANCH

Item-level data

When sending item-level conversion data to impact.com, use the following format (replacing {variable} in the example with the actual value without curly brackets):

&branch-custom=1&[email protected]<#if content_items?has_content><@loop data=content_items val="attributes">{@json${(attributes.$product_category)!}</@json>}@sep,</@sep></@loop></#if></@urlencode>&[email protected]<#if content_items?has_content><@loop data=content_items val="attributes">{@json${(attributes.$item_number)!}</@json>}@sep,</@sep></@loop></#if></@urlencode>&[email protected]<#if content_items?has_content><@loop data=content_items val="attributes">{@json${(attributes.$price*attributes.$quantity)?long}</@json>}@sep,</@sep></@loop></#if></@urlencode>&[email protected]<#if content_items?has_content><@loop data=content_items val="attributes">{@json${(attributes.$quantity)!}</@json>}@sep,</@sep></@loop></#if></@urlencode>

Encoded data example

branch-custom=1&ItemCategory=%22%7Btest1%7D%22%2C%22%7Btest2%7D%22%2C%22%7Btest3%7D%22&ItemSubTotal=%22%7B21.6%7D%22%2C%22%7B20%7D%22%2C%22%7B891%7D%22&ItemSku=%22%7Bsku%7D%22%2C%22%7Bsku2%7D%22%2C%22%7Bsku3%7D%22&ItemQuantity=%22%7B1%7D%22%2C%22%7B2%7D%22%2C%22%7B1%7D%22

Decoded data example

branch-custom=1&ItemCategory="{test1}","{test2}","{test3}"&ItemSubTotal="{21.6}","{20}","{891}"&ItemSku="{sku}","{sku2}","{sku3}"&ItemQuantity="{1}","{2}","{1}"

Link Parameters reference

The Link Parameters tab shows the default query string parameter mapping between Branch and impact.com — these are added to all generated links by default, and cannot be remapped.

Branch Parameterimpact.com ParameterDescription
Custom Link Macro{AppInstallRef}Unique Install Referrer retrieved from the Google Play Store. Learn how to retrieve this value.
Click ID{clickid}impact.com token used to track the customer's journey.
Custom Link Macro{subid1}First Sub-affiliate ID — query string parameter used by impact.com partners for their own reporting.
Custom Link Macro{subid2}Second Sub-affiliate ID — query string parameter used by impact.com partners for their own reporting.
Custom Link Macro{subid3}Third Sub-affiliate ID — query string parameter used by impact.com partners for their own reporting.
Custom Link Macro{sharedid}Shared ID — query string parameter used by impact.com partners that appears in your reporting.
Secondary Publisher{irmpname}Name of the impact.com partner.
Campaign ID{ircid}Your impact.com Program ID value.

Attribution windows

The Attribution Windows tab is where you can customize attribution windows for the impact.com integration. impact.com also provides pre-configured attribution windows for links — select Use ad partner attribution settings to use the recommended settings.

Learn more about Attribution Windows in the Branch Help Center.

Postback testing

The Postback Testing tab offers the ability to test your postbacks before setting them live.

Learn more about how to Test Postbacks in the Branch Help Center](https://help.branch.io/using-branch/docs/testing-postbacks).


Did this page help you?