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

# Get Citations Breakdown

> Per-match_type counts (brand_citation / site_mention / background_source)
over the requested period, with delta vs previous period and a daily
sparkline. Powers trend cards.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/citations/breakdown
openapi: 3.1.0
info:
  title: Hikoo REST API
  description: >-
    Programmatic access to your Hikoo data: citations, prompts, competitors,
    audits, health and more. Authenticate with a personal API key
    (`Authorization: Bearer <key>`) created from the dashboard settings.
  version: 1.0.0
servers:
  - url: https://api.tryhikoo.com
security:
  - apiKey: []
paths:
  /api/v1/public/citations/breakdown:
    get:
      tags:
        - Citations
      summary: Get Citations Breakdown
      description: >-
        Per-match_type counts (brand_citation / site_mention /
        background_source)

        over the requested period, with delta vs previous period and a daily

        sparkline. Powers trend cards.
      operationId: get_citations_breakdown_api_v1_public_citations_breakdown_get
      parameters:
        - name: time_range
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/TimeRange'
              - type: 'null'
            title: Time Range
        - name: platforms[]
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  $ref: '#/components/schemas/AiPlatform'
              - type: 'null'
            title: Platforms[]
        - name: localizations[]
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            title: Localizations[]
        - name: topic_ids[]
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  type: integer
              - type: 'null'
            title: Topic Ids[]
        - name: tz
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: IANA timezone for daily bucketing (defaults to UTC)
            title: Tz
          description: IANA timezone for daily bucketing (defaults to UTC)
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Bearer <api_key>
            title: Authorization
          description: Bearer <api_key>
        - name: X-MCP-Secret
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Mcp-Secret
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CitationsBreakdownResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TimeRange:
      type: string
      enum:
        - all_time
        - 1y
        - 1m
        - 1w
        - 1d
      title: TimeRange
    AiPlatform:
      type: string
      enum:
        - ChatGPT
        - Gemini
        - AI Overviews
        - Google AI Mode
        - Perplexity
        - Mistral
        - Claude
        - DeepSeek
        - Grok
        - Copilot
      title: AiPlatform
    CitationsBreakdownResponse:
      properties:
        breakdown:
          items:
            $ref: '#/components/schemas/CitationMatchTypeBreakdown'
          type: array
          title: Breakdown
      type: object
      required:
        - breakdown
      title: CitationsBreakdownResponse
      description: Per-match_type counts + sparkline for the dashboard trend cards.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CitationMatchTypeBreakdown:
      properties:
        match_type:
          $ref: '#/components/schemas/CitationMatchType'
        count:
          type: integer
          title: Count
          default: 0
        previous_count:
          type: integer
          title: Previous Count
          default: 0
        delta:
          type: integer
          title: Delta
          default: 0
        delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Delta Pct
        denominator:
          type: integer
          title: Denominator
          default: 0
        percentage:
          anyOf:
            - type: number
            - type: 'null'
          title: Percentage
        series:
          items:
            $ref: '#/components/schemas/CitationBreakdownSeriesPoint'
          type: array
          title: Series
      type: object
      required:
        - match_type
      title: CitationMatchTypeBreakdown
      description: >-
        Counts for one match_type over a period, with a delta vs. the previous
        period.


        ``denominator`` is the type-specific "scope total" against which
        ``count``

        is meaningful as a share:
          - brand_citation: total responses for the website in filter scope
          - site_mention:   total responses for the website that include at least
                            one mentioned URL (in filter scope)
          - background_source: URL-level — total background-source URL occurrences
                            across the website's citations in filter scope.
                            ``count`` for background is also URL-level (occurrences
                            whose root domain matches the website's domain).

        ``percentage`` = count / denominator * 100, or None when denominator ==
        0.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    CitationMatchType:
      type: string
      enum:
        - brand_citation
        - site_mention
        - background_source
      title: CitationMatchType
      description: |-
        How a website (or competitor) was matched in an AI response.

        Non-exclusive — a single citation can carry multiple types
        (e.g. brand name in content AND URL in sources).
    CitationBreakdownSeriesPoint:
      properties:
        date:
          type: string
          title: Date
        count:
          type: integer
          title: Count
        denominator:
          type: integer
          title: Denominator
          default: 0
      type: object
      required:
        - date
        - count
      title: CitationBreakdownSeriesPoint
      description: One data point in a match_type sparkline.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard (Settings > API keys).

````