如何将Branch.io API接入Jupyter Notebook并查看相关数据？

1. 先搞定基础准备 #

• 先从Branch.io后台拿两个关键信息：
  • 登录后进入「Account Settings」→「API Keys」，复制Live API Key（别用测试环境的，新手先搞生产环境基础数据）
  • 再去「App Settings」复制App ID，部分API调用需要这个
• 在Jupyter单元格里安装必备工具库：

  !pip install requests pandas
  

  （requests用来发API请求，pandas用来把杂乱的API数据转成表格，新手用这个最省心）

2. 最简API调用示例（拿短链接统计数据为例） #

直接复制下面的代码，替换成你的密钥和App ID就能跑：

import requests
import pandas as pd

# 替换成你的Branch.io密钥和App ID
BRANCH_API_KEY = "你的Live API Key"
BRANCH_APP_ID = "你的App ID"

# 调用获取短链接点击量的API端点
url = "https://api.branch.io/v1/url/counts"

# 请求参数：指定时间范围和要查询的短链接
params = {
    "branch_key": BRANCH_API_KEY,
    "app_id": BRANCH_APP_ID,
    "start_date": "2024-01-01",
    "end_date": "2024-06-01",
    "url": "https://你的分支短链接.app.link/xxx"
}

# 发送请求
response = requests.get(url, params=params)

# 处理返回结果
if response.status_code == 200:
    # 解析JSON数据转成表格
    data = response.json()
    df = pd.DataFrame(data["data"]["items"])
    display(df)  # 在Jupyter里显示格式化表格
else:
    print(f"请求失败：{response.status_code}，错误信息：{response.text}")

• 要是返回401 Unauthorized，直接去后台重新复制Live API Key，大概率是密钥填错了
• 要是数据为空，检查时间范围是不是太窄，或者换一个有实际点击量的短链接试试

3. 扩展：获取所有短链接列表 #

想批量看自己创建的短链接，用这个代码：

url = "https://api.branch.io/v1/urls/list"
params = {
    "branch_key": BRANCH_API_KEY,
    "app_id": BRANCH_APP_ID,
    "limit": 10  # 限制返回10条，避免数据太多看不过来
}

response = requests.get(url, params=params)
if response.status_code == 200:
    data = response.json()
    df = pd.DataFrame(data["urls"])
    display(df[["url", "created_at", "clicks"]])  # 只显示关键列
else:
    print(f"请求失败：{response.status_code}，错误信息：{response.text}")

新手避坑提示 #

• 别一开始就碰复杂的用户行为追踪API，先从「URL管理」「基础统计」类的端点入手，这些是最常用的
• 官方文档里的参数说明如果看不懂，直接看返回的JSON结构，用print(data)把原始数据打出来，对着结构找你要的字段就行

内容的提问来源于stack exchange，提问作者sasibhushan M