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

# Citation Analytics

> Get citation analytics including top cited domains, URLs, and authority metrics



## OpenAPI

````yaml /v1/openapi.json get /citations
openapi: 3.0.0
info:
  title: Promptwatch API
  description: API for customer integrations with Promptwatch monitoring platform
  version: 1.0.1
  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/v1
    description: Promptwatch API
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and data
  - name: Visibility
    description: Visibility data and insights
  - name: Citations
    description: Citation analytics and source tracking
  - name: Prompts
    description: Prompt management and operations
  - name: Analytics
    description: Analytics data and insights
  - name: Share of Voice
    description: Share of voice analytics showing brand mentions vs total responses
  - name: Responses
    description: Response analytics including mentions, competitors, and sentiment
paths:
  /citations:
    get:
      tags:
        - Citations
      summary: Citation Analytics
      description: >-
        Get citation analytics including top cited domains, URLs, and authority
        metrics
      operationId: getCitationAnalyticsV1
      parameters:
        - schema:
            type: string
            format: date
          in: query
          name: startDate
          required: false
          description: Start date for citation data (YYYY-MM-DD)
        - schema:
            type: string
            format: date
          in: query
          name: endDate
          required: false
          description: End date for citation data (YYYY-MM-DD)
        - schema:
            type: string
          in: query
          name: model
          required: false
          description: Filter by specific LLM model
        - schema:
            type: string
          in: query
          name: promptId
          required: false
          description: Filter by specific prompt ID
        - schema:
            type: string
          in: query
          name: llmMonitorId
          required: false
          description: Filter by specific LLM monitor ID
        - schema:
            type: array
            items:
              type: string
              enum:
                - ORGANIC
                - BRAND_SPECIFIC
                - COMPETITOR_COMPARISON
          in: query
          name: promptTypes
          required: false
          description: Filter by prompt type
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          in: query
          name: limit
          required: false
          description: Maximum number of results to return
        - schema:
            type: array
            items:
              type: string
          in: query
          name: domains
          required: false
          description: Filter by specific domains
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  domains:
                    type: array
                    items:
                      type: object
                      properties:
                        domainName:
                          type: string
                          description: Domain name that was cited
                        count:
                          type: number
                          description: Number of times this domain was cited
                      required:
                        - domainName
                        - count
                      additionalProperties: false
                    description: Top cited domains with their citation counts
                  urls:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                          description: URL that was cited
                        count:
                          type: number
                          description: Number of times this URL was cited
                      required:
                        - url
                        - count
                      additionalProperties: false
                    description: Top cited URLs with their citation counts
                  totalEstimatedTraffic:
                    type: number
                    description: Total estimated traffic from all cited URLs
                  averageAuthorityScore:
                    type: number
                    nullable: true
                    description: Average domain authority score of cited domains
                  averagePageRank:
                    type: number
                    nullable: true
                    description: Average page rank of cited URLs
                  summary:
                    type: object
                    properties:
                      totalCitedDomains:
                        type: number
                        description: Total number of unique domains cited
                      totalCitedUrls:
                        type: number
                        description: Total number of unique URLs cited
                      totalCitations:
                        type: number
                        description: Total number of citations
                    required:
                      - totalCitedDomains
                      - totalCitedUrls
                      - totalCitations
                    additionalProperties: false
                required:
                  - domains
                  - urls
                  - totalEstimatedTraffic
                  - summary
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error type
                  message:
                    type: string
                    description: Error message
                  details:
                    type: object
                    description: Additional error details
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error type
                  message:
                    type: string
                    description: Error message
                  details:
                    type: object
                    description: Additional error details
                    additionalProperties: true
                required:
                  - error
                  - 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.

````