API Documentation

Authentication

Authenticated dashboard requests use a JWT Bearer token. For programmatic API access (Agency plan), use an API secret key in the X-API-Key header.

curl https://app.competitorinbox.com/intelligence/alerts \
  -H "Authorization: Bearer eyJhbGc…"

curl https://app.competitorinbox.com/competitors \
  -H "X-API-Key: sk_live_…"

Rate Limits

Limits vary by plan. Exceeded limits return HTTP 429.

Evidence Classification

Every AI-generated claim in intelligence responses is labeled with one of three evidence tiers. DNS probe responses are always [FACT] — no AI involved.

Programmatic API access is available to Agency plan subscribers only. Each workspace holds up to 10 active API key pairs. Pass your secret key as X-API-Key header.

Manage tracked competitor brands. Each competitor gets a unique inbound email address (e.g. brand123@in.competitorinbox.com) to monitor their campaigns.

Access captured emails, re-trigger analysis, and retrieve raw content. Emails are captured via the unique inbound address assigned to each competitor.

Aggregate send-frequency data, CTAs, heatmaps, and per-competitor performance reports.

AI-powered competitive intelligence: brand summaries, subject line grading, campaign pattern detection. All AI claims are labeled [FACT], [INFERENCE], or [HYPOTHESIS].

ESP and infrastructure profiles for competitor sending domains. Aggregates email header signals, DNS facts, company size estimates, and benchmark comparisons.

Discover lead capture forms, track email nurture funnels, attribute emails to opt-in sources, and run AI flow analysis.

Analyse HTML rendering compatibility across 10+ email clients (Gmail, Outlook 2016–2021, Apple Mail, Samsung, etc.).

Cluster detected A/B subject line and content variants. Uses semantic similarity + UTM signals to group emails into campaign sequences.

White-label intelligence widgets that can be embedded in client dashboards. Scoped to a competitor, shows metrics, send timings, or subject grade summaries.

Quick Start

Ready-to-run examples in four languages.

const res = await fetch(
  'https://app.competitorinbox.com/competitors',
  { headers: { 'X-API-Key': process.env.CI_SECRET_KEY } }
);
const { competitors } = await res.json();

import httpx, os
r = httpx.get(
  "https://app.competitorinbox.com/intelligence/dns-probe",
  params={"domain": "klaviyo.com"},
  headers={"X-API-Key": os.environ["CI_SECRET_KEY"]}
)
print(r.json()["spf"]["record"])

$ch = curl_init('https://app.competitorinbox.com/competitors');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('CI_SECRET_KEY'),
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);

curl "https://app.competitorinbox.com/intelligence/dns-probe?domain=klaviyo.com" \
  -H "X-API-Key: sk_live_your_key" \
  | jq '.auth_risk'