> ## 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.
# Brands
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`, or `prompt`.
* **Brand selection:** Select the brands with the `assets` parameter. Give one name or a list. `scope: "all"` ranks all brands. `scope: "owned"` (the default) returns only your brands. An `assets` selection returns one page and ignores `limit`.
* **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](/rest-api/reports/reports-v2-overview).
`POST /v2/reports/shopping/brands/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). Use the stream to get a
large result in one request.
```bash cURL theme={null}
curl -X POST https://api.tryprofound.com/v2/reports/shopping/brands \
-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": ["visibility_score", "average_position", "visibility_rank"],
"scope": "owned",
"limit": 10
}'
```
```json 200 theme={null}
{
"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
}
]
}
```
## OpenAPI
````yaml POST /v2/reports/shopping/brands
openapi: 3.1.0
info:
title: External API
version: 8a280fe080bc62612cfa4d9ac5672343e0a2f720
servers:
- url: https://api.tryprofound.com
description: Production Server
security: []
paths:
/v2/reports/shopping/brands:
post:
tags:
- Reports
- Reports
summary: Query Shopping Brands V2
operationId: query_shopping_brands_v2_v2_reports_shopping_brands_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShoppingBrandsV2Query'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ShoppingBrandsV2Response'
'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.brands({
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.brands(
category_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
end_date="end_date",
start_date="start_date",
)
print(response.data)
components:
schemas:
ShoppingBrandsV2Query:
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
- prompt
type: array
title: Group By
metrics:
anyOf:
- items:
type: string
enum:
- visibility_score
- average_position
- visibility_rank
type: array
- type: 'null'
title: Metrics
interval:
type: string
enum:
- day
- week
- month
title: Interval
default: day
scope:
type: string
enum:
- owned
- all
title: Scope
default: owned
assets:
anyOf:
- type: string
- items:
type: string
type: array
- type: 'null'
title: Assets
description: Restrict to these asset names (a name or list). Overrides `scope`.
filter:
anyOf:
- $ref: '#/components/schemas/FilterNode'
- type: 'null'
limit:
anyOf:
- type: integer
maximum: 50
exclusiveMinimum: 0
- type: 'null'
title: Limit
description: Page size for scope=all; default 10, max 50.
max_results:
anyOf:
- type: integer
maximum: 50000
exclusiveMinimum: 0
- type: 'null'
title: Max Results
description: >-
Stream endpoint only: cap the number of streamed rows (default:
all).
cursor:
anyOf:
- type: string
- type: 'null'
title: Cursor
additionalProperties: false
type: object
required:
- category_id
- start_date
- end_date
title: ShoppingBrandsV2Query
ShoppingBrandsV2Response:
properties:
info:
$ref: '#/components/schemas/ShoppingBrandsV2Info'
data:
items:
$ref: '#/components/schemas/ShoppingBrandRow'
type: array
title: Data
type: object
required:
- info
- data
title: ShoppingBrandsV2Response
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.
ShoppingBrandsV2Info:
properties:
total_results:
anyOf:
- type: integer
- type: 'null'
title: Total Results
description: Total assets matching the query before pagination.
count:
type: integer
title: Count
description: >-
Number of assets on this page. When grouped by `date`, `data` holds
one row per asset x bucket, so `len(data)` can exceed `count`.
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.
scope:
type: string
title: Scope
description: 'Asset scope: `all`, `owned`, or `custom` when `assets` was given.'
assets:
anyOf:
- type: string
- items:
type: string
type: array
- type: 'null'
title: Assets
description: Echoed `assets` selection; when set it overrides `scope`.
metrics:
items:
type: string
type: array
title: Metrics
description: Metrics returned per row.
additionalProperties: true
type: object
required:
- count
- models
- start_date
- end_date
- scope
- metrics
title: ShoppingBrandsV2Info
ShoppingBrandRow:
properties:
asset:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Asset
rank:
anyOf:
- type: integer
- type: 'null'
title: Rank
description: Asset visibility rank as a top-level field (ungrouped only).
date:
anyOf:
- type: string
- type: 'null'
title: Date
topic:
anyOf:
- $ref: '#/components/schemas/DimensionRef'
- type: 'null'
region:
anyOf:
- $ref: '#/components/schemas/DimensionRef'
- type: 'null'
prompt:
anyOf:
- $ref: '#/components/schemas/DimensionRef'
- type: 'null'
visibility_score:
anyOf:
- type: number
- type: 'null'
title: Visibility Score
average_position:
anyOf:
- type: number
- type: 'null'
title: Average Position
visibility_rank:
anyOf:
- type: integer
- type: 'null'
title: Visibility Rank
description: Asset visibility rank (present on grouped rows).
additionalProperties: true
type: object
title: ShoppingBrandRow
description: >-
One (asset x group) row. Group dims/metrics present depend on
`group_by`/`metrics`.
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
````