APIs Overview

  • Updated on Apr 24, 2025
  • Published on Feb 21, 2025
Prev Next

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

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

Unified Analytics Export

Get unified analytics data into your data warehouse.

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

Functional APIs

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.

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:

  • Scheduled Log Exports API

  • Cross-Events Export API

  • Unified Analytics Export API

Visit our packaging page to learn more.