curl -X POST https://api.tryprofound.com/v2/reports/shopping/products \
-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",
"include_merchants": true,
"metrics": ["visibility_score", "product_rating", "product_num_reviews"],
"limit": 10
}'
{
"info": {
"total_results": 128,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"models": ["ChatGPT"],
"include_merchants": true,
"metrics": ["visibility_score", "product_rating", "product_num_reviews"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"product": { "name": "Example Running Shoe", "brand": "Example Brand" },
"merchants": [
{ "name": "Example Retailer", "price": "$120.00" },
{ "name": "Example Brand", "price": "$110.00" }
],
"product_url": "https://www.example.com/p/example-running-shoe",
"product_image_urls": ["https://images.example.com/products/example-running-shoe.jpg"],
"product_rating": 4.5,
"product_num_reviews": 1200,
"visibility_score": 0.30
}
]
}
Compras
Productos
POST
/
v2
/
reports
/
shopping
/
products
curl -X POST https://api.tryprofound.com/v2/reports/shopping/products \
-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",
"include_merchants": true,
"metrics": ["visibility_score", "product_rating", "product_num_reviews"],
"limit": 10
}'
{
"info": {
"total_results": 128,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"models": ["ChatGPT"],
"include_merchants": true,
"metrics": ["visibility_score", "product_rating", "product_num_reviews"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"product": { "name": "Example Running Shoe", "brand": "Example Brand" },
"merchants": [
{ "name": "Example Retailer", "price": "$120.00" },
{ "name": "Example Brand", "price": "$110.00" }
],
"product_url": "https://www.example.com/p/example-running-shoe",
"product_image_urls": ["https://images.example.com/products/example-running-shoe.jpg"],
"product_rating": 4.5,
"product_num_reviews": 1200,
"visibility_score": 0.30
}
]
}
Este informe muestra la visibilidad de los productos en los resultados de compras de ChatGPT. También puede
proporcionar las ofertas de comerciantes para cada producto. El informe devuelve cada producto como
{ name, brand } con sus métricas como campos con nombre.
- Métricas:
visibility_score;average_position(un número más bajo es mejor);visibility_rank; las métricas de frecuencia de posiciónposition1_percentage,position2_percentage,position3_percentage,position_above3_percentage;product_rating;product_num_reviews. - Métricas de frecuencia de posición: Cada una es la proporción de apariciones del producto en esa posición (
position1= la primera;position_above3= por debajo de la posición 3). Los valores son fracciones de 0 a 1, no de 0 a 100. Los cuatro valores suman aproximadamente 1. group_by:date,topicoprompt.- Campos de filtro:
topic,region,persona,prompt,tag,brand,merchant.
Ofertas de comerciantes
Para adjuntar las ofertas de comerciantes a cada producto, estableceinclude_merchants: true.
El informe agrega entonces merchants (una lista de { name, price }), product_url
y product_image_urls. Este modo no acepta group_by ni
target_product. Las métricas de frecuencia de posición no están disponibles en este modo.
Modo de competidores
Para devolver un producto y sus principales competidores, establecetarget_product con el
nombre de un producto. Para definir el número de competidores, usa competitor_limit (el
valor predeterminado es 5). El modo de competidores solo está disponible en la vista de elementos. No lo uses
con include_merchants.
Los datos de compras provienen ú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/products/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/products \
-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",
"include_merchants": true,
"metrics": ["visibility_score", "product_rating", "product_num_reviews"],
"limit": 10
}'
{
"info": {
"total_results": 128,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"models": ["ChatGPT"],
"include_merchants": true,
"metrics": ["visibility_score", "product_rating", "product_num_reviews"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"product": { "name": "Example Running Shoe", "brand": "Example Brand" },
"merchants": [
{ "name": "Example Retailer", "price": "$120.00" },
{ "name": "Example Brand", "price": "$110.00" }
],
"product_url": "https://www.example.com/p/example-running-shoe",
"product_image_urls": ["https://images.example.com/products/example-running-shoe.jpg"],
"product_rating": 4.5,
"product_num_reviews": 1200,
"visibility_score": 0.30
}
]
}
Autorizaciones
APIKeyHeaderBearerAuth
Cuerpo
application/json
YYYY-MM-DD, ET, inclusive
YYYY-MM-DD, ET, inclusive
Opciones disponibles:
date, topic, prompt Opciones disponibles:
visibility_score, average_position, visibility_rank, position1_percentage, position2_percentage, position3_percentage, position_above3_percentage, product_rating, product_num_reviews Opciones disponibles:
day, week, month Include per-product merchant offers (names, prices, urls, images).
Return this product plus its top competitors (item view only).
Minimum string length:
1Competitors returned when target_product is set.
Rango requerido:
x >= 1A 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ó?