Search specific term/phrase surrounded by double quotes. e.g. “deep linking”
Exclude records that contain a specific term prefixed with a minus. e.g. Android -Firebase

APIs Overview

Access Branch's different APIs for exporting your campaign data into your internal data systems, deep linking, and attribution.

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.

Data APIs

APIPurposeType of DataTimingExport Window
Daily ExportsExport all device-level data in batches on a daily basis.LogDelayed & batchedRolling 7 day window
Custom ExportsExport select device-level data using your own filters.LogDelayed & batchedRolling 120 day window
Scheduled Log ExportsSet up a recurring export of select device-level data.LogDelayed & batched (hourly or daily cadence)N/A
Cross-Events ExportQuery and compare large pools of data across multiple sources.AggregateDelayed & batchedRolling 2 year window
AggregatePull aggregate Branch data filtered for limited-access users.AggregateDelayed & batchedRolling 2 year window
CohortPull cohort Branch data to understand user behavior and performance over time.AggregateDelayed & batchedRolling 2 year window
QueryExport select campaign-
level data.
AggregateReal TimeRolling 2 year window

Functional APIs

APIPurpose
Deep LinkingCreate, read, update, and delete your Branch Links.
EventsTrack all of your events/conversions for your app.
QR CodeProgrammatically generate and customize Branch-powered QR codes.
AttributionAttribute your app sessions to your active campaigns.
AppView and make updates to an existing Branch app configuration to better support workflows.
Data Subject RequestGDPR and CCPA related uses for accessing and erasing user/device data from Branch.
Quick LinksProgrammatically generate Branch Deep Links that surface on the Branch Dashboard.

API Access

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

Included

APIs included with the Branch Growth Platform:

  • Daily Exports API
  • Custom Exports API
  • Aggregate API
  • Cohort API
  • Query API
  • Events API
  • Attribution API
  • App API
  • Data Subject Request API

Limited Access

APIs that require Branch's Engagement Pro product:

  • Deep Linking API
  • Quick Links API
  • QR Code API

APIs that require the Advanced Data Feeds add-on:

Visit our pricing page to learn more.