> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryprofound.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Trigger Rate
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](/rest-api/reports/reports-v2-overview).
`POST /v2/reports/shopping/trigger-rate/stream` uses the **same request
body**. It returns [Server-Sent Events](https://developer.mozilla.org/docs/Web/API/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).
```bash cURL theme={null}
curl -X POST https://api.tryprofound.com/v2/reports/shopping/trigger-rate \
-H "X-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
}'
```
```json 200 theme={null}
{
"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
}
]
}
```
## OpenAPI
````yaml POST /v2/reports/shopping/trigger-rate
openapi: 3.1.0
info:
title: External API
version: 8a280fe080bc62612cfa4d9ac5672343e0a2f720
servers:
- url: https://api.tryprofound.com
description: Production Server
security: []
paths:
/v2/reports/shopping/trigger-rate:
post:
tags:
- Reports
- Reports
summary: Query Shopping Trigger Rate V2
operationId: query_shopping_trigger_rate_v2_v2_reports_shopping_trigger_rate_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShoppingTriggerRateV2Query'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ShoppingTriggerRateV2Response'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- BearerAuth: []
x-codeSamples:
- lang: JavaScript
source: |-
import Profound from '@profoundai/client';
const client = new Profound({
apiKey: process.env['PROFOUND_API_KEY'], // This is the default and can be omitted
});
const response = await client.reports.shopping.triggerRate({
category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
end_date: 'end_date',
start_date: 'start_date',
});
console.log(response.data);
- lang: Python
source: |-
import os
from profound import Profound
client = Profound(
api_key=os.environ.get("PROFOUND_API_KEY"), # This is the default and can be omitted
)
response = client.reports.shopping.trigger_rate(
category_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
end_date="end_date",
start_date="start_date",
)
print(response.data)
components:
schemas:
ShoppingTriggerRateV2Query:
properties:
category_id:
type: string
format: uuid
title: Category Id
start_date:
type: string
title: Start Date
description: YYYY-MM-DD, ET, inclusive
end_date:
type: string
title: End Date
description: YYYY-MM-DD, ET, inclusive
group_by:
items:
type: string
enum:
- date
- topic
- region
- persona
- prompt
type: array
title: Group By
description: Group by `prompt`/`topic` for the per-prompt/-topic trigger rate.
metrics:
anyOf:
- items:
type: string
enum:
- total_runs
- shopping_triggered_runs
- trigger_rate_percentage
type: array
- type: 'null'
title: Metrics
interval:
type: string
enum:
- day
- week
- month
title: Interval
default: day
filter:
anyOf:
- $ref: '#/components/schemas/FilterNode'
- type: 'null'
limit:
anyOf:
- type: integer
maximum: 50
exclusiveMinimum: 0
- type: 'null'
title: Limit
description: Page size; default 10, max 50.
max_results:
anyOf:
- type: integer
maximum: 50000
exclusiveMinimum: 0
- type: 'null'
title: Max Results
description: 'Stream endpoint only: cap streamed rows.'
cursor:
anyOf:
- type: string
- type: 'null'
title: Cursor
additionalProperties: false
type: object
required:
- category_id
- start_date
- end_date
title: ShoppingTriggerRateV2Query
ShoppingTriggerRateV2Response:
properties:
info:
$ref: '#/components/schemas/ShoppingTriggerRateV2Info'
data:
items:
$ref: '#/components/schemas/ShoppingTriggerRateRow'
type: array
title: Data
type: object
required:
- info
- data
title: ShoppingTriggerRateV2Response
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
FilterNode:
properties:
and:
anyOf:
- items:
$ref: '#/components/schemas/FilterNode'
type: array
- type: 'null'
title: And
or:
anyOf:
- items:
$ref: '#/components/schemas/FilterNode'
type: array
- type: 'null'
title: Or
not:
anyOf:
- $ref: '#/components/schemas/FilterNode'
- type: 'null'
field:
anyOf:
- type: string
- type: 'null'
title: Field
op:
anyOf:
- type: string
- type: 'null'
title: Op
value:
title: Value
additionalProperties: false
type: object
title: FilterNode
description: A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
ShoppingTriggerRateV2Info:
properties:
total_results:
anyOf:
- type: integer
- type: 'null'
title: Total Results
description: >-
Total rows matching the query before pagination (null when not
computed).
count:
type: integer
title: Count
description: Number of rows returned in `data` for this page.
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
description: Opaque cursor for the next page; null on the last page.
models:
items:
type: string
type: array
title: Models
description: Display names of the models the report covers.
start_date:
type: string
title: Start Date
description: Echoed request start date (YYYY-MM-DD, ET).
end_date:
type: string
title: End Date
description: Echoed request end date (YYYY-MM-DD, ET).
filter:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Filter
description: Echoed normalized filter tree, or null when no filter was sent.
metrics:
items:
type: string
type: array
title: Metrics
description: Metrics returned per row.
additionalProperties: true
type: object
required:
- count
- models
- start_date
- end_date
- metrics
title: ShoppingTriggerRateV2Info
ShoppingTriggerRateRow:
properties:
date:
anyOf:
- type: string
- type: 'null'
title: Date
topic:
anyOf:
- $ref: '#/components/schemas/DimensionRef'
- type: 'null'
region:
anyOf:
- $ref: '#/components/schemas/DimensionRef'
- type: 'null'
persona:
anyOf:
- $ref: '#/components/schemas/DimensionRef'
- type: 'null'
prompt:
anyOf:
- $ref: '#/components/schemas/DimensionRef'
- type: 'null'
total_runs:
anyOf:
- type: integer
- type: 'null'
title: Total Runs
shopping_triggered_runs:
anyOf:
- type: integer
- type: 'null'
title: Shopping Triggered Runs
trigger_rate_percentage:
anyOf:
- type: number
- type: 'null'
title: Trigger Rate Percentage
additionalProperties: true
type: object
title: ShoppingTriggerRateRow
description: One trigger-rate row. Group dims present depend on `group_by`.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
DimensionRef:
properties:
id:
anyOf:
- type: string
- type: 'null'
title: Id
name:
anyOf:
- type: string
- type: 'null'
title: Name
type: object
title: DimensionRef
description: An ``{id, name}`` reference for a grouped dimension value.
securitySchemes:
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key
BearerAuth:
type: http
scheme: bearer
````