> ## 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 /v2/openapi.json get /citations/rank-analysis 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: /citations/rank-analysis: get: tags: - Citations summary: Citation Rank Analysis description: Get citation rank analysis for your domain over time operationId: getCitationRankAnalysis parameters: - schema: type: string format: date in: query name: startDate required: false description: Start date for citation data (YYYY-MM-DD). Max range 90 days. - schema: type: string format: date in: query name: endDate required: false description: End date for citation data (YYYY-MM-DD). Max range 90 days. - schema: anyOf: - type: string - type: array items: type: string in: query name: models required: false description: Filter by LLM models. Repeat for multiple - 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: anyOf: - type: string enum: - ORGANIC - BRAND_SPECIFIC - COMPETITOR_COMPARISON - type: array items: type: string enum: - ORGANIC - BRAND_SPECIFIC - COMPETITOR_COMPARISON in: query name: promptTypes required: false description: Filter by prompt type. Repeat for multiple - 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: anyOf: - type: string - type: array items: type: string in: query name: domains required: false description: Filter by domains. Repeat for multiple - 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 example: timeSeries: - date: '2026-03-14T00:00:00.000Z' totalCitations: 20 averageRank: 2.4 bestRank: 1 worstRank: 5 citationsWithRank: 18 - date: '2026-03-15T00:00:00.000Z' totalCitations: 22 averageRank: 2.1 bestRank: 1 worstRank: 6 citationsWithRank: 20 overallAverageRank: 2.25 lastRank: 2.1 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 lastRank: type: number nullable: true description: The last rank value from the time series required: - timeSeries 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 '500': description: Default Response content: application/json: schema: type: object example: code: PROJECT_NOT_FOUND message: Project not found properties: code: type: string description: Error code indicating the type of error enum: - PROJECT_NOT_FOUND - INTERNAL_ERROR example: PROJECT_NOT_FOUND message: type: string description: Human-readable error message example: Project not found required: - code - message additionalProperties: false examples: example1: value: code: PROJECT_NOT_FOUND message: Project not found example2: 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. ````