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

> Aggregate payload for prompt drill-down: visibility + 7d delta, best
rank with platform, coverage X/N, 30-day sparkline, per-platform coverage
grid, and the latest N answers in a single round trip.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/prompts/{prompt_id}/detail
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}/detail:
    get:
      tags:
        - Prompts
      summary: Get Prompt Detail
      description: >-
        Aggregate payload for prompt drill-down: visibility + 7d delta, best

        rank with platform, coverage X/N, 30-day sparkline, per-platform
        coverage

        grid, and the latest N answers in a single round trip.
      operationId: get_prompt_detail_api_v1_public_prompts__prompt_id__detail_get
      parameters:
        - name: prompt_id
          in: path
          required: true
          schema:
            type: integer
            title: Prompt Id
        - name: answers_limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 20
            minimum: 1
            default: 5
            title: Answers Limit
        - 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/PromptDetailSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PromptDetailSchema:
      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
        intent:
          anyOf:
            - $ref: '#/components/schemas/PromptIntent'
            - type: 'null'
        journey_stage:
          anyOf:
            - $ref: '#/components/schemas/PromptJourneyStage'
            - type: 'null'
        localizations:
          items:
            type: string
          type: array
          title: Localizations
          default:
            - worldwide
        status:
          $ref: '#/components/schemas/PromptStatus'
        visibility_score:
          type: number
          title: Visibility Score
        visibility_delta_7d:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Delta 7D
        best_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Best Rank
        best_rank_platform:
          anyOf:
            - $ref: '#/components/schemas/AiPlatform'
            - type: 'null'
        coverage_cited:
          type: integer
          title: Coverage Cited
        coverage_total:
          type: integer
          title: Coverage Total
        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_trend:
          items:
            $ref: '#/components/schemas/PromptVolumeTrendPointSchema'
          type: array
          title: Volume Trend
          default: []
        visibility_30d:
          items:
            $ref: '#/components/schemas/PromptVisibilityPointSchema'
          type: array
          title: Visibility 30D
          default: []
        per_platform:
          items:
            $ref: '#/components/schemas/PromptPlatformDetailSchema'
          type: array
          title: Per Platform
          default: []
        latest_answers:
          items:
            $ref: '#/components/schemas/PromptLatestAnswerSchema'
          type: array
          title: Latest Answers
          default: []
      type: object
      required:
        - id
        - content
        - status
        - visibility_score
        - coverage_cited
        - coverage_total
      title: PromptDetailSchema
      description: |-
        Full prompt detail payload powering the detail panel.

        Aggregates: current visibility + 7d delta, best rank with platform,
        coverage X/N, 30-day sparkline, per-platform grid and N latest answers.
    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)
    AiPlatform:
      type: string
      enum:
        - ChatGPT
        - Gemini
        - AI Overviews
        - Google AI Mode
        - Perplexity
        - Mistral
        - Claude
        - DeepSeek
        - Grok
        - Copilot
      title: AiPlatform
    PromptVolumeTrendPointSchema:
      properties:
        year:
          type: integer
          title: Year
        month:
          type: integer
          title: Month
        ai_search_volume:
          anyOf:
            - type: integer
            - type: 'null'
          title: Ai Search Volume
      type: object
      required:
        - year
        - month
      title: PromptVolumeTrendPointSchema
      description: One month of the aggregated Prompt Volume trend (DataForSEO 12-month).
    PromptVisibilityPointSchema:
      properties:
        date:
          type: string
          format: date
          title: Date
        visibility_score:
          type: number
          title: Visibility Score
      type: object
      required:
        - date
        - visibility_score
      title: PromptVisibilityPointSchema
      description: One day on the prompt visibility sparkline.
    PromptPlatformDetailSchema:
      properties:
        platform:
          $ref: '#/components/schemas/AiPlatform'
        coverage:
          $ref: '#/components/schemas/PromptPlatformCoverage'
        cited_count:
          type: integer
          title: Cited Count
        total_count:
          type: integer
          title: Total Count
        best_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Best Rank
      type: object
      required:
        - platform
        - coverage
        - cited_count
        - total_count
      title: PromptPlatformDetailSchema
      description: Per-platform breakdown for the prompt detail panel.
    PromptLatestAnswerSchema:
      properties:
        id:
          type: integer
          title: Id
        platform:
          $ref: '#/components/schemas/AiPlatform'
        content:
          type: string
          title: Content
        website_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Website Rank
        created_at:
          type: string
          format: date-time
          title: Created At
        brand_mentions:
          items:
            $ref: '#/components/schemas/CitationBrandMentionSchema'
          type: array
          title: Brand Mentions
          default: []
      type: object
      required:
        - id
        - platform
        - content
        - created_at
      title: PromptLatestAnswerSchema
      description: One recent citation surfaced on the detail panel.
    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
    PromptPlatformCoverage:
      type: string
      enum:
        - cited
        - partial
        - not_cited
        - no_data
      title: PromptPlatformCoverage
      description: |-
        Per-platform coverage status for a prompt's detail panel.

        Derived at query time from the website_cited rate on the citations of
        a (prompt, platform) pair.

        - CITED: every citation on this platform mentions the website
        - PARTIAL: some citations mention the website, some don't
        - NOT_CITED: no citation on this platform mentions the website
        - NO_DATA: no citation collected for this platform yet
    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).

````