> ## 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.
# Tasa de activación
Este informe muestra con qué frecuencia ChatGPT devuelve resultados de compras para tus prompts.
Proporciona el total de ejecuciones, las ejecuciones que activaron compras y la tasa de activación.
* **Métricas:** `total_runs`, `shopping_triggered_runs`, `trigger_rate_percentage`. `trigger_rate_percentage` es `shopping_triggered_runs / total_runs`. Es una **fracción de 0 a 1**, no de 0 a 100. Para obtener un porcentaje, multiplica el valor por 100.
* **`group_by`:** `date`, `topic`, `region`, `persona`, `prompt`.
* **Campos de filtro:** `topic`, `region`, `persona`, `prompt`, `tag`.
Para obtener la tasa de cada prompt, añade `prompt` a `group_by`. Para obtener la tasa de
cada tema, añade `topic`. Para obtener una serie temporal, añade `date` y establece `interval`.
Los datos de compras proceden únicamente de ChatGPT. Ningún informe de compras tiene un
group\_by `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](/es/rest-api/reports/reports-v2-overview).
`POST /v2/reports/shopping/trigger-rate/stream` usa el **mismo cuerpo de
solicitud**. Devuelve [Server-Sent Events](https://developer.mozilla.org/docs/Web/API/Server-sent_events):
un evento `summary` (el bloque `info`) y, a continuación, un evento `result` por cada fila.
El stream rechaza `limit` y `cursor`. Devuelve todas las filas por defecto. Para
establecer un máximo, usa `max_results` (máximo 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: 0.60.2
x-scalar-sdk-installation:
- lang: Python
description: |-
```sh
pip install profound
```
- lang: TypeScript
description: |-
```sh
npm install @profoundai/client
```
- lang: Rust
description: |-
```sh
cargo add profound
```
servers:
- url: https://api.tryprofound.com
description: Production Server
security:
- APIKeyHeader:
- X-API-Key
- BearerAuth: []
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:
- label: Python
lang: Python
source: |-
import os
from profound import Profound
client = Profound(
api_key=os.environ.get("PROFOUND_API_KEY"),
)
shopping = client.reports.shopping.trigger_rate(
category_id="7c9e6679-7425-40de-944b-e07fc1f90ae7",
start_date="",
end_date="",
interval="day",
)
print(shopping)
- label: TypeScript
lang: TypeScript
source: |-
import Profound from '@profoundai/client';
const client = new Profound({
apiKey: process.env['PROFOUND_API_KEY'], // defaults to the PROFOUND_API_KEY env var
environment: 'production',
});
const shopping = await client.reports.shopping.triggerRate({
category_id: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
start_date: '',
end_date: '',
interval: 'day',
});
console.log(shopping);
- label: rust
lang: rust
source: |-
use profound::*;
#[tokio::main]
async fn main() -> Result<(), Box> {
let client = ProfoundClient::builder()
.api_key(std::env::var("PROFOUND_API_KEY")?)
.build()?;
let response = client
.reports()
.shopping()
.trigger_rate(ShoppingTriggerRateV2Query {
category_id: "7c9e6679-7425-40de-944b-e07fc1f90ae7".to_string(),
start_date: "".to_string(),
end_date: "".to_string(),
group_by: None,
metrics: None,
interval: None,
filter: None,
limit: None,
max_results: None,
cursor: None,
})
.send()
.await?;
println!("{:?}", response);
Ok(())
}
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
bearerFormat: JWT
````