Everything known about one page
const url = 'https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/page?url=https%3A%2F%2Fexample.com';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/page?url=https%3A%2F%2Fexample.com' \ --header 'x-api-key: <x-api-key>'The findings from every installed app (hottest first), the page as the
latest crawl read it, and, when Search Console is connected, its
search numbers, the searches leading to it and derived insights.
Sections for apps that aren’t installed are null or empty.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The site’s UUID.
Query Parameters
Section titled “Query Parameters”The document’s public URL. Keyed the way the crawler keys pages
(www/non-www folding, the site’s stripParams dropped).
Responses
Section titled “ Responses ”The page view.
object
The page key the URL resolved to.
object
The latest completed crawl.
object
Whether the latest crawl reached the page; null when it can’t tell (SEO app off).
The page as the latest crawl read it (SEO app).
object
Other pages linking here.
Clicks from the homepage.
object
One finding on a page, from any app.
object
Stable id where the source keeps one (SEO issues, broken-link rows).
broken-link, unverified-link, an SEO rule id, an axe rule id, or a google-* rule id.
Why it matters, in editor words.
What to do about it. Empty for accessibility rules (see helpUrl).
The offending value — a link target, the current title, Google’s canonical.
Links only.
object
Null = no answer (timeout, network error).
The link’s anchor text.
Best-effort CSS selector into the page.
Accessibility only — affected elements on the page.
Accessibility only — the rule’s documentation.
SEO only — epoch ms.
SEO only — opened in the latest crawl.
Accessibility only — up to five affected elements as the crawler saw them. src is an image’s absolute URL, so a CMS can find the image (and its alt text field) in the document.
object
Search Console, last 28 days. Null when not connected.
object
The 28 days before. Null when the page earned nothing then.
object
The searches leading to the page, most clicks first (up to 10).
object
Google’s last URL Inspection of the page.
object
slipping (clicks, previousClicks, delta), low-ctr (position,
ctr, expectedCtr) or striking-distance (queries).
object
The page’s last re-check, epoch ms.
Example
{ "findings": [ { "source": "links", "severity": "critical", "link": { "kind": "internal" } } ], "insights": [ { "kind": "slipping" } ]}A missing or invalid URL.
object
A human-readable error message.
Example
{ "error": "url must be an absolute http(s) URL"}Missing or invalid credentials.
object
A human-readable error message.
Example
{ "error": "invalid api key"}No site with that id is visible to the caller.
object
A human-readable error message.
Example
{ "error": "site not found"}