> ## 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 failing URLs of a run

> URLs that answered 4xx/5xx or nothing in the run, each with the run its current failure streak started in. Keyset-paginated: pass the returned nextCursor as `cursor`.



## OpenAPI

````yaml /v2/openapi.json get /site-audit/failing-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 content refresh. Create content asynchronously
      and poll for results.
  - name: Content Agent
    description: >-
      Content Agent (automated content) lifecycle: project settings, scheduled
      slots, review (accept/decline), and publish.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Publishing
    description: >-
      Publish content to a connected CMS, or record a live URL, and track the
      published page
  - 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: Events
    description: >-
      Dated project events such as prompts added and actions completed, for
      annotating time series
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Search Insights
    description: >-
      Google Search Console and Bing Webmaster performance for the project
      website
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Usage
    description: Plan usage and limits (organization-level keys only)
  - name: Sitemap
    description: Sitemap feeds, crawler settings, crawl progress, and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Site Audit
    description: >-
      Site audit runs: health score over time, per-check issue counts and
      failing URLs
  - name: Socials
    description: >-
      Social media citations (Reddit posts, YouTube videos, and LinkedIn posts)
      found in LLM responses
  - name: Ads Radar
    description: Sponsored ads captured in AI answers
  - name: Shopping
    description: Product appearances in AI shopping answers and tracked products
paths:
  /site-audit/failing-urls:
    get:
      tags:
        - Site Audit
      summary: List failing URLs of a run
      description: >-
        URLs that answered 4xx/5xx or nothing in the run, each with the run its
        current failure streak started in. Keyset-paginated: pass the returned
        nextCursor as `cursor`.
      operationId: listSiteAuditFailingUrls
      parameters:
        - schema:
            type: string
            format: uuid
          in: query
          name: runId
          required: true
          description: Audit run to read failing URLs from
        - schema:
            type: string
          in: query
          name: cursor
          required: false
          description: urlHash from the previous response's nextCursor
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          in: query
          name: limit
          required: false
          description: Page size (default 50, max 200)
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  urls:
                    - url: https://example.com/gone
                      finalUrl: https://example.com/gone
                      urlHash: 9f2b1c4d5e6f7a8b
                      statusCode: 404
                      errorType: ''
                      ttfbMs: 120
                      checkedAt: '2026-08-01T09:12:00.000Z'
                      failedRuns: 3
                      firstSeenAt: '2026-07-11T09:10:00.000Z'
                      firstSeenRunId: 6ba7b821-9dad-11d1-80b4-00c04fd430c8
                  nextCursor: null
                properties:
                  urls:
                    type: array
                    items:
                      type: object
                      example:
                        url: https://example.com/gone
                        finalUrl: https://example.com/gone
                        urlHash: 9f2b1c4d5e6f7a8b
                        statusCode: 404
                        errorType: ''
                        ttfbMs: 120
                        checkedAt: '2026-08-01T09:12:00.000Z'
                        failedRuns: 3
                        firstSeenAt: '2026-07-11T09:10:00.000Z'
                        firstSeenRunId: 6ba7b821-9dad-11d1-80b4-00c04fd430c8
                      properties:
                        url:
                          type: string
                          description: Checked URL
                        finalUrl:
                          type: string
                          description: URL the check landed on after redirects
                        urlHash:
                          type: string
                          description: >-
                            Stable hash of the canonical URL; also the keyset
                            cursor value
                        statusCode:
                          type: integer
                          nullable: true
                          description: HTTP status; null when the request never completed
                        errorType:
                          type: string
                          description: >-
                            Transport failure kind, empty when the server
                            answered
                        ttfbMs:
                          type: integer
                          nullable: true
                          description: Time to first byte in milliseconds
                        checkedAt:
                          type: string
                          format: date-time
                          description: When this run checked the URL
                        failedRuns:
                          type: integer
                          description: Consecutive runs this URL has been failing for
                        firstSeenAt:
                          type: string
                          format: date-time
                          description: When the current failure streak started
                        firstSeenRunId:
                          type: string
                          format: uuid
                          description: Run the current failure streak started in
                      required:
                        - url
                        - finalUrl
                        - urlHash
                        - statusCode
                        - errorType
                        - ttfbMs
                        - checkedAt
                        - failedRuns
                        - firstSeenAt
                        - firstSeenRunId
                      additionalProperties: false
                    description: URLs that answered 4xx/5xx or nothing in the run
                  nextCursor:
                    type: string
                    nullable: true
                    description: >-
                      Pass as `cursor` to fetch the next page; null on the last
                      page
                required:
                  - urls
                  - nextCursor
                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
        '402':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: SITE_AUDIT_RUN_NOT_FOUND
                  message: Site audit run not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - SITE_AUDIT_PLAN_REQUIRED
                      - SITE_AUDIT_RUN_NOT_FOUND
                      - INTERNAL_ERROR
                    example: SITE_AUDIT_PLAN_REQUIRED
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: SITE_AUDIT_RUN_NOT_FOUND
                  message: Site audit run not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - SITE_AUDIT_PLAN_REQUIRED
                      - SITE_AUDIT_RUN_NOT_FOUND
                      - INTERNAL_ERROR
                    example: SITE_AUDIT_PLAN_REQUIRED
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: SITE_AUDIT_RUN_NOT_FOUND
                  message: Site audit run not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - SITE_AUDIT_PLAN_REQUIRED
                      - SITE_AUDIT_RUN_NOT_FOUND
                      - INTERNAL_ERROR
                    example: SITE_AUDIT_PLAN_REQUIRED
                  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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.