API Documentation

Integrate Gaiamobi programmatically with our comprehensive REST API.

🔑

Authentication

API key-based authentication with OAuth 2.0 support for secure access.

âš¡

RESTful Design

Clean, predictable API design following REST best practices.

📊

Real-Time Data

Access campaign stats, performance metrics, and reports instantly.

Getting Started

Base URL

https://api.gaiamobi.com/v1/

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.gaiamobi.com/v1/campaigns

Response Format

All responses are in JSON format:

{
  "status": "success",
  "data": {...},
  "meta": {
    "page": 1,
    "total": 100
  }
}

Core Endpoints

GET /campaigns

List all campaigns with optional filters.

Parameters: status, date_from, date_to, page, limit

POST /campaigns

Create a new advertising campaign.

Body: name, budget, targeting, creatives

GET /campaigns/{id}

Retrieve campaign details by ID.

PUT /campaigns/{id}

Update campaign settings.

GET /reports

Access detailed performance reports.

Parameters: campaign_id, metric, groupBy, date_range

Rate Limits

Starter

1,000

requests/hour

Professional

10,000

requests/hour

Enterprise

Custom

unlimited options

Get API Access