Extract structured data from ChatGPT about your any topic
include.rawResponse (boolean): Include raw streaming response events. Defaults to false (+2 credits)include.searchQueries (boolean): Include search model queries (fan-out queries) that ChatGPT uses internally to gather information. Defaults to false (+2 credits)| Field | Type | Description |
|---|---|---|
tags | array | Category tags for the shopping card (e.g., [“electronics”, “deals”]) |
products | array | Array of product information objects |
| Field | Type | Description |
|---|---|---|
title | string | Product name |
url | string | Product page URL with ChatGPT attribution |
price | string | Current price (e.g., “$57.00”) |
featured_tag | string | Product category or style tag |
merchant | string | Merchant information (e.g., “adidas + others”) |
imageUrls | array | Array of product image URLs (multiple sizes) |
rating | float | Product rating (0-5 scale) |
numReviews | integer | Number of reviews |
id | string | Unique product identifier |
offers | array | Array of shopping offers from different merchants |
rating_grouped_citation | object | Rating source information with supporting websites |
| Field | Type | Description |
|---|---|---|
merchant_name | string | Merchant name (e.g., “adidas”, “Macy’s”) |
product_name | string | Product name as listed by merchant |
url | string | Offer URL with ChatGPT attribution |
price | string | Offer price (e.g., “$57.00”) |
details | string | Stock and delivery information |
available | boolean | Offer availability status |
checkoutable | boolean | Whether offer can be checked out directly |
price_details | object | Detailed price breakdown |
tag | object | Promotional tag (e.g., “Best price”) |
| Field | Type | Description |
|---|---|---|
base | string | Base product price |
total | string | Total price including any additional costs |
| Field | Type | Description |
|---|---|---|
title | string | Source title |
url | string | Source URL |
supporting_websites | array | Array of supporting website references |
| Field | Type | Description |
|---|---|---|
type | string | Entity type identifier (e.g., “product”, “software”) |
name | string | Entity name or title |
| Field | Type | Description |
|---|---|---|
result.rawResponse | array | Array of ChatGPT’s streamed response events (included when include.rawResponse is true) |
result.searchQueries | array | Array of search model queries (fan-out queries) ChatGPT used internally to gather information (included when include.searchQueries is true) |
result.shoppingCards | array | Array of shopping/product cards extracted from response (when available) |
result.entities | array | Array of entities extracted from response (when available) |
result.sources | array | Array of sources referenced in the response (when available) |
result.model | string | The ChatGPT model used to generate the response |
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Request parameters for monitoring ChatGPT responses
The prompt to send to ChatGPT
1 - 10000"What do you know about Acme Corp?"
Optional country/region code for localized monitoring
"US"
Optional flags for including additional response formats
{
"markdown": true,
"rawResponse": true,
"searchQueries": true
}