Get Prompt Citations
curl --request GET \
--url https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
],
"intent": "informational",
"journey_stage": "discovery",
"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>",
"platform": "ChatGPT",
"website_cited": true,
"created_at": "2023-11-07T05:31:56Z",
"sources": [
"<string>"
],
"mentioned_sources": [
"<string>"
],
"match_types": [
"brand_citation"
],
"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>",
"type": "positive",
"start": 123,
"end": 123
}
]
}
]
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Prompts
Get Prompt Citations
Paginated citations tied to a specific prompt.
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>'import requests
url = "https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhikoo.com/api/v1/public/prompts/{prompt_id}/citations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
],
"intent": "informational",
"journey_stage": "discovery",
"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>",
"platform": "ChatGPT",
"website_cited": true,
"created_at": "2023-11-07T05:31:56Z",
"sources": [
"<string>"
],
"mentioned_sources": [
"<string>"
],
"match_types": [
"brand_citation"
],
"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>",
"type": "positive",
"start": 123,
"end": 123
}
]
}
]
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Personal API key created in the dashboard (Settings > API keys).
Path Parameters
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Target website id
Response
Successful Response
Prompt schema with citations
Available options:
informational, comparative, transactional, navigational Available options:
discovery, consideration, decision, retention 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 Show child attributes
Show child attributes
Show child attributes
Show child attributes