> ## 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.

# 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.



## OpenAPI

````yaml /api-reference/openapi.json get /{brand_id}/sitemap/pages
openapi: 3.1.0
info:
  title: Scrunch Data API
  version: 0.1.0
servers:
  - url: https://api.scrunchai.com/v1
security: []
paths:
  /{brand_id}/sitemap/pages:
    get:
      tags:
        - sitemap
      summary: List Sitemap Pages
      description: >-
        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.
      operationId: listSitemapPages
      parameters:
        - name: brand_id
          in: path
          required: true
          schema:
            type: integer
            title: Brand Id
            description: The unique identifier for the brand.
          description: The unique identifier for the brand.
        - name: domain
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter to a specific domain when the brand has multiple registered
              sites.
            title: Domain
          description: >-
            Filter to a specific domain when the brand has multiple registered
            sites.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 100
            description: Maximum number of pages to return. Defaults to 100.
            title: Limit
          description: Maximum number of pages to return. Defaults to 100.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            description: Number of pages to skip. Use with `limit` for pagination.
            title: Offset
          description: Number of pages to skip. Use with `limit` for pagination.
        - name: max_depth
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 0
              - type: 'null'
            description: Maximum URL path depth to include. `0` returns root pages only.
            title: Max Depth
          description: Maximum URL path depth to include. `0` returns root pages only.
        - name: path_prefix
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by segment-aligned URL path prefix. For example `/blog`
              matches `/blog` and `/blog/post` but not `/blogger`.
            title: Path Prefix
          description: >-
            Filter by segment-aligned URL path prefix. For example `/blog`
            matches `/blog` and `/blog/post` but not `/blogger`.
        - name: is_priority
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: Filter to (or exclude) pages flagged as priority for the brand.
            title: Is Priority
          description: Filter to (or exclude) pages flagged as priority for the brand.
        - name: has_optimized_content
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: >-
              Filter to (or exclude) pages with active AXP optimized content
              deployed.
            title: Has Optimized Content
          description: >-
            Filter to (or exclude) pages with active AXP optimized content
            deployed.
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Case-insensitive substring match against the page URL or title.
            title: Search
          description: Case-insensitive substring match against the page URL or title.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SitemapPagesResponse'
        '404':
          description: No completed sitemap crawl found for this brand.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer:
            - query
components:
  schemas:
    SitemapPagesResponse:
      properties:
        total:
          type: integer
          title: Total
        offset:
          type: integer
          title: Offset
          default: 0
        limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Limit
        items:
          items:
            $ref: '#/components/schemas/SitemapPageListing'
          type: array
          title: Items
        domain:
          type: string
          title: Domain
          description: The domain these pages belong to.
        last_crawl_completed:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Crawl Completed
          description: When the most recent completed crawl finished.
      type: object
      required:
        - total
        - items
        - domain
        - last_crawl_completed
      title: SitemapPagesResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SitemapPageListing:
      properties:
        id:
          type: integer
          title: Id
          description: Unique page identifier.
        url:
          type: string
          title: Url
          description: Full URL of the page.
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: HTML title of the page.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Meta description of the page.
        depth:
          type: integer
          title: Depth
          description: URL path depth (`0` = root).
        audit_score:
          anyOf:
            - type: integer
            - type: 'null'
          title: Audit Score
          description: AI search readiness score (0-100).
        canonical_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Canonical Url
          description: Canonical URL if different from the page's URL.
        is_priority:
          type: boolean
          title: Is Priority
          description: >-
            Whether this page matches a priority page or priority path override
            for the brand.
        has_optimized_content:
          type: boolean
          title: Has Optimized Content
          description: Whether this page has active AXP optimized content deployed.
      type: object
      required:
        - id
        - url
        - title
        - description
        - depth
        - audit_score
        - canonical_url
        - is_priority
        - has_optimized_content
      title: SitemapPageListing
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````