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

# Grouped Citations

> Get a paginated, sortable table of cited URLs with per-URL citation count, average/best/worst position, domain rank (DR), authority, and the models citing each page. Mirrors the citations dashboard table.



## OpenAPI

````yaml /v2/openapi.json get /citations/grouped
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/grouped:
    get:
      tags:
        - Citations
      summary: Grouped Citations
      description: >-
        Get a paginated, sortable table of cited URLs with per-URL citation
        count, average/best/worst position, domain rank (DR), authority, and the
        models citing each page. Mirrors the citations dashboard table.
      operationId: getGroupedCitations
      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: 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
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          in: query
          name: domains
          required: false
          description: 'Filter by domains. Repeat for multiple: domains=x&domains=y'
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          in: query
          name: tagIds
          required: false
          description: Filter by prompt tag IDs. Repeat for multiple
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          in: query
          name: topicIds
          required: false
          description: Filter by topic IDs. Repeat for multiple
        - schema:
            anyOf:
              - 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
              - type: array
                items:
                  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
          in: query
          name: contentTypes
          required: false
          description: Filter by URL content type. Repeat for multiple
        - schema:
            anyOf:
              - type: string
                enum:
                  - NEWS
                  - BLOG
                  - CORPORATE
                  - ACADEMIC
                  - GOVERNMENT
                  - WIKI
                  - INSTAGRAM
                  - TIKTOK
                  - X
                  - REDDIT
                  - YOUTUBE
                  - FACEBOOK
                  - LINKEDIN
                  - GITHUB
                  - STACKOVERFLOW
                  - MEDIUM
                  - SUBSTACK
                  - HACKERNEWS
                  - QUORA
                  - OTHER
              - type: array
                items:
                  type: string
                  enum:
                    - NEWS
                    - BLOG
                    - CORPORATE
                    - ACADEMIC
                    - GOVERNMENT
                    - WIKI
                    - INSTAGRAM
                    - TIKTOK
                    - X
                    - REDDIT
                    - YOUTUBE
                    - FACEBOOK
                    - LINKEDIN
                    - GITHUB
                    - STACKOVERFLOW
                    - MEDIUM
                    - SUBSTACK
                    - HACKERNEWS
                    - QUORA
                    - OTHER
          in: query
          name: sourceTypes
          required: false
          description: Filter by URL source type. Repeat for multiple
        - schema:
            type: string
          in: query
          name: urlSearch
          required: false
          description: Search within cited URL / title / domain
        - schema:
            type: boolean
          in: query
          name: hideIgnoredBrands
          required: false
          description: Exclude domains belonging to ignored brands
        - schema:
            type: integer
            default: 1
            minimum: 1
          in: query
          name: page
          required: false
          description: Page number (1-indexed)
        - schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
          in: query
          name: size
          required: false
          description: Number of results per page
        - schema:
            type: string
            enum:
              - count
              - avgPosition
              - minPosition
              - maxPosition
              - domainRank
              - domainAuthorityScore
              - estimatedTraffic
              - pageRank
              - domainName
              - url
            default: count
          in: query
          name: sortBy
          required: false
          description: Field to sort by
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          in: query
          name: sortOrder
          required: false
          description: Sort order
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - url:
                        id: 3f1c2e5a-9b7d-4c6e-8a1f-2b3c4d5e6f70
                        url: https://docs.example.com/guide
                        title: The Complete Guide
                        description: null
                        sourceType: BLOG
                        contentType: HOW_TO
                        pageRank: 4.1
                        estimatedTraffic: 52000
                        totalBacklinks: 1240
                        domain:
                          domainName: docs.example.com
                          domainRank: 68
                          authorityScore: 54
                          estimatedTraffic: 210000
                      count: 42
                      avgPosition: 2.3
                      minPosition: 1
                      maxPosition: 6
                      models:
                        - gpt-4.1
                        - claude-sonnet-4
                        - gemini-2.5-pro
                      totalModels: 4
                      providers:
                        - openai
                        - anthropic
                        - google
                  pagination:
                    total: 210
                    page: 1
                    size: 25
                    totalPages: 9
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Internal URL identifier
                            url:
                              type: string
                              description: The cited URL
                            title:
                              type: string
                              nullable: true
                              description: Page title
                            description:
                              type: string
                              nullable: true
                              description: Page description
                            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
                            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
                            pageRank:
                              type: number
                              nullable: true
                              description: Page rank (PR) of the URL
                            estimatedTraffic:
                              type: number
                              nullable: true
                              description: Estimated monthly traffic for the page
                            totalBacklinks:
                              type: number
                              nullable: true
                              description: Total backlinks to the page
                            domain:
                              type: object
                              properties:
                                domainName:
                                  type: string
                                  description: Domain name
                                domainRank:
                                  type: number
                                  nullable: true
                                  description: Domain rank (DR)
                                authorityScore:
                                  type: number
                                  nullable: true
                                  description: Domain authority score
                                estimatedTraffic:
                                  type: number
                                  nullable: true
                                  description: Estimated monthly traffic for the domain
                              required:
                                - domainName
                              additionalProperties: false
                          required:
                            - id
                            - url
                            - domain
                          additionalProperties: false
                        count:
                          type: number
                          description: Number of times this URL was cited
                        avgPosition:
                          type: number
                          nullable: true
                          description: Average citation position (1-indexed)
                        minPosition:
                          type: number
                          nullable: true
                          description: Best (lowest) citation position (1-indexed)
                        maxPosition:
                          type: number
                          nullable: true
                          description: Worst (highest) citation position (1-indexed)
                        models:
                          type: array
                          items:
                            type: string
                          description: Top models (by citation count) that cited this URL
                        totalModels:
                          type: number
                          description: Total distinct models that cited this URL
                        providers:
                          type: array
                          items:
                            type: string
                          description: Distinct providers that cited this URL
                      required:
                        - url
                        - count
                        - models
                        - totalModels
                        - providers
                      additionalProperties: false
                    description: Per-URL grouped citation rows
                  pagination:
                    type: object
                    properties:
                      total:
                        type: number
                        description: Total number of unique URLs matching the filters
                      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:
                  - data
                  - 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.

````