API explorer
Getting Started

Sections

Theme switcher

Cited Domains

Header Parameters

api-keystring

Body Parameters

topicsarray | null

Optional. Campaign topic names as an exact-match JSON array. Unknown topics return 400.

promptsarray | null

Optional. Prompt query texts as an exact-match (case-insensitive) JSON array. Non-matching texts are silently excluded from scope.

llmsarray | null

Optional. LLM providers as a JSON array: chatgpt, google_ai_mode, perplexity, gemini. Omitted defaults to all campaign LLMs.

Enum values:
chatgptgoogle_ai_modeperplexitygemini
domainstring | null

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

limitinteger

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

Minimum
1
Maximum
1000
offsetinteger

Number of results to skip after sorting the full filtered result set (not pre-filter campaign-wide rows).

ascboolean | null

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

sortstring | null

Sort field applied to the full filtered result set before pagination. citations/aggregated supports influence_score (default) and citation_count; citations/domains/aggregated supports domain_influence (default) and citation_count.

formatstring

Format in which the reply should be returned

Enum values:
jsonxml
campaign_idstring

Unique campaign identifier (UUID format)

Min length
1
granularitystring

Time granularity for the returned values

Enum values:
dailyweeklymonthly
start_datestring | null

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

end_datestring | null

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

metricsarray | null

JSON array of metrics: domain_influence, citation_count. Omitting this field returns all metrics.

Enum values:
domain_influencecitation_count

Response

200
Object

OK

Response Attributes

metaobject
dataarray | null
400
Object

Bad Request

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?