OAuth · sync · query

Everything you need to wire overads into your stack

Three primary surfaces: the connector OAuth flow, the read-only metrics API, and the webhook stream. Pick a guide below.

Read the spec Try in the playground

Quick start

OAuth, sync, query — three calls

Step 01Live

OAuth into a platform

One-click read-only OAuth for Meta, Google, or Reddit. We never request write scopes.

POST /v1/oauth/{platform}/start

Step 02Live

Sync 90 days, then nightly

Backfill runs in a Lambda; deltas sync at 02:00 UTC. Everything lands in metrics_daily.

GET /v1/syncs?status=running

Step 03Live

Query the unified schema

Read campaigns, ad sets, ads, and daily metrics through one normalized API or the dashboard.

GET /v1/metrics?from=…&to=…

Guides

Three surfaces, three short reads

Guide5 min read

Quickstart

Sign up, connect your first ad account, and see unified metrics in under five minutes. Covers the trial flow, OAuth handshake, and what to expect from the first sync.

Read the guide

Guide12 min read

Connectors API

Reference for every supported platform: scopes requested, fields synced, refresh cadence, and the exact rows that land in metrics_daily.

Read the guide

Guide7 min read

Webhooks

Subscribe to sync.completed, suggestion.created, and connection.expired events. Signed with HMAC-SHA256; replay-safe with delivery IDs.

Read the guide

Sample request

Pull metrics for a date range

All endpoints live under api.overads.io/v1 and authenticate with a workspace-scoped bearer token from Settings → API keys.

GET /v1/metrics

cURL

curl https://api.overads.io/v1/metrics \
  -H "Authorization: Bearer sk_live_..." \
  -G -d "from=2026-05-01" -d "to=2026-05-21" \
  -d "group_by=platform,campaign_id"

Reference index

The rest of the site, in one map

/platforms

Platforms

Per-platform scopes, cadence, and field map. Live now, in review, and the waitlist queue.

/how-it-works

How it works

The signup → OAuth → sync → brief lifecycle, end to end, in three steps and a couple of mocks.

/pricing

Pricing

Per-workspace tiers, ad-spend caps, and what unlocks on each plan. Free 14-day trial on all tiers.

/status

Status

Live health for API, webhooks, sync workers, and the database. Subscribe to incident updates.

Stuck on a connector or a webhook payload? Write to us. The docs are short on purpose; the inbox is where the long answers live.