Skip to main content
GET
Get Audit

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required

Query Parameters

as_of
string<uuid> | null

Include only scans up to this completed scan id.

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
cursor
string | null
Maximum string length: 4096
status
enum<string> | null
Available options:
readable,
blocked_robots,
noindex,
does_not_load,
needs_javascript,
not_read
cited
enum<string> | null
Available options:
cited,
not_cited
page_type
enum<string> | null
Available options:
product,
solution,
pricing,
blog_post,
customer_story,
press,
documentation,
resource,
comparison,
legal,
other
q
string | null
Maximum string length: 200
sort
enum<string>
default:citations
Available options:
citations,
page,
status,
crawls,
read
direction
enum<string> | null
Available options:
asc,
desc
check
string | null
Maximum string length: 200
checks_limit
integer
default:10
Required range: 1 <= x <= 100
checks_offset
integer
default:0
Required range: x >= 0

Response

Successful Response

The latest crawl's site checks and pages. Audit has no period.

checks_failing
integer
required
checks_unmeasured
integer
required
citations_scan
DataAsOf · object | null
required

The last weekly scan, whose answers the pages' citations count.

crawled_at
string<date-time> | null
required
crawler_hits_available
boolean
required
crawler_hits_days
integer
required
groups
V1AuditGroup · object[]
required
limit
integer
required
meta
Meta · object
required

Normalized query and newest included scan.

next_crawl_at
string<date-time> | null
required
next_cursor
string | null
required

Pass as cursor with the same query to read the next page; null at the end.

offset
integer
required
page_types
string[]
required
pages
V1AuditPage · object[]
required
readiness
V1Readiness · object | null
required

The pages the readiness checks cover: every audited page and the homepage.

sentence
string | null
required
state
enum<string>
required
Available options:
ready,
awaiting_first_crawl
total
integer
required