---
title: "List Sitemap Pages"
method: GET
path: "/{brand_id}/sitemap/pages"
tags: ["sitemap"]
---

# List Sitemap Pages

`GET /{brand_id}/sitemap/pages`

## Request

- Base URL: `https://api.scrunchai.com/v1`
- URL: `https://api.scrunchai.com/v1/{brand_id}/sitemap/pages`
- Auth: HTTP bearer

List pages in the brand's sitemap with their title, description, and audit score. Data comes from the most recent completed crawl. Supports filtering by URL depth and path prefix.

## Path parameters

- `brand_id` integer, required: The unique identifier for the brand

## Query parameters

- `domain` string, nullable: Filter by domain (for brands with multiple sites)
- `limit` integer
- `offset` integer
- `max_depth` integer, nullable: Maximum URL path depth to include (0 = root only)
- `path_prefix` string, nullable: Filter by URL path prefix (e.g. /blog)
- `is_priority` boolean, nullable: Filter to (or exclude) pages flagged as priority for the brand
- `has_optimized_content` boolean, nullable: Filter to (or exclude) pages with active AXP optimized content
- `search` string, nullable: Case-insensitive substring match on the page URL or title — mirrors the 'Find pages...' input in the UI.

## Response `200`

Successful Response

- SitemapPagesResponse: Paginated list of sitemap pages with crawl metadata.
  - `total` integer, required
  - `offset` integer
  - `limit` integer, nullable
  - `items` SitemapPageListing[], required
    - `id` integer, required: Unique page identifier
    - `url` string, required: Full URL of the page
    - `title` string, nullable, required: HTML title of the page
    - `description` string, nullable, required: Meta description of the page
    - `depth` integer, required: URL path depth (0 = root)
    - `audit_score` integer, nullable, required: AI search readiness score (0-100)
    - `canonical_url` string, nullable, required: The canonical URL if different from this page's URL
    - `is_priority` boolean, required: Whether this page matches a priority_page/priority_path override for the brand
    - `has_optimized_content` boolean, required: Whether this page has active AXP optimized content deployed
  - `metadata` TimeSeriesMetadata
    - `aggregation_granularity` 'daily' | 'weekly' | 'monthly', required
    - `period_count` integer, required: The number of periods in the time series
    - `start_date` string, date-time, required: The start date of the time series
    - `end_date` string, date-time, required: The end date of the time series
    - `top_domains` TopDomainsMetadata: Metadata about top domains, used by sources/domains endpoints.
      - `domains` TopDomainSummary[], required: Top domains by observation count (always domain-level aggregated)
        - `domain` string, required
        - `domain_owner` string, required
        - `observation_count` integer, required
      - `grand_total` integer, required: Total observation count across all domains (for calculating 'Other')
      - `owner_totals` object, required: Observation counts by owner type (brand, competitor, other)
      - `owner_time_series` OwnerTimeSeriesPoint[], nullable: Time series data by owner type for trend visualization
        - `time_bucket` string, required: Date string for the time bucket (YYYY-MM-DD)
        - `brand` integer, required: Observation count for brand-owned domains
        - `competitor` integer, required: Observation count for competitor-owned domains
        - `other` integer, required: Observation count for third-party domains
      - `segment_totals` SegmentTotal[]: Server-side observation counts per citation segment (covers all domains, not just top-N)
        - `name` string, required
        - `observation_count` integer, required
  - `domain` string, required: The domain these pages belong to
  - `last_crawl_completed` string, date-time, nullable, required: When the most recent completed crawl finished

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/scrunchai/apis/scrunch-data-api.md) - [All operations](https://skmtc.dev/scrunchai/apis/scrunch-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scrunchai/apis/scrunch-data-api/revisions/de4fc679600a?raw)