curl -X POST https://api.tryprofound.com/v2/reports/shopping/merchants \
-H "X-API-Key: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"category_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"metrics": ["merchant_share", "merchant_share_rank", "merchant_visibility", "merchant_visibility_rank"],
"limit": 10
}'
{
"info": {
"total_results": 24,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"view": "distribution",
"models": ["ChatGPT"],
"metrics": ["merchant_share", "merchant_share_rank", "merchant_visibility", "merchant_visibility_rank"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"merchant_name": "Example Retailer",
"merchant_share": 0.25,
"merchant_share_rank": 1,
"merchant_visibility": 0.40,
"merchant_visibility_rank": 1
}
]
}
Compras
Comerciantes
POST
/
v2
/
reports
/
shopping
/
merchants
curl -X POST https://api.tryprofound.com/v2/reports/shopping/merchants \
-H "X-API-Key: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"category_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"metrics": ["merchant_share", "merchant_share_rank", "merchant_visibility", "merchant_visibility_rank"],
"limit": 10
}'
{
"info": {
"total_results": 24,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"view": "distribution",
"models": ["ChatGPT"],
"metrics": ["merchant_share", "merchant_share_rank", "merchant_visibility", "merchant_visibility_rank"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"merchant_name": "Example Retailer",
"merchant_share": 0.25,
"merchant_share_rank": 1,
"merchant_visibility": 0.40,
"merchant_visibility_rank": 1
}
]
}
Este informe ofrece datos de comerciantes para los resultados de compras de ChatGPT.
group_by
selecciona una de tres vistas. merchant_share es la cuota de ofertas del comerciante.
merchant_visibility es la cuota del comerciante en las ejecuciones en las que aparece. Son
dos medidas diferentes.
Vistas
- Distribución (omite
group_by): una fila por cada comerciante. Métricas:merchant_share,merchant_share_rank,merchant_visibility,merchant_visibility_rank. Para obtener una serie temporal, añadedate. - Cuota de marca (
group_by: ["brand"]): una fila por cada comerciante y marca. Métricas:merchant_share,brand_share(la cuota de la marca en el comerciante),visibility_rank. - Productos principales (
group_by: ["product"]): una fila por cada comerciante y producto. Métricas:merchant_visibility,product_visibility,product_rank.
topic, region, persona, prompt, tag. La
vista de distribución también acepta un filtro brand.
Reglas
- Usa las métricas válidas para la vista. Otras métricas devuelven
422. - Agrupa por
brando porproduct. No uses ambos. datesolo está disponible en la vista de distribución.group_by: ["brand", "date"]o["product", "date"]devuelve422.- El filtro
brandsolo está disponible en la vista de distribución.
En la vista de distribución,
merchant_visibility y merchant_visibility_rank
son métricas de aparición en ejecuciones. El informe las obtiene de una segunda consulta y las añade
a cada comerciante. Solicítalas solo cuando las necesites.Los datos de compras proceden únicamente de ChatGPT. Ningún informe de compras tiene un
group_by
de model ni un filtro model.Los informes v2 comparten una misma estructura de solicitud. Para el árbol de filtros, la agrupación y la
paginación, consulta Filtrado y conceptos.
Variante de streaming (SSE) (mismo cuerpo, /stream)
Variante de streaming (SSE) (mismo cuerpo, /stream)
POST /v2/reports/shopping/merchants/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).curl -X POST https://api.tryprofound.com/v2/reports/shopping/merchants \
-H "X-API-Key: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"category_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"metrics": ["merchant_share", "merchant_share_rank", "merchant_visibility", "merchant_visibility_rank"],
"limit": 10
}'
{
"info": {
"total_results": 24,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"view": "distribution",
"models": ["ChatGPT"],
"metrics": ["merchant_share", "merchant_share_rank", "merchant_visibility", "merchant_visibility_rank"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"merchant_name": "Example Retailer",
"merchant_share": 0.25,
"merchant_share_rank": 1,
"merchant_visibility": 0.40,
"merchant_visibility_rank": 1
}
]
}
Autorizaciones
APIKeyHeaderBearerAuth
Cuerpo
application/json
YYYY-MM-DD, ET, inclusive
YYYY-MM-DD, ET, inclusive
[] = distribution; [brand] = brand share within each merchant; [product] = top products per merchant. date (distribution only) adds a time series.
Opciones disponibles:
date, brand, product Defaults to the chosen view's metrics; must be valid for that view.
Opciones disponibles:
merchant_share, merchant_share_rank, merchant_visibility, merchant_visibility_rank, visibility_rank, brand_share, product_visibility, product_rank Opciones disponibles:
day, week, month A leaf (field/op/value) or an and/or/not group.
Show child attributes
Show child attributes
Page size; default 10, max 50.
Rango requerido:
0 < x <= 50Stream endpoint only: cap streamed rows.
Rango requerido:
0 < x <= 50000¿Esta página le ayudó?