Skip to main content
GET
Get Shopping Overview

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required
workspace_id
string
required
project_id
string
required

Query Parameters

brands
string[] | null

Restrict results to products whose catalogue brand matches one of these brand names.

product_catalog_ids
string[] | null

Restrict results to products linked to one of these product catalogue IDs.

date_start
string<date>
required

Start of the date range (YYYY-MM-DD)

date_end
string<date> | null

End of the date range (YYYY-MM-DD). Defaults to end of period containing date_start.

period
enum<string>
default:week

Aggregation period: day, week, month, or year

Available options:
day,
week,
month,
year
sources
enum<string>[] | null
Available options:
Bing,
BingAIO,
ChatGPT,
Perplexity,
Google,
GoogleAIO,
GoogleAIMode,
Claude,
Gemini,
AmazonRufus
thematics
string<uuid>[] | null

Filter by a list of thematic IDs

keyword_type
enum<string>[] | null

Filter by a list of keyword types

Available options:
Generic,
Brand
funnel_stages
enum<string>[] | null

Filter by a list of Funnel Stages

Available options:
ToFu,
MoFu,
BoFu
persona_ids
string[] | null

Filter by a list of persona IDs

topic_ids
string[] | null

Filter by a list of topic IDs

get_neutrals
boolean | null

Filter by to get results related to neutral prompts, without weakness or strength

strength_ids
string[] | null

Filter by a list of strength IDs

weakness_ids
string[] | null

Filter by a list of weakness IDs

Response

Successful Response

engines
enum<string>[]
required

Distinct search engines contributing to this row. A single engine for per-engine rows.

Available options:
Bing,
BingAIO,
ChatGPT,
Perplexity,
Google,
GoogleAIO,
GoogleAIMode,
Claude,
Gemini,
AmazonRufus
group
Group · object | null

Dimension grouping. Null for the global row; {'engine': source_name} for per-engine rows.

products_count
Metric · object | null

Number of distinct products in the selected period.

results_count
Metric · object | null

Total product rows across all tracked keywords and sources.

product_offers_count
Metric · object | null

Number of distinct merchant offers.

products_share_of_shelf
Metric · object | null

Share of total shopping result rows, expressed as a percentage. Computed as (results_count / total_results) × 100.

products_average_position
Metric · object | null

Average rank position across all appearances. Lower is better.

products_min_rating
Metric · object | null

Minimum star rating across all products.

products_max_rating
Metric · object | null

Maximum star rating across all products.

products_min_price
Metric · object | null

Minimum effective price across all products.

products_max_price
Metric · object | null

Maximum effective price across all products.

products_currency
string | null

Most frequently reported currency.

products_max_reviews_count
Metric · object | null

Maximum number of customer reviews across all distinct products.

merchants_count
Metric · object | null

Number of distinct merchants offering products.

brands_count
Metric · object | null

Number of distinct brands.