> ## 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 /v2/openapi.json get /citations 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: get: tags: - Citations summary: Citation Analytics description: >- Get citation analytics including top cited domains, URLs, and authority metrics operationId: getCitationAnalytics 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 description: Single model - type: array items: type: string in: query name: models required: false description: 'Filter by LLM models. Repeat for multiple: models=x&models=y' - 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: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC - schema: type: integer minimum: 1 maximum: 100 default: 20 in: query name: limit required: false description: Maximum number of domain results to return - schema: anyOf: - type: string description: Single domain - type: array items: type: string in: query name: domains required: false description: 'Filter by domains. Repeat for multiple: domains=x&domains=y' - schema: type: integer default: 1 minimum: 1 in: query name: page required: false description: Page number for URL results (1-indexed) - schema: type: integer minimum: 1 maximum: 250 default: 20 in: query name: size required: false description: Number of URL results per page responses: '200': description: Default Response content: application/json: schema: type: object example: domains: - domainName: docs.example.com count: 48 - domainName: blog.example.com count: 31 urls: - url: https://docs.example.com/guide count: 22 - url: https://blog.example.com/post-a count: 18 totalEstimatedTraffic: 125000 averageAuthorityScore: 42.5 averagePageRank: 3.2 summary: totalCitedDomains: 85 totalCitedUrls: 210 totalCitations: 1520 pagination: total: 210 page: 1 size: 20 totalPages: 11 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 pagination: type: object properties: total: type: number description: Total number of URL results page: type: number description: Current page number (1-indexed) size: type: number description: Number of results per page totalPages: type: number description: Total number of pages required: - total - page - size - totalPages additionalProperties: false required: - domains - urls - totalEstimatedTraffic - summary - pagination 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. ````