Skip to main content
GET
Get citation history for a cited URL

Authorizations

Authorization
string
header
required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Path Parameters

reportId
string
required

Brand report identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Query Parameters

url
string
required

Cited URL to fetch the citation history for. URL-encoded.

Minimum string length: 1
Example:

"https://example.com/guides/best-flat-feet-running-shoes"

startDate
string
required

Start date for the lookup window (inclusive).

Minimum string length: 1
Example:

"2025-01-01"

endDate
string
required

End date for the lookup window (inclusive).

Minimum string length: 1
Example:

"2025-01-31"

country
string
required

Country code to filter by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.

Minimum string length: 1
Example:

"us"

frequency
enum<string>

Optional. weekly buckets the periods by ISO week (a weekly run lands on its week's Monday; the current, unfinished week is left out). Defaults to weekly for a workspace monitored weekly, otherwise daily.

Available options:
daily,
weekly
Example:

"weekly"

engines

Optional. AI engine(s) to filter by. Repeat the param or pass a single value.

Available options:
chatgpt,
google,
perplexity,
copilot,
google_ai_mode,
gemini,
claude,
grok,
bing_ai_mode
Example:

"chatgpt"

tagId
string

Optional. Filter the citation history by tag id.

Response

Citation totals (current vs previous period) and daily history for the given URL.

totalPeriodCitations
number
required

Total citations for the URL across the window.

totalCitationsPreviousPeriod
number
required

Total citations for the URL across the immediately-preceding window of equal length.

percentageChange
number
required

Percentage change vs the previous period (rounded to one decimal). +100 when growing from zero.

citationsHistory
object[]
required