v1

latestOpenAPI 3.1.02026-07-263370112.1 KB
sitemap

List Sitemap Pages

List pages discovered in the brand's sitemap with their title, description, depth, audit score, priority flag, and optimized-content flag.

Results come from the most recent completed crawl for the brand. Supports filtering by domain, URL depth, path prefix, priority flag, optimized-content flag, and a case-insensitive substring search across the page URL and title.

Results are paginated and ordered by depth then URL.

get/{brand_id}/sitemap/pages

Path parameters

brand_idinteger required

The unique identifier for the brand.

The unique identifier for the brand.

Query parameters

domainstring nullable

Filter to a specific domain when the brand has multiple registered sites.

Filter to a specific domain when the brand has multiple registered sites.

limitinteger

Maximum number of pages to return. Defaults to 100.

Maximum number of pages to return. Defaults to 100.

offsetinteger

Number of pages to skip. Use with limit for pagination.

Number of pages to skip. Use with limit for pagination.

max_depthinteger nullable

Maximum URL path depth to include. 0 returns root pages only.

Maximum URL path depth to include. 0 returns root pages only.

path_prefixstring nullable

Filter by segment-aligned URL path prefix. For example /blog matches /blog and /blog/post but not /blogger.

Filter by segment-aligned URL path prefix. For example /blog matches /blog and /blog/post but not /blogger.

is_priorityboolean nullable

Filter to (or exclude) pages flagged as priority for the brand.

Filter to (or exclude) pages flagged as priority for the brand.

has_optimized_contentboolean nullable

Filter to (or exclude) pages with active AXP optimized content deployed.

Filter to (or exclude) pages with active AXP optimized content deployed.

searchstring nullable

Case-insensitive substring match against the page URL or title.

Case-insensitive substring match against the page URL or title.

Response

Successful Response

totalinteger required
offsetinteger
limitinteger nullable
domainstring required

The domain these pages belong to.

last_crawl_completedstring date-time nullable required

When the most recent completed crawl finished.