List Shopping Merchants
Aggregate shopping merchant metrics for the selected date range and filters. Each row represents a unique merchant and carries metrics such as share of shelf, average rank, price, rating, and brand coverage. All numeric metrics include a prev_value for the comparable previous period. Results are paginated; use page and page_size to navigate. Sorting is configurable via sort_column and sort_direction.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Restrict results to merchants whose products have a catalogue brand matching one of these names.
Restrict results to merchants whose products are linked to one of these catalogue IDs.
Restrict results to merchants whose name matches this search term.
Page number (1-based).
x >= 1Number of merchants per page.
1 <= x <= 1000Metric to sort by. Defaults to results_count (descending) when omitted.
results_count, products_count, products_average_position, products_price, products_rating, products_reviews_count, merchants_count, brands_count, products_share_of_shelf Sort direction. Defaults to DESC when omitted.
ASC, DESC 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