Skip to main content
GET
Get Audit Map

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

as_of
string<uuid> | null

Completed scan id cutoff.

page
string | null

A page URL whose language to open when language is unset.

Maximum string length: 2048
language
string | null

A code from languages; default the site's primary language.

Maximum string length: 35
folder
string | null

A path such as /blog: its own pages and the folders under it, in place of every page. / is the top of the site.

Maximum string length: 2048
folder_pages_limit
integer
default:50

The folder's pages listed, with folder.

Required range: 1 <= x <= 200
folder_pages_offset
integer
default:0

Pages to skip within the folder.

Required range: x >= 0

Response

Successful Response

A run's frozen map in one language: its pages, the links between them and what each holds back. With folder, that folder's pages and the folders under it.

archives
V1MapArchive · object[]
required
categories
V1MapCategory · object[]
required
citations
Citations · object | null
required

Positive citation counts keyed by the listed pages' URLs, from the same pinned weekly report; null without complete citation measurements.

collections
V1MapCollection · object[]
required
counts
V1MapCounts · object | null
required

Over every page in the language.

findings
V1MapFinding · object[]
required
folder_pages_total
integer
required
read-only

All pages in this folder before paging.

folders
V1MapFolder · object[]
required

The folders under folder, or under /.

fully_read
boolean
default:false
required

The run read the whole site, with no sampled or truncated discovery; false when the stored graph has no flag.

language
string | null
required
languages
V1WebsiteLanguage · object[]
required

Links between the pages listed.

meta
Meta · object
required

Normalized query and newest included scan.

pages
V1MapPage · object[]
required
pages_total
integer
required

The pages before folder_pages_limit cuts them.

site
string | null
required
site_pages
integer | null
required

Pages on the site in every language, the Website read's coverage.pages for the same run; null with no map.

state
enum<string>
required
Available options:
complete,
pending,
unavailable
unrecorded
integer
required