Skip to main content
Reads use analytics:read. Anything that changes state or spends the site’s lookup or Search Console budget uses seo:write: running checks, paid lookups, keyword lists, competitors, alert rules, annotations, reports, link prospects, index inspections, backlink review, applying audit fixes and settings. The site’s team must have the SEO module; otherwise every endpoint returns 402 with code: "MODULE_REQUIRED". Paid lookups that hit the site’s daily lookup cap return 429 with code: "BUDGET_EXHAUSTED". Every path below is relative to:
Query parameters are listed in parentheses; request bodies are JSON. Paginated endpoints return pagination: { page, limit, total } (limit 1 to 100, default 50). Data comes from the stored snapshots the SEO pages show; reading never triggers a paid lookup unless the endpoint is marked paid. Rate limit tiers: reads use the read tier (300/min), row writes the write tier (60/min), and paid lookups, queued checks, index inspections, applying fixes and generating or sending reports the 10/min tier.

​
Overview and snapshots

The original six read endpoints, unchanged.
  • overview: health tiles (on-page score, audit errors, domain rank, backlinks, organic keywords and traffic with deltas, tracked keywords in the top ten, AI Mode citation rate), a ranked actions list, striking-distance keywords (positions 11 to 20) and Search Console queries with impressions but few clicks.
  • rankings: one row per tracked keyword with the latest position, change7d / change30d (positive = moved up), ranking URL, competitor positions and who holds #1. Best position first.
  • organic: keywords the site ranks for from the latest refresh, sort=etv (estimated traffic, default), position or volume; includes the domain overview (summary, previous) and the top pages.
  • backlinks: the latest summary with the previous snapshot, and referring pages: status=live (strongest first) or lost (most recently lost first).
  • audit: the latest crawl (any status), the previous completed one, and the page issues; severity=error|warning|notice|all.
  • ai-mode: per tracked prompt, whether Google AI Mode cited the site at the latest check; status=cited|not_cited|lost|all (lost = cited at the previous check, not now).

​
Status and settings

Module state for the site, and the settings the module runs with: the rank-check locale and the brand aliases.

​
Keywords

The scored keyword workspace: every keyword with its Google position and change, volume, difficulty, intent, Search Console clicks and impressions, article status, AI prompt results, competitor positions, SERP features and an opportunity score with reasons, plus the site’s keyword lists and a summary. One keyword can be read in full, with its history, People also ask, Search Console data, linked AI prompts and tracking overrides.

​
Research

Keyword research from a seed term. Recent searches are stored; a new search is paid unless the same lookup was made in the last 30 days.

​
Competitors

The site’s competitor set with a comparison, each competitor’s top pages, and competitor keywords: terms where a competitor ranks and the site is missing, behind or ahead, with brand and off-topic filters and a status you manage.

​
Topics, content health and pages

Keyword topics, pages that are decaying or cannibalizing each other, and page-level performance.

​
Alerts and annotations

The alert feed and its rules, and dated annotations (manual notes or Google updates) shown on the history charts.

​
Reports

Weekly or monthly SEO reports: generate one on demand, keep schedules, and send a report to recipients.

​
Forecast and value

A traffic forecast, a what-if calculation for a target position, the traffic value of current rankings, and month-by-month history.

​
Search Console, SERP features, Search + AI and visibility

Search Console breakdowns and history, SERP feature ownership, combined Search + AI performance, and AI visibility over time.

​
Explore

Look up any domain. Lookups are paid, cached for 7 days and capped per site per day; the read returns recent lookups and the remaining budget. Backlink prospects from link intersects, unlinked mentions and broken links, with a status you manage and a hand-off to Outreach.

​
Indexing

Index state per URL, with Google URL Inspection and IndexNow resubmission. Beyond the audit and backlink snapshots above: the internal link graph, a comparison against the previous crawl, proposed fixes you can apply, and the backlink profile with disavow review.

​
Checks

Refresh the stored data. Queued kinds return at once and the snapshot updates when the job finishes; inline kinds run during the request and are paid; ctr_model is free.