Skip to main content
POST
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_percentage is shopping_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.
To get the rate for each prompt, add 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.
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).

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
category_id
string<uuid>
required
​
start_date
string
required

YYYY-MM-DD, ET, inclusive

​
end_date
string
required

YYYY-MM-DD, ET, inclusive

​
group_by
enum<string>[]

Group by prompt/topic for the per-prompt/-topic trigger rate.

Available options:
date,
topic,
region,
persona,
prompt
​
metrics
enum<string>[] | null
Available options:
total_runs,
shopping_triggered_runs,
trigger_rate_percentage
​
interval
enum<string>
default:day
Available options:
day,
week,
month
​
filter
FilterNode · object | null

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

​
limit
integer | null

Page size; default 10, max 50.

Required range: 0 < x <= 50
​
max_results
integer | null

Stream endpoint only: cap streamed rows.

Required range: 0 < x <= 50000
​
cursor
string | null

Response

Successful Response

​
info
ShoppingTriggerRateV2Info · object
required
​
data
ShoppingTriggerRateRow · object[]
required