> ## 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 link findings

> One link list for a run: orphans, brokenLinks, coverageGaps or navOnly. Omit runId for the newest finished run. truncated means the stored list hit its cap. The brokenLinks cursor is opaque; pass nextCursor back as `cursor`.



## OpenAPI

````yaml /v2/openapi.json get /site-audit/links
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/links:
    get:
      tags:
        - Site Audit
      summary: List site audit link findings
      description: >-
        One link list for a run: orphans, brokenLinks, coverageGaps or navOnly.
        Omit runId for the newest finished run. truncated means the stored list
        hit its cap. The brokenLinks cursor is opaque; pass nextCursor back as
        `cursor`.
      operationId: listSiteAuditLinks
      parameters:
        - schema:
            type: string
          in: query
          name: cursor
          required: false
          description: Cursor from the previous response's nextCursor
        - schema:
            type: string
            enum:
              - orphans
              - brokenLinks
              - coverageGaps
              - navOnly
          in: query
          name: kind
          required: true
          description: >-
            orphans (no inbound links), brokenLinks (edges to a dead page),
            coverageGaps (linked URLs never fetched) or navOnly (linked only
            from site-wide navigation)
        - 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
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  kind: brokenLinks
                  nextCursor: null
                  rows:
                    - anchorText: pricing
                      nofollow: false
                      sourceHash: 0f115db062b7c0dd
                      sourceUrl: https://example.com/
                      targetHash: 23a538fde85c5907
                      targetStatusCode: 404
                      targetUrl: https://example.com/pricing
                  runId: 6ba7b820-9dad-11d1-80b4-00c04fd430c8
                  total: 1
                  truncated: false
                properties:
                  kind:
                    type: string
                    enum:
                      - orphans
                      - brokenLinks
                      - coverageGaps
                      - navOnly
                    description: >-
                      orphans (no inbound links), brokenLinks (edges to a dead
                      page), coverageGaps (linked URLs never fetched) or navOnly
                      (linked only from site-wide navigation)
                  nextCursor:
                    type: string
                    nullable: true
                    description: >-
                      Pass as `cursor` to fetch the next page; null on the last
                      page
                  rows:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          example:
                            anchorText: pricing
                            nofollow: false
                            sourceHash: 0f115db062b7c0dd
                            sourceUrl: https://example.com/
                            targetHash: 23a538fde85c5907
                            targetStatusCode: 404
                            targetUrl: https://example.com/pricing
                          properties:
                            anchorText:
                              type: string
                              description: Anchor text of the link
                            nofollow:
                              type: boolean
                              description: Whether the link is nofollow
                            sourceHash:
                              type: string
                              description: Hash of the page that contains the link
                            sourceUrl:
                              type: string
                              description: Page that contains the link
                            targetHash:
                              type: string
                              description: Hash of the dead target
                            targetStatusCode:
                              type: integer
                              description: HTTP status of the target
                            targetUrl:
                              type: string
                              description: URL the link points at
                          required:
                            - anchorText
                            - nofollow
                            - sourceHash
                            - sourceUrl
                            - targetHash
                            - targetStatusCode
                            - targetUrl
                          additionalProperties: false
                        - type: object
                          example:
                            clickDepth: 1
                            inlinkCount: 300
                            statusCode: 200
                            url: https://example.com/terms
                            urlHash: cc33
                          properties:
                            clickDepth:
                              type: integer
                              nullable: true
                              description: >-
                                Clicks from the homepage; null when the walk
                                never reached the page
                            inlinkCount:
                              type: integer
                              description: Inbound links, including site-wide navigation
                            statusCode:
                              type: integer
                              nullable: true
                              description: HTTP status
                            url:
                              type: string
                              description: Page linked only from site-wide navigation
                            urlHash:
                              type: string
                              description: >-
                                Stable hash of the canonical URL; also the
                                keyset cursor value
                          required:
                            - clickDepth
                            - inlinkCount
                            - statusCode
                            - url
                            - urlHash
                          additionalProperties: false
                        - type: object
                          example:
                            exampleSourceUrl: https://example.com/
                            inlinkCount: 4
                            targetHash: bb22
                            targetUrl: https://example.com/missing
                          properties:
                            exampleSourceUrl:
                              type: string
                              description: One page that links to the missing URL
                            inlinkCount:
                              type: integer
                              description: Pages in the run that link to the missing URL
                            targetHash:
                              type: string
                              description: >-
                                Hash of the missing URL; also the keyset cursor
                                value
                            targetUrl:
                              type: string
                              description: Linked URL the run never fetched
                          required:
                            - exampleSourceUrl
                            - inlinkCount
                            - targetHash
                            - targetUrl
                          additionalProperties: false
                        - type: object
                          example:
                            checkedAt: '2026-08-01T09:00:00.000Z'
                            statusCode: 200
                            url: https://example.com/lonely
                            urlHash: aa11
                          properties:
                            checkedAt:
                              type: string
                              format: date-time
                              description: When this run checked the page
                            statusCode:
                              type: integer
                              nullable: true
                              description: HTTP status
                            url:
                              type: string
                              description: Page no other page links to
                            urlHash:
                              type: string
                              description: >-
                                Stable hash of the canonical URL; also the
                                keyset cursor value
                          required:
                            - checkedAt
                            - statusCode
                            - url
                            - urlHash
                          additionalProperties: false
                    description: Rows for the requested kind
                  runId:
                    type: string
                    format: uuid
                    description: Run the response was read from
                  total:
                    type: integer
                    description: Stored rows. A truncated list is a floor, not a count.
                  truncated:
                    type: boolean
                    description: >-
                      True when finalize capped how many rows of this kind it
                      stored
                required:
                  - kind
                  - nextCursor
                  - rows
                  - runId
                  - total
                  - truncated
                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.