Getting Started

Sections

Theme switcher

GenAI Citation Analysis (URL-level)

Header Parameters

api-keystring

Query Parameters

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

metricsarray

Comma-separated list of metrics: influence_score, citation_count, prompt_count. Omitting this parameter returns all metrics.

Style
form
Enum values:
influence_scorecitation_countprompt_count
campaign_idstring Required

Unique campaign identifier (UUID format)

topicsarray

Filter results by topics (comma-separated list)

Style
form
promptsarray

Scope to specific prompts by their query text — exact match, case-insensitive (comma-separated list). Non-matching texts are silently excluded from scope.

Style
form
llmsarray

Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list)

Style
form
Enum values:
chatgptgoogle_ai_modeperplexitygemini
domainstring

Filter to URLs belonging to a cited domain. Exact match on the normalized domain string returned in the domain response field (case-insensitive; no subdomain rollup — domain=nike.com does not return shop.nike.com).

urlstring

Filter to a specific cited URL (exact match on cleaned URL: protocol stripped, www removed, trailing slashes and tracking params removed).

formatstring

Format in which the reply should be returned

Enum values:
jsonxml
limitinteger

Page size. Default is 100. Valid range is 1–1,000.

ascboolean | null

Sort direction: true for ascending, false for descending. Default is false (descending).

sortstring

Sort field applied to the full filtered result set before pagination. Supported values: influence_score, citation_count. Default is influence_score.

offsetinteger

Defines the number of results to skip

Response

200
Object

OK

Response Attributes

metaobject

Show child attributes

dataarray | null

Show child attributes

400
Object

Bad Request

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot