Skip to main content
GET
Get cited-source analytics and citation events

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • analytics:write: Write events to analytics
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Query Parameters

productId
string[]

Product ID scope. Repeat to include multiple products. Prefer this over simulationBrandIds.

Minimum string length: 1
simulationBrandIds
string[]
deprecated

Deprecated. Use productId. Existing cited-source callers may pass this repeated product ID parameter.

Minimum string length: 1
page
integer
default:1
Required range: x >= 1
pageSize
integer
default:10
Required range: 1 <= x <= 1000
eventPage
integer
default:1
Required range: x >= 1
eventPageSize
integer
default:100
Required range: 1 <= x <= 1000
category
string
Minimum string length: 1
contentType
string
Minimum string length: 1
ownership
enum<string>

Filter by per-brand ownership of the source. Independent of category (content type). Requires the per-brand ownership sync in Tinybird (DEV-2310).

Available options:
self,
competitor,
other
model
string
Minimum string length: 1
searchTerm
string
Minimum string length: 1
viewId
string
Minimum string length: 1
topicId
string
Minimum string length: 1
regionId
string
Minimum string length: 1
includeNullRegions
boolean

When regionId is set, include citation rows whose region is unset.

includeEvents
boolean
default:false

Include row-level citation events. Defaults to false for performance. Only needed for detailed event analysis.

urls
string<uri>[]
productMentioned
enum<string>

Filter to sources where the product was mentioned or not mentioned. Sources without mention analysis are excluded from both.

Available options:
mentioned,
not_mentioned
startDate
string
Pattern: ^\d{4}-\d{2}-\d{2}$
endDate
string
Pattern: ^\d{4}-\d{2}-\d{2}$
sortBy
enum<string>
Available options:
citation_count,
unique_conversations
sortOrder
enum<string>
Available options:
asc,
desc

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required