Get the SEO report
const url = 'https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/seo-report';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/seo-report \ --header 'x-api-key: <x-api-key>'The on-page SEO report, derived live from the latest crawl that extracted SEO data: issues grouped by rule (ranked by severity, then by recoverable score points), a worst-first per-page view, and a summary with the 0-100 score and an indexability verdict.
Issues are derived at read time from per-page field snapshots, so
changes to the site’s excludePaths globs apply retroactively -
duplicate detection recomputes from the filtered page set. The score
frozen on the run row feeds the trend; the report’s live score can
differ briefly after a settings change.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The site’s UUID.
Responses
Section titled “ Responses ”The latest SEO-extracting run, its issues, and summary.
object
A single crawl run and its summary metrics.
object
Epoch ms the run started.
Epoch ms the run finished, or null while running.
Distinct broken link targets found in the run.
Distinct source pages that had at least one broken link.
Synthesized 0–100 accessibility score, or null when the run didn’t scan.
Confirmed violations with critical impact.
Internal pages the accessibility scan covered in this run.
Distinct confirmed (page, rule) accessibility violations this run (0 for crawl runs).
Violations present in the previous accessibility run but gone in this one (the “fixed” trend).
Synthesized 0-100 SEO score, or null when the run didn’t extract SEO data.
Pages an SEO snapshot was captured for (at most pages_crawled).
Derived SEO issues at the time the run finalized.
Synthesized 0-100 AI readiness score, or null when the run didn’t capture AI signals.
Pages an AI snapshot was captured for (at most pages_crawled).
Derived AI readiness issues at the time the run finalized.
JSON-encoded site-wide facts captured at seed (llmsTxt,
cloudflare, trainingBlocked), or null. The /ai-report
summary.notes is the parsed form.
SEO issues opened this run. null on starting-point and pre-lifecycle runs.
SEO issues fixed this run (the page was crawled and the rule no longer fires).
SEO issues closed because their page is no longer crawled. Not counted as fixed.
Fixed SEO issues that came back this run.
Pages that answered with a bot-protection challenge instead of their content. null on runs from before crawl-health tracking.
Pages that refused access (401/403, or still rate-limited after every retry). Never reported as broken. null on runs from before tracking.
Pages that were rate-limited at least once (the crawl slowed down and retried). null on runs from before tracking.
Failure reason if state is failed, otherwise null.
crawl for a broken-link crawl, a11y for a standalone accessibility scan.
Issues grouped per rule, most severe and most impactful first.
object
Stable rule id (e.g. title-missing, meta-noindex).
One-paragraph editor-facing explanation of the finding.
What to change to resolve it, in editor terms.
Pages affected by this rule.
Score points recoverable by fixing this rule site-wide.
Affected pages (capped), each with an optional detail string and the offending value itself (the title/description/canonical/robots text).
object
Stable issue id (see listSeoIssues). null when the finding has
no lifecycle row yet, e.g. a rule tuned after the run finalized.
When this issue was first seen (epoch ms).
Opened, or reopened after a fix, in this run. Never true after a starting-point (baseline) run.
Every page with at least one issue, ranked worst-first.
object
The page’s own 0-100 score.
Other crawled pages linking to this page. null when
the link graph wasn’t measured (the crawl hit the page
limit, or ran before this was tracked).
Clicks from the homepage along internal links. null
with inlinks set means no link path from the
homepage reaches the page.
The page’s findings, with the offending content where applicable.
object
Stable issue id (see listSeoIssues). null when the finding has
no lifecycle row yet, e.g. a rule tuned after the run finalized.
When this issue was first seen (epoch ms).
Opened, or reopened after a fix, in this run. Never true after a starting-point (baseline) run.
object
object
false iff something actively blocks search
visibility - a noindex on a sitemap/root page,
or a canonical crediting another site.
Issue churn in this run against the previous lifecycle
state. null after a starting-point run, which
happens on the first lifecycle-aware crawl and after a
rule-set change. resolved counts real fixes only;
gone counts issues whose page is no longer crawled.
object
Pages this crawl couldn’t read the way a visitor would, from the run’s
pages_challenged / pages_blocked / pages_rate_limited. null when
every page came through, or on runs from before tracking. Challenged and
blocked pages are missing from the report’s findings.
object
How the pages hang together. links is null when the
link graph wasn’t measured; sitemap is null when the
crawl read no sitemap. The pages behind each count are
in the orphan-page, deep-page and sitemap-* findings.
object
object
Pages per click depth from the homepage (index = clicks).
object
URLs on this site the sitemap lists.
Indexable crawled pages the sitemap leaves out.
Sitemap URLs robots.txt disallows for search engines (Googlebot, or *).
JSON-LD posture (informational): coverage, the site’s type inventory, and pages carrying none. Broken or rich-results-ineligible blocks surface as issues.
object
The site’s JSON-LD type inventory, most-used first.
object
Pages with no structured data at all (capped).
Example
{ "run": { "state": "running", "kind": "crawl" }, "byRule": [ { "severity": "critical" } ], "byPage": [ { "findings": [ { "severity": "critical" } ] } ], "summary": { "verdict": { "risk": "high" } }}Missing or invalid credentials.
object
A human-readable error message.
Example
{ "error": "invalid api key"}The site was not found, the SEO app is not enabled, or no completed crawl has extracted SEO data yet.
object
A human-readable error message.
Example
{ "error": "no runs yet"}