Skip to main content
POST
Con qué frecuencia aparece tu activo en las respuestas de IA, además de la cuota de voz y la posición media. Selecciona los activos con assets, desglosa los resultados con group_by y lee cada métrica como un campo con nombre en la fila.
  • Métricas: visibility_score (proporción de respuestas en las que apareció el activo), share_of_voice (proporción de todas las menciones), average_position (posición media cuando se menciona; cuanto más baja, mejor).
  • group_by: date, model, topic, region, prompt, persona.
  • Selecciona los activos con el parámetro assets (un nombre, una lista o { op, value }). scope: "all" clasifica todos los activos; "owned" devuelve solo los tuyos.
  • sort por cualquier métrica solicitada, por ejemplo { "field": "visibility_score" }.
¿Es la primera vez que usas los informes v2? Consulta Filtros y conceptos para ver la estructura de solicitud compartida, el árbol de filtros, la agrupación y la paginación.
POST /v2/reports/visibility/stream recibe el mismo cuerpo de solicitud y devuelve Server-Sent Events: un evento summary (el bloque info) y, a continuación, un evento result por fila. limit/cursor se ignoran; de forma predeterminada devuelve todo. Pasa max_results para limitarlo.
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

group_by
enum<string>[]
Opciones disponibles:
date,
model,
topic,
region,
prompt,
persona
metrics
enum<string>[] | null
Opciones disponibles:
visibility_score,
share_of_voice,
average_position
interval
enum<string>
predeterminado:day
Opciones disponibles:
day,
week,
month
scope
enum<string>
predeterminado:owned
Opciones disponibles:
owned,
all
assets

A name (is), a list (in), or {op,value} with op is/in/not_in.

filter
FilterNode · object | null

A leaf (field/op/value) or an and/or/not group.

sort
SortSpec · object
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
VisibilityV2Info · object
requerido
data
VisibilityRow · object[]
requerido