---
title: "Get Shopping Summary"
method: POST
path: "/products/summary"
tags: ["Products"]
---

# Get Shopping Summary

`POST /products/summary`

Return aggregate shopping metrics over a date range. Delta fields compare against an explicit previous window or the auto-derived previous period.

## Request body

- object
  - `project_id` string — Required if using a company api key
  - `start_date` string, date — full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
  - `end_date` string, date — full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
  - `category_ids` string[] — Filter by shopping categories. Parent categories include descendants.
  - `country_codes` string[]
  - `model_channel_ids` string[]
  - `topic_ids` string[]
  - `tag_ids` string[]
  - `tag_operator` 'and' | 'or'
  - `previous_start_date` string, date — Start of an explicit comparison window for deltas. Provide together with previous_end_date, or omit both to auto-derive an equal-length window immediately before [start_date, end_date].
  - `previous_end_date` string, date — End of the explicit comparison window. Provide together with previous_start_date, or omit both to auto-derive.
  - `merchant_ids` string[] — Filter to products sold through these merchants.
  - `brand_ids` string[] — Keep only products whose own brand is one of these.
  - `product_ids` string[]
  - `chat_scope` 'all' | 'shopping' — Which chats the visibility denominator counts: every in-scope chat ('all') or only product-gallery ('shopping') chats. Defaults to 'shopping'.

## Response `200`

Success

- object — Success
  - `avg_visibility` number, required
  - `avg_visibility_delta` number, nullable, required
  - `avg_win_rate` number, required
  - `avg_win_rate_delta` number, nullable, required
  - `avg_position` number, nullable, required
  - `avg_position_delta` number, nullable, required

---

[API](https://skmtc.net/peec/apis/peec-ai-customer-api.md) · [All operations](https://skmtc.net/peec/apis/peec-ai-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peec/peec-ai-customer-api/revisions/92840a1bffa7/schema)