curl -X POST https://api.tryprofound.com/v2/reports/shopping/trigger-rate \
-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",
"group_by": ["date"],
"metrics": ["total_runs", "shopping_triggered_runs", "trigger_rate_percentage"],
"limit": 10
}'
{
"info": {
"total_results": 30,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"models": ["ChatGPT"],
"metrics": ["total_runs", "shopping_triggered_runs", "trigger_rate_percentage"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"date": "2026-06-01",
"total_runs": 1240,
"shopping_triggered_runs": 388,
"trigger_rate_percentage": 0.313
}
]
}
Shopping
Trigger Rate
POST
/
v2
/
reports
/
shopping
/
trigger-rate
curl -X POST https://api.tryprofound.com/v2/reports/shopping/trigger-rate \
-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",
"group_by": ["date"],
"metrics": ["total_runs", "shopping_triggered_runs", "trigger_rate_percentage"],
"limit": 10
}'
{
"info": {
"total_results": 30,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"models": ["ChatGPT"],
"metrics": ["total_runs", "shopping_triggered_runs", "trigger_rate_percentage"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"date": "2026-06-01",
"total_runs": 1240,
"shopping_triggered_runs": 388,
"trigger_rate_percentage": 0.313
}
]
}
This report shows how often ChatGPT returns shopping results for your prompts.
It gives the total runs, the shopping-triggered runs, and the trigger rate.
- Metrics:
total_runs,shopping_triggered_runs,trigger_rate_percentage.trigger_rate_percentageisshopping_triggered_runs / total_runs. It is a 0–1 fraction, not 0–100. To get a percent, multiply the value by 100. group_by:date,topic,region,persona,prompt.- Filter fields:
topic,region,persona,prompt,tag.
prompt to group_by. To get the rate for
each topic, add topic. To get a time series, add date and set interval.
Shopping data comes from ChatGPT only. No shopping report has a
model
group_by or a model filter.The v2 reports share one request shape. For the filter tree, grouping, and
pagination, see Filtering & concepts.
Streaming (SSE) variant (same body, /stream)
Streaming (SSE) variant (same body, /stream)
POST /v2/reports/shopping/trigger-rate/stream uses the same request
body. It returns Server-Sent Events:
one summary event (the info block), then one result event for each row.
The stream rejects limit and cursor. It returns all rows by default. To
set a maximum, use max_results (maximum 50000).curl -X POST https://api.tryprofound.com/v2/reports/shopping/trigger-rate \
-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",
"group_by": ["date"],
"metrics": ["total_runs", "shopping_triggered_runs", "trigger_rate_percentage"],
"limit": 10
}'
{
"info": {
"total_results": 30,
"count": 10,
"next_cursor": "eyJvZmZzZXQiOjEwfQ==",
"models": ["ChatGPT"],
"metrics": ["total_runs", "shopping_triggered_runs", "trigger_rate_percentage"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"date": "2026-06-01",
"total_runs": 1240,
"shopping_triggered_runs": 388,
"trigger_rate_percentage": 0.313
}
]
}
Authorizations
APIKeyHeaderBearerAuth
Body
application/json
YYYY-MM-DD, ET, inclusive
YYYY-MM-DD, ET, inclusive
Group by prompt/topic for the per-prompt/-topic trigger rate.
Available options:
date, topic, region, persona, prompt Available options:
total_runs, shopping_triggered_runs, trigger_rate_percentage Available options:
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.
Required range:
0 < x <= 50Stream endpoint only: cap streamed rows.
Required range:
0 < x <= 50000Was this page helpful?