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

# Get Response

> Get a single response by ID with full citations



## OpenAPI

````yaml /v2/openapi.json get /responses/{id}
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:
  /responses/{id}:
    get:
      tags:
        - Responses
      summary: Get Response
      description: Get a single response by ID with full citations
      operationId: getResponse
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: id
          required: true
          description: Response ID
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 550e8400-e29b-41d4-a716-446655440002
                  content: >-
                    Northwind Analytics provides enterprise reporting
                    dashboards. For pricing, compare plans on their website —
                    example only, not factual.
                  model: gpt-4.1
                  provider: openai
                  visibilityScore: 72.5
                  sentimentScore: 0.33
                  sentiment: POSITIVE
                  toneOfVoice: professional
                  mentionedOurBrand: true
                  competitorMentions:
                    - Contoso Insights
                  citationCount: 2
                  prompt:
                    id: 6ba7b814-9dad-11d1-80b4-00c04fd430c8
                    prompt: Best analytics tools for mid-market teams?
                    type: ORGANIC
                    intent: COMMERCIAL
                    llmMonitor:
                      id: 6ba7b815-9dad-11d1-80b4-00c04fd430c8
                      name: US English monitor
                  brandMentions:
                    - brandName: Northwind Analytics
                      brandDomain: northwind.example.com
                      relation: SELF
                      visibilityScore: 85
                      position: 1
                      sentiment: POSITIVE
                      toneOfVoice: professional
                  citations:
                    - url: https://docs.example.com/pricing
                      domain: docs.example.com
                      rank: 1
                      title: Pricing overview
                      sourceType: CORPORATE
                      contentType: PRODUCT_PAGE
                    - url: https://blog.example.com/compare
                      domain: blog.example.com
                      rank: 2
                      title: Tool comparison (illustrative)
                      sourceType: BLOG
                      contentType: COMPARISON
                  createdAt: '2026-03-29T14:22:00.000Z'
                properties:
                  id:
                    type: string
                    format: uuid
                    description: LLM response identifier
                  content:
                    type: string
                    description: The LLM response content
                  model:
                    type: string
                    description: Model used for this response
                  provider:
                    type: string
                    description: LLM provider
                  visibilityScore:
                    type: number
                    nullable: true
                    description: Visibility score for this response
                  sentimentScore:
                    type: number
                    nullable: true
                    description: Sentiment score for this response
                  sentiment:
                    type: string
                    enum:
                      - POSITIVE
                      - NEGATIVE
                      - NEUTRAL
                    nullable: true
                    description: Sentiment classification
                  toneOfVoice:
                    type: string
                    nullable: true
                    description: Detected tone of voice
                  mentionedOurBrand:
                    type: boolean
                    description: Whether the project's brand was mentioned
                  competitorMentions:
                    type: array
                    items:
                      type: string
                    description: List of competitor brands mentioned
                  citationCount:
                    type: number
                    description: Total number of citations in response
                  brandMentions:
                    type: array
                    items:
                      type: object
                      properties:
                        brandName:
                          type: string
                          description: Canonical brand name
                        brandDomain:
                          type: string
                          nullable: true
                          description: Primary brand domain
                        relation:
                          type: string
                          enum:
                            - SELF
                            - DIRECT_COMPETITOR
                            - OTHER
                            - IGNORED
                          description: Brand relation to the project
                        visibilityScore:
                          type: number
                          description: Visibility score for this brand mention (0-100)
                        position:
                          type: number
                          nullable: true
                          description: Position in the response (1st, 2nd, etc.)
                        sentiment:
                          type: string
                          enum:
                            - POSITIVE
                            - NEGATIVE
                            - NEUTRAL
                          nullable: true
                          description: Sentiment toward this brand in the response
                        toneOfVoice:
                          type: string
                          nullable: true
                          description: Detected tone of voice for this brand
                      required:
                        - brandName
                        - relation
                        - visibilityScore
                      additionalProperties: false
                    description: Brands detected in this response with per-brand metrics
                  prompt:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Prompt this response belongs to
                      prompt:
                        type: string
                        description: Prompt text
                      type:
                        type: string
                        enum:
                          - ORGANIC
                          - BRAND_SPECIFIC
                          - COMPETITOR_COMPARISON
                        description: Prompt classification
                      intent:
                        type: string
                        enum:
                          - BRANDED
                          - INFORMATIONAL
                          - NAVIGATIONAL
                          - COMMERCIAL
                          - TRANSACTIONAL
                        nullable: true
                        description: Search intent label when set
                      llmMonitor:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            description: Monitor identifier
                          name:
                            type: string
                            description: Monitor display name
                        required:
                          - id
                          - name
                        description: Monitor that owns the prompt
                    required:
                      - id
                      - prompt
                      - type
                      - llmMonitor
                    additionalProperties: false
                  citations:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                          description: Citation URL
                        domain:
                          type: string
                          description: Citation domain
                        rank:
                          type: number
                          nullable: true
                          description: Page rank of the cited URL (single response only)
                        title:
                          type: string
                          nullable: true
                          description: Citation title
                        sourceType:
                          type: string
                          enum:
                            - NEWS
                            - BLOG
                            - CORPORATE
                            - ACADEMIC
                            - GOVERNMENT
                            - WIKI
                            - INSTAGRAM
                            - TIKTOK
                            - X
                            - REDDIT
                            - YOUTUBE
                            - FACEBOOK
                            - LINKEDIN
                            - GITHUB
                            - STACKOVERFLOW
                            - MEDIUM
                            - SUBSTACK
                            - HACKERNEWS
                            - QUORA
                            - OTHER
                          nullable: true
                          description: Source type classification of the cited URL
                        contentType:
                          type: string
                          enum:
                            - NEWS_ARTICLE
                            - OPINION
                            - LISTICLE
                            - HOW_TO
                            - REVIEW
                            - COMPARISON
                            - CASE_STUDY
                            - INTERVIEW
                            - VIDEO
                            - PODCAST
                            - INFOGRAPHIC
                            - RESEARCH_PAPER
                            - REPORT
                            - DOCUMENTATION
                            - WIKI
                            - PRODUCT_PAGE
                            - LANDING_PAGE
                            - FORUM_POST
                            - SOCIAL_POST
                            - COMMENT
                            - QA
                            - PRESS_RELEASE
                            - FAQ
                            - GLOSSARY
                            - OTHER
                          nullable: true
                          description: Content type classification of the cited URL
                      required:
                        - url
                        - domain
                      additionalProperties: false
                    description: Full list of citations in the response
                  createdAt:
                    type: string
                    format: date-time
                    description: Response creation timestamp
                required:
                  - id
                  - content
                  - model
                  - provider
                  - mentionedOurBrand
                  - competitorMentions
                  - citationCount
                  - brandMentions
                  - prompt
                  - citations
                  - createdAt
                additionalProperties: false
        '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: RESPONSE_NOT_FOUND
                  message: Response not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - RESPONSE_NOT_FOUND
                      - PROMPT_NOT_FOUND
                      - INTERNAL_ERROR
                    example: RESPONSE_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Response not found
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: RESPONSE_NOT_FOUND
                    message: Response not found
                example2:
                  value:
                    code: PROMPT_NOT_FOUND
                    message: Prompt not found or access denied
                example3:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: RESPONSE_NOT_FOUND
                  message: Response not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - RESPONSE_NOT_FOUND
                      - PROMPT_NOT_FOUND
                      - INTERNAL_ERROR
                    example: RESPONSE_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Response not found
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: RESPONSE_NOT_FOUND
                    message: Response not found
                example2:
                  value:
                    code: PROMPT_NOT_FOUND
                    message: Prompt not found or access denied
                example3:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
      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.

````