Skip to main content
POST
Qué dominios y páginas citan las respuestas de IA, ordenados de más a menos citados. Agrupa por page para obtener filas a nivel de URL; usa scope: "owned" para ver solo los dominios que te pertenecen.
  • Métricas: count (citas sin procesar), citation_share (cuota promedio por modelo), rank, first_cited_at (solo páginas).
  • group_by: page, date, model, topic, region, persona, prompt.
  • Sin sort: las filas siempre se ordenan de más a menos citadas.
  • Filtros de la capa de citas: domain (reconoce subdominios), page, analysis_type (visibility·sentiment·factcheck·all), citation_category (owned·competition·social·earned_media·earned_institutions·pr_wire·other·personalizada), citation_tag (tus etiquetas personalizadas: enuméralas con Get Citation Tags).
citation_category y citation_tag son hojas and de nivel superior que aceptan is / in; los valores dentro de un mismo in se combinan con OR, así que {"field": "citation_tag", "op": "in", "value": ["Editorial", "Docs"]} coincide con las URL que tengan cualquiera de las dos etiquetas.
count y citation_share miden cosas distintas: citation_share se promedia por modelo de IA, por lo que no se ordenará exactamente igual que el count sin procesar.
¿Es tu primera vez con los informes v2? Consulta Filtrado y conceptos para conocer la estructura compartida de las solicitudes, el árbol de filtros, la agrupación y la paginación.
POST /v2/reports/citations/stream acepta el mismo cuerpo de solicitud y devuelve Server-Sent Events: un evento summary (el bloque info) y luego un evento result por fila. limit/cursor se ignoran; de forma predeterminada devuelve todo. Pasa max_results para establecer un límite.
Response (text/event-stream)

Autorizaciones

X-API-Key
string
header
requerido

Cuerpo

application/json
category_id
string<uuid>
requerido
start_date
string
requerido

YYYY-MM-DD, ET, inclusive

end_date
string
requerido

YYYY-MM-DD, ET, inclusive

entity
enum<string>
predeterminado:domain

What each row represents: domain (default), page, or citation_category. Legacy: group_by: ["page"] (with entity omitted) is still accepted and is equivalent to entity: "page". citation_category uses the dashboard split view: a citation counts under both its page-level and domain-level category, so category shares can sum to more than 100%.

Opciones disponibles:
domain,
page,
citation_category
group_by
enum<string>[]
Opciones disponibles:
page,
date,
model,
topic,
region,
persona,
prompt
metrics
enum<string>[] | null
Opciones disponibles:
count,
citation_share,
rank,
first_cited_at
interval
enum<string>
predeterminado:day
Opciones disponibles:
day,
week,
month
scope
enum<string>
predeterminado:all

all (every cited domain) or owned (only your owned domains). Applies to entity=domain.

Opciones disponibles:
all,
owned
filter
FilterNode · object | null

citation_category filters on a cited URL's single category; citation_tag filters on the custom citation tags a URL carries (a URL can carry several). List the category's tags with GET /v1/org/categories/{category_id}/citation-tags.

limit
integer | null

Page size; default 10, max 50.

Rango requerido: 0 < x <= 50
max_results
integer | null

Stream endpoint only: cap the number of streamed rows (default: all).

Rango requerido: x > 0
cursor
string | null

Respuesta

Successful Response

info
CitationsV2Info · object
requerido
data
CitationRow · object[]
requerido