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

The brand's UUID from listBrands.

Query Parameters

finding
string | null

A finding id whose pages start at finding_pages_offset.

Maximum string length: 200
finding_pages_limit
integer
default:10

The pages listed under each finding.

Required range: 1 <= x <= 100
finding_pages_offset
integer
default:0

Pages to skip within the selected finding.

Required range: x >= 0
category
string | null

A name from facets.

Maximum string length: 200
language
string | null

A code from facets.

Maximum string length: 35
findings
enum<string> | null

issue: holds an issue; improve: holds improvements and no issue; none: holds neither.

Available options:
issue,
improve,
none
access
enum<string> | null

Whether AI engines can read the page: readable, blocked by any cause status names, or unmeasured (not_read).

Available options:
readable,
blocked,
unmeasured
changed
enum<string> | null

Found, or its content changed, since the previous weekly read.

Available options:
new,
changed
status
enum<string> | null

Filter by page status.

Available options:
readable,
blocked_robots,
noindex,
does_not_load,
needs_javascript,
not_read
cited
enum<string> | null

Filter pages by citation state.

Available options:
cited,
not_cited
page_type
enum<string> | null

Filter by page type.

Available options:
product,
product_detail,
collection,
solution,
pricing,
blog_post,
customer_story,
press,
documentation,
resource,
comparison,
legal,
home,
about,
contact,
careers,
landing,
blog_index,
utility,
other
q
string | null

Text to search for.

Maximum string length: 200
sort
enum<string>
default:citations

Field to order results by.

Available options:
citations,
page,
status,
crawls,
read,
findings,
clicks
direction
enum<string> | null

Order results ascending or descending.

Available options:
asc,
desc
limit
integer
default:20

Maximum rows (100).

Required range: 1 <= x <= 100
cursor
string | null

Prior next_cursor; keep filters and limit.

Maximum string length: 4096
as_of
string<uuid> | null

Completed scan id cutoff.

offset
integer
default:0

Rows to skip; prefer cursor paging.

Required range: x >= 0
check
string | null

A website check key to read.

Maximum string length: 200
checks_limit
integer
default:10

Maximum website checks to return.

Required range: 1 <= x <= 100
checks_offset
integer
default:0

Website checks to skip.

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
headline
string | null
required

Templated headline over the served page access and findings counts.

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.

state
enum<string>
required
Available options:
ready,
awaiting_first_crawl
total
integer
required
website
V1BrandWebsite · object
required

The Website score, findings and changes from the newest weekly read whose website read is decided, named in meta.data_as_of; pending with no figures before one.