Skip to main content
GET
/
api
/
v1
/
public
/
prompts
/
{prompt_id}
/
citations
Get Prompt Citations
curl --request GET \
  --url https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "content": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "topic_id": 123,
  "topic_name": "<string>",
  "localizations": [
    "worldwide"
  ],
  "source_keyword": "<string>",
  "visibility_score": 0,
  "visibility_delta_7d": 123,
  "status": "unclaimed",
  "top_platforms": [],
  "sentiment_score": 123,
  "sentiment_highlights_count": 0,
  "sentiment_positive_count": 0,
  "sentiment_negative_count": 0,
  "sentiment_neutral_count": 0,
  "ai_search_volume": 123,
  "ai_volume_delta": 123,
  "volume_updated_at": "2023-11-07T05:31:56Z",
  "is_active": true,
  "archived_at": "2023-11-07T05:31:56Z",
  "citations": [
    {
      "id": 123,
      "content": "<string>",
      "website_cited": true,
      "created_at": "2023-11-07T05:31:56Z",
      "sources": [
        "<string>"
      ],
      "mentioned_sources": [
        "<string>"
      ],
      "match_types": [],
      "localization": "<string>",
      "competitors": [
        {
          "id": 123,
          "name": "<string>",
          "url": "<string>",
          "aliases": [
            "<string>"
          ]
        }
      ],
      "website_rank": 123,
      "website_rank_total": 123,
      "brand_mentions": [
        {
          "id": 123,
          "display_name": "<string>",
          "brand_name_normalized": "<string>",
          "is_tracked_website": true,
          "resolved_competitor_id": 123,
          "summary": "<string>",
          "rank": 123,
          "highlights": [
            {
              "text": "<string>",
              "start": 123,
              "end": 123
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard (Settings > API keys).

Headers

authorization
string | null

Bearer <api_key>

X-MCP-Secret
string | null

Path Parameters

prompt_id
integer
required

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:20
Required range: 1 <= x <= 100
website_id
integer
required

Target website id

Response

Successful Response

Prompt schema with citations

id
integer
required
content
string
required
created_at
string<date-time>
required
total
integer
required
page
integer
required
page_size
integer
required
total_pages
integer
required
topic_id
integer | null
topic_name
string | null
localizations
string[]
intent
enum<string> | null
Available options:
informational,
comparative,
transactional,
navigational
journey_stage
enum<string> | null
Available options:
discovery,
consideration,
decision,
retention
source_keyword
string | null
visibility_score
number
default:0
visibility_delta_7d
number | null
status
enum<string>
default:unclaimed

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)
Available options:
winning,
at_risk,
losing,
unclaimed
top_platforms
PromptPlatformBreakdownSchema · object[]
sentiment_score
number | null
sentiment_highlights_count
integer
default:0
sentiment_positive_count
integer
default:0
sentiment_negative_count
integer
default:0
sentiment_neutral_count
integer
default:0
ai_search_volume
integer | null
ai_volume_delta
number | null
volume_updated_at
string<date-time> | null
is_active
boolean
default:true
archived_at
string<date-time> | null
citations
CitationBase · object[] | null