PRpromptingcompany
Traffic & Sources

Get cited-source analytics and citation events

get/api/v1/sources/analytics

Request

  • Base URL
    https://app.promptingco.com
  • URL
    https://app.promptingco.com/api/v1/sources/analytics
  • Auth
    • API key in header x-api-key
    • or HTTP bearer
    • or API key in cookie better-auth.session_token

Query parameters

productIdstring[]

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

simulationBrandIdsstring[]

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

pageinteger
pageSizeinteger
eventPageinteger
eventPageSizeinteger
categorystring
contentTypestring
ownership'self' | 'competitor' | 'other'

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

modelstring
searchTermstring
viewIdstring
topicIdstring
regionIdstring
includeNullRegionsboolean

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

includeEventsboolean

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

urlsstring[]
productMentioned'mentioned' | 'not_mentioned'

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

startDatestring
endDatestring
sortBy'citation_count' | 'unique_conversations'
sortOrder'asc' | 'desc'

Response

Successful response

oktrue required

Changes

No recorded changes to this operation across all 1 revision of this API.