Analyze a domain
estimate_only: true. To accept a paid result, repeat the request with an
explicit max_cost_cents. Provider estimates and charges may contain fractional
cents, but request caps must be nonnegative whole cents; round an accepted
estimate up. A cap of 0 permits cache hits only. A cache miss returns
cost_limit_exceeded instead of spending. fresh: true skips cached data but
never removes the explicit cap requirement.
Omit scope_override to detect scope from target: a registrable domain uses
root, while a subdomain uses subdomain. Set it explicitly only to override
that behavior. keyword_limit accepts 1-100 and page_limit accepts 1-1000.
The report combines the overview, first keyword page, and first relevant-pages
page. It returns history_mode: "lazy"; history is not embedded in the report
and must be loaded separately. Individual keyword or page modules can fail while
the report remains successful. Each nested module preserves its ok, reason,
and actual cost_cents. Reopening the same snapshot within twelve hours is free.
Load history
snapshot_expired problem response. Use max_cost_cents: 0 for a cache-only
attempt.
Load ranked keywords
limit from 1 through 100. Sort or filter returned rows
locally without another provider call.
Load relevant pages
limit from 1 through 1000. All four operations
return the standard { "data": ... } response envelope. Top-level failures use
RFC 9457 Problem Details and preserve errors.reason, actual
errors.cost_cents, and errors.reset_at when available.