Skip to main content
POST
aeo.citations.count

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
date
string
required

The day to read the figures for, YYYY-MM-DD; today's date gives the latest.

Required string length: 1 - 512
Pattern: ^(?:^\d{4}-\d{2}-\d{2}$)$
target
string
required

The site or page to look up: a domain such as example.com, or a full URL.

Required string length: 1 - 2048
country
string

Two-letter country code, e.g. "us". Default: all countries.

Pattern: ^[a-z]{2}$
mode
enum<string>

Scope of the target: exact (this URL only), prefix (URLs starting with the target), domain (the domain without subdomains), or subdomains (default — the domain and all its subdomains).

Available options:
exact,
prefix,
domain,
subdomains

Response

The result

citations
number
required

Citations of the site in AI answers, across all assistants the source tracks.

pages
number

How many of the site's pages are cited.

chatgptCitations
number

Citations in ChatGPT answers.

googleAiOverviewCitations
number

Citations in Google AI Overviews.

googleAiModeCitations
number

Citations in Google AI Mode answers.