Skip to content

The site digest

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

id
required
string format: uuid

The site’s UUID.

since
integer

Epoch ms. changes covers what broke or was fixed after it. Defaults to the end of the crawl before the latest.

The digest.

Media typeapplication/json
object
site
required
object
id
string
hostname
string
crawl
required
object
runId
string
finishedAt
integer | null
pagesCrawled
integer
nextCrawlAt
required
integer | null
searchConsole
required
object
connected
boolean
syncedAt
integer | null
totals
required

Pages with findings, all findings, and findings by severity.

object
pages
integer
findings
integer
critical
integer
serious
integer
moderate
integer
minor
integer
fixFirst
required

The ten highest-priority pages.

Array<object>
object
url
required
string format: uri
findings
required
integer
counts
required
object
critical
required
integer
serious
required
integer
moderate
required
integer
minor
required
integer
top
required

The page’s worst finding.

object
source
string
rule
string
title
string
severity
string
Allowed values: critical serious moderate minor
problems
required

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.

Array<object>
object
source
required
string
Allowed values: links seo accessibility google
rule
required
string
title
required
string
severity
required
string
Allowed values: critical serious moderate minor
count
required
integer
clicks
required
integer | null
impressions
required
integer | null
priority
required
number
pages
required

Every page with findings, highest priority first (up to 5,000).

Array<object>
object
url
required
string format: uri
findings
required
integer
counts
required
object
critical
required
integer
serious
required
integer
moderate
required
integer
minor
required
integer
top
required

The page’s worst finding.

object
source
string
rule
string
title
string
severity
string
Allowed values: critical serious moderate minor
problems
required

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.

Array<object>
object
source
required
string
Allowed values: links seo accessibility google
rule
required
string
title
required
string
severity
required
string
Allowed values: critical serious moderate minor
count
required
integer
clicks
required
integer | null
impressions
required
integer | null
priority
required
number
byRule
required
Array<object>
object
source
string
rule
string
title
string
severity
string
Allowed values: critical serious moderate minor
pages
integer
changes
required

Null when there’s nothing to compare against (a single crawl).

object
since
integer
new
Array<object>
object
url
required
string format: uri
source
required
string
Allowed values: links seo
rule
required
string
title
required
string
severity
required
string
Allowed values: critical serious moderate minor
subject
required

The link target

string | null
at
required

When it was observed

integer | null
fixed
Array<object>
object
url
required
string format: uri
source
required
string
Allowed values: links seo
rule
required
string
title
required
string
severity
required
string
Allowed values: critical serious moderate minor
subject
required

The link target

string | null
at
required

When it was observed

integer | null
signals
required

Search Console signals (up to 10 each); null when not connected.

object
slipping
Array<object>
object
url
string
clicks
integer
previousClicks
integer
delta
number
lowCtr
Array<object>
object
url
string
impressions
integer
position
number
ctr
number
expectedCtr
number
strikingDistance
Array<object>
object
url
string
query
string
position
number
impressions
integer
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.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
"error": "since must be a timestamp in milliseconds"
}

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"
}