Skip to main content
GET
/
{brand_id}
/
sitemap
/
export
Export Sitemap Pages
curl --request GET \
  --url https://api.scrunchai.com/v1/{brand_id}/sitemap/export \
  --header 'Authorization: Bearer <token>'
"<string>"

Documentation Index

Fetch the complete documentation index at: https://developers.scrunch.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
brand_id
integer
required

The unique identifier for the brand.

Query Parameters

​
format
enum<string>
default:csv

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

Available options:
csv,
xlsx
​
mapped_site_id
integer | null

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

​
domain
string | null

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

​
max_depth
integer | null

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

Required range: x >= 0
​
path_prefix
string | null

Filter by segment-aligned URL path prefix.

​
is_priority
boolean | null

Filter to (or exclude) priority pages.

​
has_optimized_content
boolean | null

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

​
search
string | null

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

​
include_metrics
boolean
default:true

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

​
start_date
string<date> | null

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

​
end_date
string<date> | null

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

Response

Streamed export file.

UTF-8 (BOM) CSV. First row is the column header.