> ## 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 site audit issues

> URLs a run flagged, errors first, then by check within a tier. Filter by check id, severity or a URL substring. Omit runId for the newest finished run. Keyset-paginated: pass the returned nextCursor as `cursor`.



## OpenAPI

````yaml /v2/openapi.json get /site-audit/issues
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, competitor heatmaps, and performance
      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: Deprecated. Legacy SEO issue pages. Use Site Audit for the current checks.
  - name: Site Audit
    description: >-
      Site audit runs, issue lists, link and content insights, and per-URL
      history
  - 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/issues:
    get:
      tags:
        - Site Audit
      summary: List site audit issues
      description: >-
        URLs a run flagged, errors first, then by check within a tier. Filter by
        check id, severity or a URL substring. Omit runId for the newest
        finished run. Keyset-paginated: pass the returned nextCursor as
        `cursor`.
      operationId: listSiteAuditIssues
      parameters:
        - schema:
            type: string
          in: query
          name: cursor
          required: false
          description: Cursor from the previous response's nextCursor
        - schema:
            anyOf:
              - type: string
                enum:
                  - status4xx
                  - status5xx
                  - brokenInternalLink
                  - redirectChainTooLong
                  - missingTitle
                  - noH1
                  - certificateInvalid
                  - sitemapUrlRedirects
                  - orphanPage
                  - missingDescription
                  - multipleH1
                  - thinContent
                  - slowTtfb
                  - oversizedHtml
                  - certificateExpiringSoon
                  - linkedNotInSitemap
                  - titleLengthOutOfRange
                  - externalCanonical
                  - duplicateContent
                  - navOnlyPage
                  - contentRequiresJs
                description: >-
                  Check id (status4xx, status5xx, brokenInternalLink,
                  redirectChainTooLong, missingTitle, noH1, certificateInvalid,
                  sitemapUrlRedirects, orphanPage, missingDescription,
                  multipleH1, thinContent, slowTtfb, oversizedHtml,
                  certificateExpiringSoon, linkedNotInSitemap,
                  titleLengthOutOfRange, externalCanonical, duplicateContent,
                  navOnlyPage, contentRequiresJs)
              - type: array
                items:
                  type: string
                  enum:
                    - status4xx
                    - status5xx
                    - brokenInternalLink
                    - redirectChainTooLong
                    - missingTitle
                    - noH1
                    - certificateInvalid
                    - sitemapUrlRedirects
                    - orphanPage
                    - missingDescription
                    - multipleH1
                    - thinContent
                    - slowTtfb
                    - oversizedHtml
                    - certificateExpiringSoon
                    - linkedNotInSitemap
                    - titleLengthOutOfRange
                    - externalCanonical
                    - duplicateContent
                    - navOnlyPage
                    - contentRequiresJs
                  description: >-
                    Check id (status4xx, status5xx, brokenInternalLink,
                    redirectChainTooLong, missingTitle, noH1,
                    certificateInvalid, sitemapUrlRedirects, orphanPage,
                    missingDescription, multipleH1, thinContent, slowTtfb,
                    oversizedHtml, certificateExpiringSoon, linkedNotInSitemap,
                    titleLengthOutOfRange, externalCanonical, duplicateContent,
                    navOnlyPage, contentRequiresJs)
          in: query
          name: issues
          required: false
          description: >-
            Checks to include. Repeat for multiple:
            issues=status4xx&issues=missingTitle. Omit for every check that
            fired. Ids: status4xx, status5xx, brokenInternalLink,
            redirectChainTooLong, missingTitle, noH1, certificateInvalid,
            sitemapUrlRedirects, orphanPage, missingDescription, multipleH1,
            thinContent, slowTtfb, oversizedHtml, certificateExpiringSoon,
            linkedNotInSitemap, titleLengthOutOfRange, externalCanonical,
            duplicateContent, navOnlyPage, contentRequiresJs.
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          in: query
          name: limit
          required: false
          description: Page size (default 50, max 200)
        - schema:
            type: string
            format: uuid
          in: query
          name: runId
          required: false
          description: Defaults to the latest finished run
        - schema:
            type: string
            maxLength: 200
          in: query
          name: search
          required: false
          description: Case-insensitive URL substring
        - schema:
            type: string
            enum:
              - error
              - warning
              - notice
          in: query
          name: severity
          required: false
          description: Check severity
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  counts:
                    status4xx: 2
                  nextCursor: null
                  rows:
                    - checkedAt: '2026-08-01T09:12:00.000Z'
                      isNew: true
                      issue: status4xx
                      label: Page returns a 4xx error
                      severity: error
                      statusCode: 404
                      ttfbMs: 120
                      url: https://example.com/gone
                      urlHash: 9f2b1c4d5e6f7a8b
                  runId: 6ba7b820-9dad-11d1-80b4-00c04fd430c8
                  total: 2
                properties:
                  counts:
                    type: object
                    additionalProperties:
                      type: integer
                    description: >-
                      Affected URLs per check under the URL search alone, so a
                      filter can show what a pick would leave
                  nextCursor:
                    type: string
                    nullable: true
                    description: >-
                      Pass as `cursor` to fetch the next page; null on the last
                      page
                  rows:
                    type: array
                    items:
                      type: object
                      example:
                        checkedAt: '2026-08-01T09:12:00.000Z'
                        isNew: true
                        issue: status4xx
                        label: Page returns a 4xx error
                        severity: error
                        statusCode: 404
                        ttfbMs: 120
                        url: https://example.com/gone
                        urlHash: 9f2b1c4d5e6f7a8b
                      properties:
                        checkedAt:
                          type: string
                          format: date-time
                          description: >-
                            When this run checked the URL; null for link-derived
                            rows
                          nullable: true
                        isNew:
                          type: boolean
                          description: >-
                            Flagged this run and not the one before. Always
                            false for link-derived checks
                        issue:
                          type: string
                          enum:
                            - status4xx
                            - status5xx
                            - brokenInternalLink
                            - redirectChainTooLong
                            - missingTitle
                            - noH1
                            - certificateInvalid
                            - sitemapUrlRedirects
                            - orphanPage
                            - missingDescription
                            - multipleH1
                            - thinContent
                            - slowTtfb
                            - oversizedHtml
                            - certificateExpiringSoon
                            - linkedNotInSitemap
                            - titleLengthOutOfRange
                            - externalCanonical
                            - duplicateContent
                            - navOnlyPage
                            - contentRequiresJs
                          description: >-
                            Check id (status4xx, status5xx, brokenInternalLink,
                            redirectChainTooLong, missingTitle, noH1,
                            certificateInvalid, sitemapUrlRedirects, orphanPage,
                            missingDescription, multipleH1, thinContent,
                            slowTtfb, oversizedHtml, certificateExpiringSoon,
                            linkedNotInSitemap, titleLengthOutOfRange,
                            externalCanonical, duplicateContent, navOnlyPage,
                            contentRequiresJs)
                        label:
                          type: string
                          description: Human-readable check name
                        severity:
                          type: string
                          enum:
                            - error
                            - warning
                            - notice
                          description: Check severity
                        statusCode:
                          type: integer
                          nullable: true
                          description: HTTP status; null when the request never completed
                        ttfbMs:
                          type: integer
                          nullable: true
                          description: Time to first byte in milliseconds
                        url:
                          type: string
                          description: Affected URL
                        urlHash:
                          type: string
                          description: Stable hash of the canonical URL
                      required:
                        - checkedAt
                        - isNew
                        - issue
                        - label
                        - severity
                        - statusCode
                        - ttfbMs
                        - url
                        - urlHash
                      additionalProperties: false
                    description: Affected URLs, errors first, then by check within a tier
                  runId:
                    type: string
                    format: uuid
                    description: Run the response was read from
                  total:
                    type: integer
                    description: Affected URLs matching the filters
                required:
                  - counts
                  - nextCursor
                  - rows
                  - runId
                  - total
                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 92 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_PROJECT_NOT_FOUND
                      - 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_PROJECT_NOT_FOUND
                      - 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_PROJECT_NOT_FOUND
                      - 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.