Peekaboo REST API.

https://www.aipeekaboo.com/api/v1

Every request needs an X-API-Key header. Keys are project-scoped and read-only.

Key format: pk_YOUR_PROJECT_ID_YOUR_SECRET

Generate one in Settings → Integrations inside the Peekaboo app.

Example:

• curl -H "X-API-Key: pk_proj123_secret456" https://www.aipeekaboo.com/api/v1/brands

Every response is a JSON envelope:

• success: boolean
• data: the payload
• pagination: present on list endpoints (offset, limit, total, hasMore)
• metadata: { requestId, timestamp, queryTimeMs }

List every brand in your project.

Returns: id, name, domain, createdAt, totals.

Recommended starting point. One call returns the full pre-computed analytics snapshot:

• brand: id, name, domain
• visibility: { score, rank, maxScore, totalCitations, totalChatsAnalyzed }
• prompts: array of tracked prompts with per-prompt scores
• sources: cited domains across all 5 models
• competitors: tracked + discovered, with scores and traffic
• aiSuggestions: prompt opportunities
• traffic: SimilarWeb data

Score, market share, top prompts.

Query: time_range=7d|30d|90d (default 30d)

Returns: score (0–100), marketShare, topPrompts[], trend.

Competitor comparison with scores and traffic.

Returns: array of { name, domain, visibilityScore, monthlyVisits, trackedYesNo }.

Source domains AI models cite when describing your brand.

Returns: array of { domain, citationCount, modelBreakdown }.

Paginated prompt performance.

Query: time_range, category, search_intent, offset, limit

Returns: prompts[] with score, mentions, rank, last run timestamp.

score = ((totalMentions - rank + 1) / totalMentions) * 100

Averaged across all runs in the window. Non-mentions count as zero. Identical formula for your brand and every competitor. Source: lib/scoring/visibility-score.ts.

ChatGPT (gpt-4o-mini) · Gemini (2.5-flash) · Perplexity (sonar) · Google AI Mode · Google AI Overview

All 5 included on every paid plan. No model gating.