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

# Site Health Pages

> Pages with SEO issues (missing title/description, H1 problems, thin content). Omit issueTypes to return all issue types.



## OpenAPI

````yaml /v2/openapi.json get /site-health
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:
  /site-health:
    get:
      tags:
        - Site Health
      summary: Site Health Pages
      description: >-
        Pages with SEO issues (missing title/description, H1 problems, thin
        content). Omit issueTypes to return all issue types.
      operationId: getSiteHealth
      parameters:
        - 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: 20
          in: query
          name: size
          required: false
          description: Page size
        - schema:
            anyOf:
              - type: string
                enum:
                  - missingTitle
                  - missingDescription
                  - noH1
                  - multipleH1
                  - thinContent
              - type: array
                items:
                  type: string
                  enum:
                    - missingTitle
                    - missingDescription
                    - noH1
                    - multipleH1
                    - thinContent
          in: query
          name: issueTypes
          required: false
          description: >-
            Filter by SEO issue type. Repeat for multiple:
            issueTypes=missingTitle&issueTypes=noH1. Omit for all.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  pages:
                    - url: https://example.com/no-title
                      issue: missingTitle
                      crawledAt: '2026-05-18T12:00:00.000Z'
                  total: 8
                  page: 1
                  size: 20
                  totalPages: 1
                properties:
                  pages:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                          description: Canonical page URL
                        issue:
                          type: string
                          enum:
                            - missingTitle
                            - missingDescription
                            - noH1
                            - multipleH1
                            - thinContent
                          description: Detected SEO issue
                        crawledAt:
                          type: string
                          description: Crawl timestamp (ISO) from the page document
                      required:
                        - url
                      additionalProperties: false
                    description: Pages matching the requested issue types
                  total:
                    type: integer
                    description: Total pages matching the requested issue types
                  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:
                  - pages
                  - 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
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: SITE_HEALTH_WEBSITE_NOT_CONFIGURED
                  message: Project website is not configured
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - SITE_HEALTH_WEBSITE_NOT_CONFIGURED
                      - SITE_HEALTH_QUERY_FAILED
                      - INTERNAL_ERROR
                    example: SITE_HEALTH_WEBSITE_NOT_CONFIGURED
                  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_HEALTH_WEBSITE_NOT_CONFIGURED
                  message: Project website is not configured
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - SITE_HEALTH_WEBSITE_NOT_CONFIGURED
                      - SITE_HEALTH_QUERY_FAILED
                      - INTERNAL_ERROR
                    example: SITE_HEALTH_WEBSITE_NOT_CONFIGURED
                  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.

````