curl -X POST https://api.tryprofound.com/v2/reports/shopping/brands \
-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": ["visibility_score", "average_position", "visibility_rank"],
"scope": "owned",
"limit": 10
}'
{
"info": {
"total_results": 1,
"count": 1,
"next_cursor": null,
"scope": "owned",
"assets": null,
"models": ["ChatGPT"],
"metrics": ["visibility_score", "average_position", "visibility_rank"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"asset": { "name": "Example Brand", "owned": true },
"date": "2026-06-01",
"visibility_score": 0.42,
"average_position": 3.2,
"visibility_rank": 1
}
]
}
Shopping
Brands
POST
/
v2
/
reports
/
shopping
/
brands
curl -X POST https://api.tryprofound.com/v2/reports/shopping/brands \
-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": ["visibility_score", "average_position", "visibility_rank"],
"scope": "owned",
"limit": 10
}'
{
"info": {
"total_results": 1,
"count": 1,
"next_cursor": null,
"scope": "owned",
"assets": null,
"models": ["ChatGPT"],
"metrics": ["visibility_score", "average_position", "visibility_rank"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"asset": { "name": "Example Brand", "owned": true },
"date": "2026-06-01",
"visibility_score": 0.42,
"average_position": 3.2,
"visibility_rank": 1
}
]
}
This report shows brand visibility in ChatGPT shopping results. It gives how
often each brand appears, its average position, and its rank. Select the brands
with
assets. Divide the results with group_by. Each metric is a named field
on the row.
- Metrics:
visibility_score(the share of shopping results that include the brand);average_position(the average rank when the brand appears; a lower number is better);visibility_rank. group_by:date,topic,region, orprompt.- Brand selection: Select the brands with the
assetsparameter. Give one name or a list.scope: "all"ranks all brands.scope: "owned"(the default) returns only your brands. Anassetsselection returns one page and ignoreslimit. - Filter fields:
topic,region,persona,prompt,tag.
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/brands/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). Use the stream to get a
large result in one request.curl -X POST https://api.tryprofound.com/v2/reports/shopping/brands \
-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": ["visibility_score", "average_position", "visibility_rank"],
"scope": "owned",
"limit": 10
}'
{
"info": {
"total_results": 1,
"count": 1,
"next_cursor": null,
"scope": "owned",
"assets": null,
"models": ["ChatGPT"],
"metrics": ["visibility_score", "average_position", "visibility_rank"],
"start_date": "2026-06-01",
"end_date": "2026-06-30",
"filter": null
},
"data": [
{
"asset": { "name": "Example Brand", "owned": true },
"date": "2026-06-01",
"visibility_score": 0.42,
"average_position": 3.2,
"visibility_rank": 1
}
]
}
Body
application/json
Was this page helpful?