> ## Documentation Index
> Fetch the complete documentation index at: https://docs.otterly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get citation statistics for a brand report



## OpenAPI

````yaml https://data.otterly.ai/v1/openapi.json get /v1/reports/brand/{reportId}/citations/stats
openapi: 3.0.0
info:
  title: Otterly Public API
  version: 1.0.0
servers:
  - url: https://data.otterly.ai
security: []
tags:
  - name: Engines
  - name: Workspaces
  - name: Brand Reports
  - name: Audits
  - name: Accounts
paths:
  /v1/reports/brand/{reportId}/citations/stats:
    get:
      tags:
        - Brand Reports
      summary: Get citation statistics for a brand report
      parameters:
        - schema:
            type: string
            minLength: 1
            example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
            description: Brand report identifier.
          required: true
          description: Brand report identifier.
          name: reportId
          in: path
        - schema:
            type: string
            minLength: 1
            description: Start date for the stats window (inclusive).
            example: '2025-01-01'
          required: true
          description: Start date for the stats window (inclusive).
          name: startDate
          in: query
        - schema:
            type: string
            minLength: 1
            description: End date for the stats window (inclusive).
            example: '2025-01-31'
          required: true
          description: End date for the stats window (inclusive).
          name: endDate
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk`
              for the United Kingdom.
            example: us
          required: true
          description: >-
            Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk`
            for the United Kingdom.
          name: country
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - chatgpt
                  - google
                  - perplexity
                  - copilot
                  - google_ai_mode
                  - gemini
                  - claude
                description: AI engine identifier.
                example: chatgpt
              - type: array
                items:
                  type: string
                  enum:
                    - chatgpt
                    - google
                    - perplexity
                    - copilot
                    - google_ai_mode
                    - gemini
                    - claude
                  description: AI engine identifier.
                  example: chatgpt
            description: >-
              Optional. AI engine(s) to filter by. Repeat the param or pass a
              single value.
          required: false
          description: >-
            Optional. AI engine(s) to filter by. Repeat the param or pass a
            single value.
          name: engines
          in: query
        - schema:
            type: string
            description: Optional. Filter stats by tag id.
          required: false
          description: Optional. Filter stats by tag id.
          name: tagId
          in: query
        - schema:
            type: integer
            description: >-
              Optional. Cap on number of distinct domains aggregated into the
              response. Positive integer.
            example: 10
          required: false
          description: >-
            Optional. Cap on number of distinct domains aggregated into the
            response. Positive integer.
          name: domainLimit
          in: query
      responses:
        '200':
          description: Citation statistics for the brand report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiBrandReportCitationStatsResponse'
        '400':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiValidationErrorResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        '404':
          description: Report not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    PublicApiBrandReportCitationStatsResponse:
      type: object
      properties:
        domainRank:
          type: object
          properties:
            citations:
              type: array
              items:
                type: object
                properties:
                  domain:
                    type: string
                  rank:
                    type: number
                  citations:
                    type: number
                  logoUrl:
                    type: string
                  citationShare:
                    type: number
                  main:
                    type: boolean
                required:
                  - domain
                  - rank
                  - citations
                  - logoUrl
                  - citationShare
                  - main
          required:
            - citations
        domainCitations:
          type: object
          properties:
            current:
              type: number
            total:
              type: number
            citationShare:
              type: number
            mostCitedUrls:
              type: array
              items:
                type: object
                properties:
                  url:
                    type: string
                  rank:
                    type: number
                  currentCitations:
                    type: number
                  citationShare:
                    type: number
                required:
                  - url
                  - rank
                  - currentCitations
                  - citationShare
          required:
            - current
            - total
            - citationShare
            - mostCitedUrls
        citations:
          type: array
          items:
            type: object
            properties:
              url:
                type: string
              rank:
                type: number
              currentCitations:
                type: number
              logoUrl:
                type: string
              citationShare:
                type: number
            required:
              - url
              - rank
              - currentCitations
              - logoUrl
              - citationShare
        competitors:
          type: array
          items:
            type: object
            properties:
              brandDomain:
                type: string
              domainCitations:
                type: object
                properties:
                  current:
                    type: number
                  total:
                    type: number
                  citationShare:
                    type: number
                required:
                  - current
                  - total
                  - citationShare
            required:
              - brandDomain
              - domainCitations
      required:
        - domainRank
        - domainCitations
        - citations
        - competitors
      example:
        domainRank:
          citations:
            - domain: adidas.com
              rank: 1
              citations: 42
              logoUrl: https://logo.clearbit.com/adidas.com
              citationShare: 0.42
              main: true
        domainCitations:
          current: 42
          total: 100
          citationShare: 0.42
          mostCitedUrls:
            - url: https://www.adidas.com/us/running
              rank: 1
              currentCitations: 18
              citationShare: 0.42
        citations:
          - url: https://www.adidas.com/us/running
            rank: 1
            currentCitations: 18
            logoUrl: https://logo.clearbit.com/adidas.com
            citationShare: 0.42
        competitors:
          - brandDomain: nike.com
            domainCitations:
              current: 12
              total: 100
              citationShare: 0.12
    PublicApiValidationErrorResponse:
      type: object
      properties:
        message:
          type: string
        target:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
              - code
      required:
        - message
        - target
        - errors
      example:
        message: Validation failed
        target: query
        errors:
          - path: country
            message: Required
            code: invalid_type
    PublicApiErrorResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      example:
        message: Report not found
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Provide your API key as a Bearer token: `Authorization: Bearer
        YOUR_API_KEY`.

````