The site digest
const url = 'https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/digest';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/digest \ --header 'x-api-key: <x-api-key>'Pages to fix first (ranked by finding severity, weighted by search
impressions), every page with findings, a per-rule rollup, what
changed since since, and search signals when Search Console is
connected.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The site’s UUID.
Query Parameters
Section titled “Query Parameters”Epoch ms. changes covers what broke or was fixed after it.
Defaults to the end of the crawl before the latest.
Responses
Section titled “ Responses ”The digest.
object
object
object
object
Pages with findings, all findings, and findings by severity.
object
The ten highest-priority pages.
object
object
The page’s worst finding.
object
The page’s findings folded by rule, worst first, with how many of each: what’s wrong on the page at a glance, and what to group pages by.
object
Every page with findings, highest priority first (up to 5,000).
object
object
The page’s worst finding.
object
The page’s findings folded by rule, worst first, with how many of each: what’s wrong on the page at a glance, and what to group pages by.
object
object
Null when there’s nothing to compare against (a single crawl).
object
object
The link target
When it was observed
object
The link target
When it was observed
Search Console signals (up to 10 each); null when not connected.
object
object
object
object
Example
{ "fixFirst": [ { "top": { "severity": "critical" }, "problems": [ { "source": "links", "severity": "critical" } ] } ], "pages": [ { "top": { "severity": "critical" }, "problems": [ { "source": "links", "severity": "critical" } ] } ], "byRule": [ { "severity": "critical" } ], "changes": { "new": [ { "source": "links", "severity": "critical" } ], "fixed": [ { "source": "links", "severity": "critical" } ] }}An invalid since.
object
A human-readable error message.
Example
{ "error": "since must be a timestamp in milliseconds"}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"}