Get Shopping Overview
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Restrict results to products whose catalogue brand matches one of these brand names.
Restrict results to products linked to one of these product catalogue IDs.
Start of the date range (YYYY-MM-DD)
End of the date range (YYYY-MM-DD). Defaults to end of period containing date_start.
Aggregation period: day, week, month, or year
day, week, month, year Bing, BingAIO, ChatGPT, Perplexity, Google, GoogleAIO, GoogleAIMode, Claude, Gemini, AmazonRufus Filter by a list of thematic IDs
Filter by a list of keyword types
Generic, Brand Filter by a list of Funnel Stages
ToFu, MoFu, BoFu Filter by a list of persona IDs
Filter by a list of topic IDs
Filter by to get results related to neutral prompts, without weakness or strength
Filter by a list of strength IDs
Filter by a list of weakness IDs
Response
Successful Response
Distinct search engines contributing to this row. A single engine for per-engine rows.
Bing, BingAIO, ChatGPT, Perplexity, Google, GoogleAIO, GoogleAIMode, Claude, Gemini, AmazonRufus Dimension grouping. Null for the global row; {'engine': source_name} for per-engine rows.
Number of distinct products in the selected period.
Total product rows across all tracked keywords and sources.
Number of distinct merchant offers.
Share of total shopping result rows, expressed as a percentage. Computed as (results_count / total_results) × 100.
Average rank position across all appearances. Lower is better.
Minimum star rating across all products.
Maximum star rating across all products.
Minimum effective price across all products.
Maximum effective price across all products.
Most frequently reported currency.
Maximum number of customer reviews across all distinct products.
Number of distinct merchants offering products.
Number of distinct brands.