Skip to main content
POST
Este informe muestra la visibilidad de las marcas en los resultados de compras de ChatGPT. Indica con qué frecuencia aparece cada marca, su posición promedio y su clasificación. Selecciona las marcas con assets. Divide los resultados con group_by. Cada métrica es un campo con nombre en la fila.
  • Métricas: visibility_score (la proporción de resultados de compras que incluyen la marca); average_position (la clasificación promedio cuando aparece la marca; un número más bajo es mejor); visibility_rank.
  • group_by: date, topic, region o prompt.
  • Selección de marcas: selecciona las marcas con el parámetro assets. Indica un nombre o una lista. scope: "all" clasifica todas las marcas. scope: "owned" (el valor predeterminado) devuelve solo tus marcas. Una selección con assets devuelve una sola página e ignora limit.
  • Campos de filtro: topic, region, persona, prompt, tag.
Los datos de compras provienen solo de ChatGPT. Ningún informe de compras tiene un group_by de model ni un filtro de model.
Los informes v2 comparten una misma forma de solicitud. Para conocer el árbol de filtros, la agrupación y la paginación, consulta Filtrado y conceptos.
POST /v2/reports/shopping/brands/stream usa el mismo cuerpo de solicitud. Devuelve Server-Sent Events: un evento summary (el bloque info) y luego un evento result por cada fila. El stream rechaza limit y cursor. Devuelve todas las filas de forma predeterminada. Para establecer un máximo, usa max_results (máximo 50000). Usa el stream para obtener un resultado grande en una sola solicitud.

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,
topic,
region,
prompt
metrics
enum<string>[] | null
Opciones disponibles:
visibility_score,
average_position,
visibility_rank
interval
enum<string>
predeterminado:day
Opciones disponibles:
day,
week,
month
scope
enum<string>
predeterminado:owned
Opciones disponibles:
owned,
all
assets

Restrict to these asset names (a name or list). Overrides scope.

filter
FilterNode · object | null

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

limit
integer | null

Page size for scope=all; 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: 0 < x <= 50000
cursor
string | null

Respuesta

Successful Response

info
ShoppingBrandsV2Info · object
requerido
data
ShoppingBrandRow · object[]
requerido