Skip to content
Get Help

Import Cost Data Via API Connection (New)

Overview ​

Cost data can be enabled through a direct integration between Branch and the ad partner. This integration is established via an API connection that is uniquely authenticated for each partner. Once connected, Branch pulls cost data from the partner automatically on a schedule, no file preparation or manual imports required.

This guide covers connecting a supported ad partner, the list of partners with direct API integrations, data scheduling timelines, and troubleshooting. For an overview of all three import methods and their prerequisites, visit our guide on importing ad partner cost data.

Note: this guide is for new Branch

In the legacy Branch experience, cost data ingestion through API connection, file upload, or email ingestion was called ROI Hub. In the new Branch experience, ROI Hub has been replaced by the Cost Import tab. Please note that this guide is about cost data in new Branch. For information on ROI Hub in legacy Branch, visit our legacy guide.

Connect an ad partner ​

Once you connect a supported ad partner (via OAuth or account credentials, as described in the Ad Partner Integration Guide) Branch begins to ingest cost data from that partner.

You can confirm cost data is flowing via API on the partner's Status tab, where each connected ad account row shows a Cost data entry along with the time of the last pull and last successful pull.

Supported ad partners ​

Branch currently supports the following ad partners for sharing cost data via API connection:

Ad partner3p name
Rokua_ott_roku_san
Pinteresta_pinterest
Apple Adsa_apple
Snapa_snap
Reddita_reddit
TikToka_tiktok
Criteoa_criteo
Twittera_twitter
Molocoa_moloco
RTBHousea_rtb_house_sa
Unity Adsa_unity
Metaa_facebook
Google Adsa_google_adwords
Jamppa_jampp
Remergea_remerge
InMobi DSPa_inmobi_dsp
Liftoffa_liftoff
Impacta_impact_radius
Auraa_aura
Dataseata_dataseat
AppLovina_applovin
Amazon Adsa_amazon_san

Data scheduling ​

By default, Branch APIs will use the below general timelines for how often data is requested:

Days passedHours passedNumber of requests for a single day of data
0, 10-484 times per day
2, 3, 4, 548-1441 time per day
6-20144-5041 time every 5 days
21-29504-7200
307201 time

These schedules may vary by ad partner.

Timezone for cost ​

  • If the partner timezone can be edited, then you can change it on their side. However, this might mean that Branch cost numbers don't exactly match your invoices or partner dashboard.
  • If the partner timezone can't be edited, then you can change your Branch timezone. However, this can cause inconsistencies in Meta numbers, so this is not recommended.

Troubleshoot connection failures ​

If the partner's Status tab indicates that cost data isn't being received, it's likely caused by one or more of the following:

  • Your partner's authentication token expired. In this case, you must re-authenticate the ad partner. To do this, select Partner settings on that ad partner's page.
  • You have just authenticated or re-authenticated the ad partner. In this case, you must wait 24 hours for data to start flowing.
  • You have authenticated ad accounts that aren't running any valid campaigns with cost.