Goal: a reproducible, hands-on tutorial for BI engineers to learn consuming BI report APIs (auth, pagination, filters, error handling, verification) with Python examples and exercises.Prerequisites:- Familiarity: REST APIs, JSON, basic Python (requests), virtualenv- Tools installed: Python 3.9+, pip, curl, Postman, git- Accounts: API key or OAuth client for the BI platform, access to a sandbox workspace with sample reportsTutorial Outline & Exercises:1) Setup (15 min)- Create virtualenv, clone repo with sample code, install requirements.- Verify: run python -c "import requests; print(requests.__version__)"2) Authentication (30 min)- Exercise: Obtain API token (API key or OAuth2).- Show both flows; practice refreshing token.- Sample (API key):python
import os, requests
API_KEY = os.getenv("BI_API_KEY")
BASE = "https://api.bi.example.com/v1"
headers = {"Authorization": f"Bearer {API_KEY}", "Accept": "application/json"}
resp = requests.get(f"{BASE}/reports", headers=headers, timeout=10)
resp.raise_for_status()
print(resp.json()[:2])
python
def fetch_all_reports():
url = f"{BASE}/reports"
params = {"page_size": 100}
results=[]
while url:
r = requests.get(url, headers=headers, params=params, timeout=10)
r.raise_for_status()
data = r.json()
results.extend(data["items"])
url = data.get("next") # or construct with page token
params=None
return results
python
params = {"start_date":"2025-01-01","end_date":"2025-01-31","metrics":"revenue,users"}
r = requests.get(f"{BASE}/reports/123/export", headers=headers, params=params, timeout=60)
r.raise_for_status()
with open("jan_report.csv","wb") as f: f.write(r.content)
python
from time import sleep
for attempt in range(4):
r = requests.get(url, headers=headers, timeout=10)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2)) * (2**attempt)
sleep(wait); continue
try:
r.raise_for_status()
break
except requests.HTTPError as e:
if 500 <= r.status_code < 600 and attempt < 3: sleep(2**attempt); continue
raise
