Skip to content

Everything known about one page

GET
/v1/sites/{id}/page
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.

id
required
string format: uuid

The site’s UUID.

url
required
string format: uri

The document’s public URL. Keyed the way the crawler keys pages (www/non-www folding, the site’s stripParams dropped).

The page view.

Media typeapplication/json
object
url
required

The page key the URL resolved to.

string format: uri
site
required
object
id
required
string
hostname
required
string
crawl
required

The latest completed crawl.

object
runId
required
string
finishedAt
required
integer | null
nextCrawlAt
required
integer | null
crawled
required

Whether the latest crawl reached the page; null when it can’t tell (SEO app off).

boolean | null
page
required

The page as the latest crawl read it (SEO app).

object
title
required
string | null
metaDescription
required
string | null
canonical
required
string | null
noindex
required
boolean
wordCount
required
integer | null
inSitemap
required
boolean | null
inlinks
required

Other pages linking here.

integer | null
depth
required

Clicks from the homepage.

integer | null
counts
required
object
critical
required
integer
serious
required
integer
moderate
required
integer
minor
required
integer
findings
required
Array<object>

One finding on a page, from any app.

object
id
required

Stable id where the source keeps one (SEO issues, broken-link rows).

string | null
source
required
string
Allowed values: links seo accessibility google
rule
required

broken-link, unverified-link, an SEO rule id, an axe rule id, or a google-* rule id.

string
severity
required
string
Allowed values: critical serious moderate minor
title
required
string
help
required

Why it matters, in editor words.

string
fix
required

What to do about it. Empty for accessibility rules (see helpUrl).

string
detail
required
string | null
subject
required

The offending value — a link target, the current title, Google’s canonical.

string | null
link
required

Links only.

object
target
required
string format: uri
kind
required
string
Allowed values: internal external
statusCode
required

Null = no answer (timeout, network error).

integer | null
text
required

The link’s anchor text.

string | null
selector
required

Best-effort CSS selector into the page.

string | null
count
required

Accessibility only — affected elements on the page.

integer | null
helpUrl
required

Accessibility only — the rule’s documentation.

string | null
firstSeenAt
required

SEO only — epoch ms.

integer | null
isNew
required

SEO only — opened in the latest crawl.

boolean | null
elements
required

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.

Array<object> | null
object
selector
required
string
html
required
string
src
required
string | null format: uri
search
required

Search Console, last 28 days. Null when not connected.

object
syncedAt
required
integer | null
clicks
required
integer
impressions
required
integer
ctr
required
number
position
required
number | null
previous
required

The 28 days before. Null when the page earned nothing then.

object
clicks
integer
impressions
integer
ctr
number
position
number
queries
required

The searches leading to the page, most clicks first (up to 10).

Array<object>
object
query
string
clicks
integer
impressions
integer
ctr
number
position
number
index
required

Google’s last URL Inspection of the page.

object
verdict
string
coverageState
string | null
lastCrawlTime
string | null
googleCanonical
string | null
inspectedAt
integer
insights
required

slipping (clicks, previousClicks, delta), low-ctr (position, ctr, expectedCtr) or striking-distance (queries).

Array<object>
object
kind
required
string
Allowed values: slipping low-ctr striking-distance
title
required
string
text
required
string
key
additional properties
any
recheckedAt
required

The page’s last re-check, epoch ms.

integer | null
Example
{
"findings": [
{
"source": "links",
"severity": "critical",
"link": {
"kind": "internal"
}
}
],
"insights": [
{
"kind": "slipping"
}
]
}

A missing or invalid URL.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
"error": "url must be an absolute http(s) URL"
}

Missing or invalid credentials.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
"error": "invalid api key"
}

No site with that id is visible to the caller.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
"error": "site not found"
}