APIs Overview

API Descriptions

The following Branch APIs can help you query and export data, create Branch Deep Links, make your own custom Branch QR codes, and much more.

API	Purpose	Type of Data	Timing	Export Window
Daily Exports	Export all device-level data in batches on a daily basis.	Log	Delayed & batched	Rolling 7 day window
Custom Exports	Export select device-level data using your own filters.	Log	Delayed & batched	Rolling 120 day window
Scheduled Log Exports	Set up a recurring export of select device-level data.	Log	Delayed & batched (hourly or daily cadence)	N/A
Cross-Events Export	Query and compare large pools of data across multiple sources.	Aggregate	Delayed & batched	Rolling 2 year window
Aggregate	Pull aggregate Branch data filtered for limited-access users.	Aggregate	Delayed & batched	Rolling 2 year window
Cohort	Pull cohort Branch data to understand user behavior and performance over time.	Aggregate	Delayed & batched	Rolling 2 year window
Query	Export select campaign- level data.	Aggregate	Real Time	Rolling 2 year window

API	Purpose
Deep Linking	Create, read, update, and delete your Branch Links.
Events	Track all of your events/conversions for your app.
QR Code	Programmatically generate and customize Branch-powered QR codes.
Attribution	Attribute your app sessions to your active campaigns.
App	View and make updates to an existing Branch app configuration to better support workflows.
Data Subject Request	GDPR and CCPA related uses for accessing and erasing user/device data from Branch.
Quick Links	Programmatically generate Branch Deep Links that surface on the Branch Dashboard.

Some Branch APIs are included with the Branch Growth Platform, while others require specific Branch packages.

APIs included with the Branch Growth Platform:

APIs that require the Engagement Essentials package:

APIs that require the Engagement Pro package:

APIs that require the Advanced Data Feeds add-on:

Visit our packaging page to learn more.