API Overview

Bird0 provides a comprehensive REST API for integrating revenue analytics into your applications.

Base URL

https://api.bird0.com/v1

Authentication

All API requests require authentication using Bearer tokens.

Authorization: Bearer YOUR_API_KEY

Rate Limits

• Free Plan: 1,000 requests per month
• Pro Plan: 10,000 requests per month
• Lifetime: 100,000 requests per month

Endpoints

Revenue Data

Get Revenue Summary

GET /revenue/summary

Get Revenue by Platform

GET /revenue/platforms

Get Revenue by Date Range

GET /revenue/range?start=2024-01-01&end=2024-01-31

Sales Data

Get Recent Sales

GET /sales/recent?limit=50

Get Sales by Platform

GET /sales/platform/{platform_id}

Get Sales by Product

GET /sales/product/{product_id}

Platform Data

Get Connected Platforms

GET /platforms

Get Platform Status

GET /platforms/{platform_id}/status

Traffic Data

Get Traffic Summary

GET /traffic/summary

Get Traffic by Date

GET /traffic/range?start=2024-01-01&end=2024-01-31

Response Format

All API responses follow this format:

{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "timestamp": "2024-01-01T00:00:00Z",
    "request_id": "req_123456789"
  }
}

Error Handling

Error Response Format

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key provided",
    "details": {}
  }
}

Common Error Codes

• INVALID_API_KEY - API key is invalid or expired
• RATE_LIMIT_EXCEEDED - Rate limit exceeded
• INVALID_REQUEST - Request parameters are invalid
• PLATFORM_NOT_FOUND - Platform ID not found
• UNAUTHORIZED - Insufficient permissions

SDKs

JavaScript/TypeScript

npm install @bird0/api

import { Bird0API } from '@bird0/api';

const api = new Bird0API('YOUR_API_KEY');

// Get revenue summary
const summary = await api.revenue.getSummary();

// Get recent sales
const sales = await api.sales.getRecent({ limit: 10 });

Python

pip install bird0-api

from bird0_api import Bird0API

api = Bird0API('YOUR_API_KEY')

# Get revenue summary
summary = api.revenue.get_summary()

# Get recent sales
sales = api.sales.get_recent(limit=10)

Webhooks

Configure Webhooks

POST /webhooks

Webhook Events

• sale.created - New sale recorded
• sale.refunded - Sale refunded
• platform.connected - Platform connected
• platform.disconnected - Platform disconnected

Webhook Payload

{
  "event": "sale.created",
  "timestamp": "2024-01-01T00:00:00Z",
  "data": {
    "sale_id": "sale_123",
    "amount": 29.99,
    "currency": "USD",
    "platform": "stripe",
    "product": "Pro Plan"
  }
}

Examples

Get Today’s Revenue

curl -X GET "https://api.bird0.com/v1/revenue/summary" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Sales from Last 30 Days

curl -X GET "https://api.bird0.com/v1/sales/recent?days=30" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Platform Performance

curl -X GET "https://api.bird0.com/v1/revenue/platforms" \
  -H "Authorization: Bearer YOUR_API_KEY"

Getting Started

1. Get Your API Key - Generate your API key
2. View Endpoints - Detailed endpoint documentation
3. Try Examples - Code examples and tutorials

Support

• API Status - Check API uptime
• Contact Support - Get help with integration
• Community - Join our developer community