Skip to main content
GET
Browse a site's pages as a folder tree
Get an aggregated view of pages organized by URL folder path. Returns folder health, traffic, crawl metrics, and issue counts. Without page or pageSize it returns every folder. Send either to get one page of rows with the pagination totals. Visitor counts need analyticsProvider set to the brand’s connected analytics integration (ga, posthog, plausible or snow). Sorting by visitors or visitorsChange without it returns 400.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Query Parameters

teamId
string

Team ID

startDate
string

Start date (YYYY-MM-DD on the team's calendar).

endDate
string

End date (YYYY-MM-DD on the team's calendar). A start with no end runs to today; an end with no start means All Time.

days
integer
default:30

Days back from today on the team's calendar, converted to startDate/endDate. Ignored when startDate or endDate is set. Defaults to 30.

Required range: x >= 1
country
string

ISO-3 country code to filter Search Console rows by.

device
string

Device filter: desktop, mobile or tablet.

type
string

Search type: web, image, video or news.

page
integer

1-based page of rows. Omit page and pageSize for every row, unpaginated.

Required range: x >= 1
pageSize
string

Rows per page, or 'all'.

Matches folder and page names, page URLs and top pages.

sortBy
enum<string>
Available options:
name,
visitors,
position,
keywords,
auditScore,
aiCitations,
clicks,
impressions,
ctr,
visitorsChange,
positionChange,
keywordsChange,
clicksChange,
impressionsChange,
ctrChange
sortDir
enum<string>
Available options:
asc,
desc
analyticsProvider
enum<string>

Connected analytics integration to read page visitors from: ga (Google Analytics), posthog, plausible or snow (Snow Analytics). Without it, rows carry no visitor counts, and sorting by visitors returns 400.

Available options:
ga,
posthog,
plausible,
snow
path
string

Folder to list, e.g. /blog. Defaults to / (the site root).

Response

200 - application/json

Default Response

path
string
required
folders
object[]
required
pages
object[]
required
pagination
object
groupOrder
string[]
analyticsPaths
string[]
analyticsPageviews
number
analyticsPageviewsChange
number | null
breadcrumb
object[]
pagesTotals
object
totals
object
series
object[]
connected
boolean
startDate
string | null
endDate
string | null