public-api
Public REST API v1: read platform data via X-API-Key (rate-limited per tier)
AI visibility summary
Share of Voice, sentiment, position per platform for the last N days.
Recent AI visibility checks
List of recent visibility check results (brand mentions, sentiment, position).
Daily Share of Voice trend
Daily Share of Voice (%) over generic questions, with a per-platform breakdown.
Question SoV ranking
Per-question Share of Voice ranking over generic brand-map questions: top performers and gaps.
Topic map
List of tracked questions from the topic map with AI gap status.
Published content list
List of GEO content pieces with scores and publication status.
AI bot visit summary
Aggregate stats on AI crawler visits (GPTBot, ClaudeBot, PerplexityBot, etc.).
Daily AI bot visits
Daily AI crawler visit counts with a per-bot breakdown (GPTBot, ClaudeBot, PerplexityBot, etc.).
AI traffic summary
Traffic from AI platforms (ChatGPT, Perplexity, etc.) via GA4 or Plausible.
Daily AI traffic
Per-day AI traffic records per source (sessions, users, pageviews).
Tracked product catalog
Cursor-paginated list of tracked products. Pass `meta.next_cursor` back as `?cursor=` for the next page.
Product visibility summary
Catalog-level aggregate: mention rate (Share of Voice), price issues, hallucinations, per-product stats.
Share of Shelf
Share of Shelf in AI shopping answers — overall + per-category + per-platform, each with a period-over-period trend.
Per-SKU visibility
Per-SKU daily visibility trend (position/competitors, attributed from category buyer-queries) plus price-accuracy history.
Revenue attributed to AI
Net revenue grouped per category or per SKU, with the AI proof ladder (hard / self-reported / probable) reported separately — never summed.
AI channel ROI
ROI of the AI channel: cost (subscription + content + opt-in AI usage) vs hard and estimated revenue, reported separately (§2).
Daily attribution trend
Daily sessions and AI-sourced sessions from the attribution pixel.
Detected hallucinations
List of AI hallucination checks about the brand, with severity and takedown status.
Brand safety summary
Aggregate: hallucination rate, breakdown by severity and platform, unresolved critical count.
Upsert one order
Canonical order ingest. Idempotent upsert by external_id (source_platform='api'); send the same external_id again to update status (e.g. returns/cancellations). Requires scope orders:write.
List synced orders
Minimal list for integration debugging (no line items). Requires scope orders:read.
Upsert a batch of orders
Up to 500 orders per request. Partial successes — failed orders land in `errors` with their index.