latestOpenAPI 3.1.02026-08-204087139.4 KB

c4fe20c603a3

sitemap

Export Sitemap Pages

Download every page in the brand's sitemap as CSV or XLSX. Same filters as the listing endpoint, no pagination. With include_metrics (default true), each row also includes totals over the selected date range for agent_traffic, citations, and ai_referrals, plus percent change from the first bucket to the last bucket — matching the totals and trend % shown in the sitemap UI.

get/{brand_id}/sitemap/export

Path parameters

brand_idinteger required

The unique identifier for the brand

The unique identifier for the brand

Query parameters

format'csv' | 'xlsx'

Output format: csv or xlsx

Output format: csv or xlsx

mapped_site_idinteger nullable

Explicit sitemap (mapped_site_id) to export. The FE passes this so the export operates on the sitemap the user is currently viewing, even if it isn't the latest finished crawl for the domain. Defaults to the latest finished crawl for the brand (and optionally the supplied domain).

Explicit sitemap (mapped_site_id) to export. The FE passes this so the export operates on the sitemap the user is currently viewing, even if it isn't the latest finished crawl for the domain. Defaults to the latest finished crawl for the brand (and optionally the supplied domain).

domainstring nullable

Filter by domain (for brands with multiple sites)

Filter by domain (for brands with multiple sites)

max_depthinteger nullable

Maximum URL path depth to include (0 = root only)

Maximum URL path depth to include (0 = root only)

path_prefixstring nullable

Filter by URL path prefix (e.g. /blog)

Filter by URL path prefix (e.g. /blog)

is_priorityboolean nullable

Filter to (or exclude) pages flagged as priority

Filter to (or exclude) pages flagged as priority

has_optimized_contentboolean nullable

Filter to (or exclude) pages with active AXP content

Filter to (or exclude) pages with active AXP content

searchstring nullable

Case-insensitive substring match on the page URL or title — mirrors the 'Find pages...' input in the UI.

Case-insensitive substring match on the page URL or title — mirrors the 'Find pages...' input in the UI.

include_metricsboolean

Include per-page totals for agent_traffic, citations, ai_referrals (summed over the selected date range), plus percent-change from the first bucket to the last bucket of the same series — matching the trend % shown next to each metric in the sitemap UI.

Include per-page totals for agent_traffic, citations, ai_referrals (summed over the selected date range), plus percent-change from the first bucket to the last bucket of the same series — matching the trend % shown next to each metric in the sitemap UI.

start_datestring nullable

Metrics start date (YYYY-MM-DD). Defaults to 30 days ago.

Metrics start date (YYYY-MM-DD). Defaults to 30 days ago.

end_datestring nullable

Metrics end date (YYYY-MM-DD). Defaults to today.

Metrics end date (YYYY-MM-DD). Defaults to today.

tzstring nullable

User's IANA timezone (e.g. 'America/Denver'). When provided, the export drops the trailing weekly bucket that falls on today in that timezone — matching the sitemap UI's chart filter so totals and change_pct line up with what the user sees on screen. Omit for external API consumers who want the raw date range.

User's IANA timezone (e.g. 'America/Denver'). When provided, the export drops the trailing weekly bucket that falls on today in that timezone — matching the sitemap UI's chart filter so totals and change_pct line up with what the user sees on screen. Omit for external API consumers who want the raw date range.

Response

Successful Response

{"stackTrail":"paths:/{brand_id}/sitemap/export:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}