> ## 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 Prompt Citations

> Paginated citations tied to a specific prompt.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/prompts/{prompt_id}/citations
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/prompts/{prompt_id}/citations:
    get:
      tags:
        - Prompts
      summary: Get Prompt Citations
      description: Paginated citations tied to a specific prompt.
      operationId: get_prompt_citations_api_v1_public_prompts__prompt_id__citations_get
      parameters:
        - name: prompt_id
          in: path
          required: true
          schema:
            type: integer
            title: Prompt Id
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Page Size
        - 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/PromptWithCitationsSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PromptWithCitationsSchema:
      properties:
        id:
          type: integer
          title: Id
        content:
          type: string
          title: Content
        topic_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Topic Id
        topic_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Topic Name
        localizations:
          items:
            type: string
          type: array
          title: Localizations
          default:
            - worldwide
        intent:
          anyOf:
            - $ref: '#/components/schemas/PromptIntent'
            - type: 'null'
        journey_stage:
          anyOf:
            - $ref: '#/components/schemas/PromptJourneyStage'
            - type: 'null'
        source_keyword:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Keyword
        visibility_score:
          type: number
          title: Visibility Score
          default: 0
        visibility_delta_7d:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Delta 7D
        status:
          $ref: '#/components/schemas/PromptStatus'
          default: unclaimed
        top_platforms:
          items:
            $ref: '#/components/schemas/PromptPlatformBreakdownSchema'
          type: array
          title: Top Platforms
          default: []
        sentiment_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Sentiment Score
        sentiment_highlights_count:
          type: integer
          title: Sentiment Highlights Count
          default: 0
        sentiment_positive_count:
          type: integer
          title: Sentiment Positive Count
          default: 0
        sentiment_negative_count:
          type: integer
          title: Sentiment Negative Count
          default: 0
        sentiment_neutral_count:
          type: integer
          title: Sentiment Neutral Count
          default: 0
        ai_search_volume:
          anyOf:
            - type: integer
            - type: 'null'
          title: Ai Search Volume
        ai_volume_delta:
          anyOf:
            - type: number
            - type: 'null'
          title: Ai Volume Delta
        volume_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Volume Updated At
        is_active:
          type: boolean
          title: Is Active
          default: true
        archived_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Archived At
        created_at:
          type: string
          format: date-time
          title: Created At
        citations:
          anyOf:
            - items:
                $ref: '#/components/schemas/CitationBase'
              type: array
            - type: 'null'
          title: Citations
        total:
          type: integer
          title: Total
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - id
        - content
        - created_at
        - total
        - page
        - page_size
        - total_pages
      title: PromptWithCitationsSchema
      description: Prompt schema with citations
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PromptIntent:
      type: string
      enum:
        - informational
        - comparative
        - transactional
        - navigational
      title: PromptIntent
    PromptJourneyStage:
      type: string
      enum:
        - discovery
        - consideration
        - decision
        - retention
      title: PromptJourneyStage
    PromptStatus:
      type: string
      enum:
        - winning
        - at_risk
        - losing
        - unclaimed
      title: PromptStatus
      description: |-
        Derived health status for a prompt.

        Computed at query time from the current visibility score and the 7-day
        delta. Not persisted: changing thresholds is a no-op migration.

        Thresholds (validated with product):
        - WINNING:   score >= 70 AND delta_7d >= 0
        - AT_RISK:   30 <= score < 70 OR delta_7d <= -10
        - LOSING:    score < 30 AND delta_7d < 0
        - UNCLAIMED: score == 0 (no platform cites the website)
    PromptPlatformBreakdownSchema:
      properties:
        platform:
          $ref: '#/components/schemas/AiPlatform'
        cited_count:
          type: integer
          title: Cited Count
        total_count:
          type: integer
          title: Total Count
      type: object
      required:
        - platform
        - cited_count
        - total_count
      title: PromptPlatformBreakdownSchema
      description: |-
        Per-prompt × platform aggregate.

        ``cited_count`` is the number of citations where the tracked website
        appears, out of ``total_count`` total citations on that platform for the
        prompt. The frontend derives a tri-state (cited / partial / not_cited)
        from the ratio.
    CitationBase:
      properties:
        id:
          type: integer
          title: Id
        content:
          type: string
          title: Content
        platform:
          $ref: '#/components/schemas/AiPlatform'
        sources:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Sources
        mentioned_sources:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Mentioned Sources
        website_cited:
          type: boolean
          title: Website Cited
        match_types:
          items:
            $ref: '#/components/schemas/CitationMatchType'
          type: array
          title: Match Types
        localization:
          anyOf:
            - type: string
            - type: 'null'
          title: Localization
        competitors:
          anyOf:
            - items:
                $ref: '#/components/schemas/CompetitorWithoutLogo'
              type: array
            - type: 'null'
          title: Competitors
        created_at:
          type: string
          format: date-time
          title: Created At
        website_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Website Rank
        website_rank_total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Website Rank Total
        brand_mentions:
          items:
            $ref: '#/components/schemas/CitationBrandMentionSchema'
          type: array
          title: Brand Mentions
      type: object
      required:
        - id
        - content
        - platform
        - website_cited
        - created_at
      title: CitationBase
      description: Base citation schema
    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
    AiPlatform:
      type: string
      enum:
        - ChatGPT
        - Gemini
        - AI Overviews
        - Google AI Mode
        - Perplexity
        - Mistral
        - Claude
        - DeepSeek
        - Grok
        - Copilot
      title: AiPlatform
    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).
    CompetitorWithoutLogo:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        url:
          type: string
          title: Url
        aliases:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Aliases
      type: object
      required:
        - id
        - name
        - url
      title: CompetitorWithoutLogo
      description: Competitor schema without logo
    CitationBrandMentionSchema:
      properties:
        id:
          type: integer
          title: Id
        display_name:
          type: string
          title: Display Name
        brand_name_normalized:
          type: string
          title: Brand Name Normalized
        is_tracked_website:
          type: boolean
          title: Is Tracked Website
        resolved_competitor_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Resolved Competitor Id
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
        rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Rank
        highlights:
          items:
            $ref: '#/components/schemas/CitationHighlightSchema'
          type: array
          title: Highlights
      type: object
      required:
        - id
        - display_name
        - brand_name_normalized
        - is_tracked_website
      title: CitationBrandMentionSchema
      description: One brand mentioned inside a citation, with sentiment highlights.
    CitationHighlightSchema:
      properties:
        text:
          type: string
          title: Text
        type:
          $ref: '#/components/schemas/HighlightType'
        start:
          type: integer
          title: Start
        end:
          type: integer
          title: End
      type: object
      required:
        - text
        - type
        - start
        - end
      title: CitationHighlightSchema
      description: One sentiment highlight inside a citation, with verified offsets.
    HighlightType:
      type: string
      enum:
        - positive
        - negative
        - neutral
      title: HighlightType
      description: |-
        Type of a single sentiment highlight inside a citation.

        Recorded as raw evidence on ``citation_brand_mention.highlights``. The
        aggregated score per (brand × period × platform) is computed at query
        time from these counts so changing the formula stays a no-op migration.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard (Settings > API keys).

````