> ## 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 Rank Analysis

> Get citation rank analysis for your domain over time



## OpenAPI

````yaml /v1/openapi.json get /citations/rank-analysis
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/rank-analysis:
    get:
      tags:
        - Citations
      summary: Citation Rank Analysis
      description: Get citation rank analysis for your domain over time
      operationId: getCitationRankAnalysisV1
      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: string
            enum:
              - DAILY
              - WEEKLY
              - MONTHLY
            default: DAILY
          in: query
          name: range
          required: false
          description: Time range grouping
        - schema:
            type: string
            enum:
              - daily
              - weekly
              - monthly
            default: daily
          in: query
          name: granularity
          required: false
          description: Time granularity for grouping data
        - schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 10
          in: query
          name: domainLimit
          required: false
          description: Maximum number of domains to include (for domain over time endpoint)
        - schema:
            type: array
            items:
              type: string
          in: query
          name: domains
          required: false
          description: Filter by specific domains
        - schema:
            type: boolean
            default: false
          in: query
          name: includeSelf
          required: false
          description: >-
            If true, always include the project's own brand domain (even with 0
            citations)
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  timeSeries:
                    type: array
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          format: date-time
                          description: Date for this data point
                        totalCitations:
                          type: number
                          nullable: true
                          description: Total citations for this period
                        averageRank:
                          type: number
                          nullable: true
                          description: Average citation rank/position
                        bestRank:
                          type: number
                          nullable: true
                          description: Best (lowest) rank achieved
                        worstRank:
                          type: number
                          nullable: true
                          description: Worst (highest) rank
                        citationsWithRank:
                          type: number
                          nullable: true
                          description: Citations with position data
                      required:
                        - date
                      additionalProperties: false
                  overallAverageRank:
                    type: number
                    nullable: true
                    description: Overall average rank for the entire period
                required:
                  - timeSeries
                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.

````