Products

Get Shopping Summary

Changed on Nov 3, 2026

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

post/products/summary

Request

Base URL
https://api.peec.ai/customer/v1
URL
https://api.peec.ai/customer/v1/products/summary
Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or HTTP bearer

Request body

project_idstring

Required if using a company api key

start_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

end_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

category_idsstring[]

Filter by shopping categories. Parent categories include descendants.

country_codesstring[]

model_channel_idsstring[]

topic_idsstring[]

tag_idsstring[]

tag_operator'and' | 'or'

previous_start_datestring 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_datestring date

End of the explicit comparison window. Provide together with previous_start_date, or omit both to auto-derive.

merchant_idsstring[]

Filter to products sold through these merchants.

brand_idsstring[]

Keep only products whose own brand is one of these.

product_idsstring[]

chat_scope'all' | 'shopping'

Which chats the visibility denominator counts: every in-scope chat ('all') or only product-gallery ('shopping') chats. Defaults to 'shopping'.

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "start_date": "2025-09-22",
  "end_date": "2025-09-22"
}

Response

Success

avg_visibilitynumber required

avg_visibility_deltanumber nullable required

avg_win_ratenumber required

avg_win_rate_deltanumber nullable required

avg_positionnumber nullable required

avg_position_deltanumber nullable required

Changes

Nov 3, 20269d774600c8eb Revision changes
- info
  added the new exa-0 enum value to the request property / (media type: application/json)
- info
  added the new exa-0 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new exa-0 enum value to the request property / (media type: multipart/form-data)
Nov 3, 20269fdffdff48a5 Revision changes
- info
  added the new anthropic-2 enum value to the request property / (media type: application/json)
- info
  added the new anthropic-2 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new anthropic-2 enum value to the request property / (media type: multipart/form-data)
- info
  added the new anthropic-3 enum value to the request property / (media type: application/json)
- info
  added the new anthropic-3 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new anthropic-3 enum value to the request property / (media type: multipart/form-data)
- info
  added the new baidu-0 enum value to the request property / (media type: application/json)
- info
  added the new baidu-0 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new baidu-0 enum value to the request property / (media type: multipart/form-data)
- info
  added the new google-5 enum value to the request property / (media type: application/json)
- info
  added the new google-5 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new google-5 enum value to the request property / (media type: multipart/form-data)
- info
  added the new meta-1 enum value to the request property / (media type: application/json)
- info
  added the new meta-1 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new meta-1 enum value to the request property / (media type: multipart/form-data)
- info
  added the new meta-2 enum value to the request property / (media type: application/json)
- info
  added the new meta-2 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new meta-2 enum value to the request property / (media type: multipart/form-data)
- info
  added the new naver-0 enum value to the request property / (media type: application/json)
- info
  added the new naver-0 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new naver-0 enum value to the request property / (media type: multipart/form-data)
- info
  added the new openai-3 enum value to the request property / (media type: application/json)
- info
  added the new openai-3 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new openai-3 enum value to the request property / (media type: multipart/form-data)
- info
  added the new openai-4 enum value to the request property / (media type: application/json)
- info
  added the new openai-4 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new openai-4 enum value to the request property / (media type: multipart/form-data)
- info
  added the new openai-5 enum value to the request property / (media type: application/json)
- info
  added the new openai-5 enum value to the request property / (media type: application/x-www-form-urlencoded)
- info
  added the new openai-5 enum value to the request property / (media type: multipart/form-data)

Operation history