> ## Documentation Index
> Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Sitemap URLs

> Paginated list of sitemap URLs for the project. Optionally use filter to narrow to errored (failed/blocked), redirected, or in-progress URLs.



## OpenAPI

````yaml /v2/openapi.json get /sitemap/urls
openapi: 3.0.0
info:
  title: Promptwatch API v2
  description: >-
    API v2 for customer integrations with Promptwatch monitoring platform. This
    version provides improved structure, additional endpoints, and enhanced
    functionality.
  version: 2.0.0
  contact:
    name: Promptwatch Support
    email: team@promptwatch.com
    url: https://promptwatch.com
  license:
    name: Commercial
    url: https://promptwatch.com/terms-and-conditions
servers:
  - url: https://server.promptwatch.com/api/v2
    description: Promptwatch API v2
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Content
    description: >-
      AI content generation and optimization. Create content asynchronously and
      poll for results.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and CRUD operations
  - name: Page Tracker
    description: Track URLs and inspect citation stats, responses, and prompts
  - name: Prompts
    description: Prompt management and operations
  - name: Query Fanouts
    description: ChatGPT query fanout keywords
  - name: Responses
    description: LLM response data and analytics
  - name: Tags
    description: Tag management for prompts
  - name: Topics
    description: Topic management for prompts
  - name: Actions
    description: Action items (GEO suggestions and tasks)
  - name: Personas
    description: Persona configuration for monitors
  - name: Brands
    description: Brand management for competitive analysis
  - name: Visibility
    description: Brand visibility time series and competitor heatmaps
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Sitemap
    description: Sitemap crawl progress and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Socials
    description: >-
      Social media citations (Reddit posts and YouTube videos) found in LLM
      responses
paths:
  /sitemap/urls:
    get:
      tags:
        - Sitemap
      summary: List Sitemap URLs
      description: >-
        Paginated list of sitemap URLs for the project. Optionally use filter to
        narrow to errored (failed/blocked), redirected, or in-progress URLs.
      operationId: listSitemapUrls
      parameters:
        - schema:
            type: string
            enum:
              - errored
              - redirected
              - inProgress
          in: query
          name: filter
          required: false
          description: >-
            Optional. Narrow results: errored (failed/blocked), redirected (3xx
            with target), inProgress (queued for crawl). Omit to return all
            crawl-scope URLs.
        - schema:
            type: integer
            default: 1
            minimum: 1
          in: query
          name: page
          required: false
          description: Page number (1-based)
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          in: query
          name: size
          required: false
          description: Page size
        - schema:
            type: string
            enum:
              - canonical
              - lastContentCrawlHttpStatus
              - contentCrawlAttempts
              - lastContentCrawledAt
              - updatedAt
              - createdAt
            default: lastContentCrawledAt
          in: query
          name: sortBy
          required: false
          description: Field to sort by
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          in: query
          name: sortOrder
          required: false
          description: Sort direction
        - schema:
            anyOf:
              - type: integer
              - type: array
                items:
                  type: integer
          in: query
          name: httpStatuses
          required: false
          description: >-
            When filter=errored, restrict to specific HTTP status codes. Repeat
            the param for multiple values.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  items:
                    - id: 550e8400-e29b-41d4-a716-446655440000
                      url: https://example.com/inventory/123
                      rawUrl: https://example.com/inventory/123/
                      status: ERROR
                      httpStatus: 403
                      crawlAttempts: 3
                      lastCrawledAt: '2026-05-18T12:00:00.000Z'
                      redirectsTo: null
                      createdAt: '2026-04-01T08:00:00.000Z'
                      updatedAt: '2026-05-18T12:00:00.000Z'
                  total: 142
                  page: 1
                  size: 50
                  totalPages: 3
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Sitemap URL identifier
                        url:
                          type: string
                          description: Canonical URL
                        rawUrl:
                          type: string
                          description: Original URL as discovered
                        status:
                          type: string
                          enum:
                            - DISCOVERED
                            - CRAWLED
                            - ERROR
                            - EXCLUDED
                            - REPROCESSING
                          description: Crawl lifecycle status
                        httpStatus:
                          type: integer
                          nullable: true
                          description: HTTP status from the last content crawl attempt
                        crawlAttempts:
                          type: integer
                          description: Number of content crawl attempts
                        lastCrawledAt:
                          type: string
                          nullable: true
                          format: date-time
                          description: When this URL was last content-crawled
                        redirectsTo:
                          type: string
                          nullable: true
                          description: Canonical target when the URL redirects (3xx)
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - url
                        - rawUrl
                        - status
                        - httpStatus
                        - crawlAttempts
                        - lastCrawledAt
                        - redirectsTo
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  total:
                    type: integer
                    description: Total items matching the request
                  page:
                    type: integer
                    description: Page number (1-based)
                  size:
                    type: integer
                    description: Page size
                  totalPages:
                    type: integer
                    description: Total pages for this page size
                required:
                  - items
                  - total
                  - page
                  - size
                  - totalPages
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Bad Request
                  code: DATE_RANGE_TOO_LARGE
                  message: Date range cannot exceed 90 days
                properties:
                  error:
                    type: string
                    description: Error label
                  code:
                    type: string
                    description: Optional machine-readable code (e.g. DATE_RANGE_TOO_LARGE)
                  message:
                    type: string
                    description: Reason the request was rejected
                required:
                  - error
                  - message
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized
                  message: Missing or invalid X-API-Key header.
                properties:
                  error:
                    type: string
                    description: Error category (often aligned with HTTP semantics)
                  code:
                    type: string
                    description: Optional machine-readable code
                  message:
                    type: string
                    description: Human-readable explanation
                  details:
                    type: object
                    description: Optional structured detail (e.g. validation)
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: INTERNAL_ERROR
                  message: An unexpected error occurred
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - INTERNAL_ERROR
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get yours from the Promptwatch dashboard
        under Settings > API Keys.

````