Skip to main content
GET
/
api
/
v1
/
public
/
citations
List Citations
curl --request GET \
  --url https://api.tryhikoo.com/api/v1/public/citations \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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
            }
          ]
        }
      ],
      "prompt": {
        "id": 123,
        "content": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "competitor_ranks": [
        {
          "competitor_id": 123,
          "rank": 123,
          "total": 123
        }
      ]
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 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

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:20
Required range: 1 <= x <= 100
platforms[]
enum<string>[] | null
Available options:
ChatGPT,
Gemini,
AI Overviews,
Google AI Mode,
Perplexity,
Mistral,
Claude,
DeepSeek,
Grok,
Copilot
time_range
enum<string> | null
Available options:
all_time,
1y,
1m,
1w,
1d
localizations[]
string[] | null
website_cited
boolean | null

Filter to citations where the website is cited (True) or not (False)

topic_ids[]
integer[] | null
match_types[]
enum<string>[] | null

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).

Available options:
brand_citation,
site_mention,
background_source
website_id
integer
required

Target website id

Response

Successful Response

Paginated citations response

items
CitationWithPrompt · object[]
required
total
integer
required
page
integer
required
page_size
integer
required
total_pages
integer
required