Sign in

v1

latestOpenAPI 3.1.02026-07-263370112.1 KB
sitemap

Export Sitemap Pages

Download every page matching the supplied filters as CSV or XLSX. Uses the same filters as the list endpoint but skips pagination.

With include_metrics=true (the default), each row also includes totals over the selected date range for agent_traffic, citations, and ai_referrals, plus a percent-change column comparing the first and last buckets of the range — matching the totals and trend percentages shown in the sitemap UI.

Limits:

  • Maximum 10,000 rows per export.
  • Maximum 366-day window for start_date/end_date.

The response sets Content-Disposition with a sitemap-{brand_id}-{YYYY-MM-DD}.{csv|xlsx} filename.

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 returns a UTF-8 (BOM) CSV stream. xlsx returns a binary Excel workbook.

Output format. csv returns a UTF-8 (BOM) CSV stream. xlsx returns a binary Excel workbook.

mapped_site_idinteger nullable

Explicit sitemap (mapped site) identifier to export. Defaults to the latest finished crawl for the brand and optional domain.

Explicit sitemap (mapped site) identifier to export. Defaults to the latest finished crawl for the brand and optional domain.

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.

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.

Filter by segment-aligned URL path prefix.

is_priorityboolean nullable

Filter to (or exclude) priority pages.

Filter to (or exclude) priority pages.

has_optimized_contentboolean nullable

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

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

searchstring nullable

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

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

include_metricsboolean

Include per-page totals and percent-change columns for agent_traffic, citations, and ai_referrals over the selected date range.

Include per-page totals and percent-change columns for agent_traffic, citations, and ai_referrals over the selected date range.

start_datestring date 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 date nullable

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

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

Response

Streamed export file.