> ## Documentation Index > Fetch the complete documentation index at: https://docs.peec.ai/llms.txt > Use this file to discover all available pages before exploring further. # List Products > List a project's products with headline metrics (mention_count, win_count, avg_position, avg_rating, visibility, share_of_voice) over the date range, filterable by category, merchant, brand, country, model channel, topic, and tag. Paginated. ## OpenAPI ````yaml https://api.peec.ai/customer/v1/openapi/json post /products/list openapi: 3.0.3 info: title: Peec AI Customer API description: Development documentation version: 1.0.0 contact: name: Peec AI Team email: support@peec.ai servers: - url: https://api.peec.ai/customer/v1 security: [] paths: /products/list: post: tags: - Products summary: List Products description: >- List a project's products with headline metrics (mention_count, win_count, avg_position, avg_rating, visibility, share_of_voice) over the date range, filterable by category, merchant, brand, country, model channel, topic, and tag. Paginated. operationId: postProductsList requestBody: required: true content: application/json: schema: type: object properties: project_id: description: Required if using a company api key example: or_f45b94ba-5e35-4982-93ed-285e72ee14eb type: string start_date: default: '2026-01-01' description: >- full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21 example: '2025-09-22' type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ end_date: default: '2026-01-01' description: >- full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21 example: '2025-09-22' type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ product_ids: description: Filter to these product ids. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ brand_ids: description: Filter to products of these brands (global_brand_id). type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ category_ids: description: >- Filter to products in any of these categories (OR — a product matches if it falls under at least one). Category ids roll up: selecting a parent also matches products in its descendant categories. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ merchant_ids: description: Filter to products sold through these merchants. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ country_codes: type: array items: type: string model_channel_ids: type: array items: type: string enum: - openai-0 - openai-1 - qwen-0 - openai-2 - perplexity-0 - perplexity-1 - google-0 - google-1 - google-2 - google-3 - google-4 - anthropic-0 - anthropic-1 - deepseek-0 - meta-0 - xai-0 - xai-1 - microsoft-0 - amazon-0 - mistral-0 - mistral-1 topic_ids: type: array items: type: string tag_ids: type: array items: type: string tag_operator: type: string enum: - and - or chat_scope: description: >- Which chats the visibility denominator counts: every in-scope chat ('all') or only product-gallery ('shopping') chats. Defaults to 'shopping'. type: string enum: - all - shopping source: type: string enum: - CATALOG - LLM search: type: string order_by: default: visibility type: string enum: - visibility - win_rate - avg_position - avg_rating - mention_count - name direction: default: desc type: string enum: - asc - desc limit: default: 1000 type: number minimum: 1 maximum: 10000 offset: default: 0 type: number minimum: 0 application/x-www-form-urlencoded: schema: type: object properties: project_id: description: Required if using a company api key example: or_f45b94ba-5e35-4982-93ed-285e72ee14eb type: string start_date: default: '2026-01-01' description: >- full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21 example: '2025-09-22' type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ end_date: default: '2026-01-01' description: >- full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21 example: '2025-09-22' type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ product_ids: description: Filter to these product ids. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ brand_ids: description: Filter to products of these brands (global_brand_id). type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ category_ids: description: >- Filter to products in any of these categories (OR — a product matches if it falls under at least one). Category ids roll up: selecting a parent also matches products in its descendant categories. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ merchant_ids: description: Filter to products sold through these merchants. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ country_codes: type: array items: type: string model_channel_ids: type: array items: type: string enum: - openai-0 - openai-1 - qwen-0 - openai-2 - perplexity-0 - perplexity-1 - google-0 - google-1 - google-2 - google-3 - google-4 - anthropic-0 - anthropic-1 - deepseek-0 - meta-0 - xai-0 - xai-1 - microsoft-0 - amazon-0 - mistral-0 - mistral-1 topic_ids: type: array items: type: string tag_ids: type: array items: type: string tag_operator: type: string enum: - and - or chat_scope: description: >- Which chats the visibility denominator counts: every in-scope chat ('all') or only product-gallery ('shopping') chats. Defaults to 'shopping'. type: string enum: - all - shopping source: type: string enum: - CATALOG - LLM search: type: string order_by: default: visibility type: string enum: - visibility - win_rate - avg_position - avg_rating - mention_count - name direction: default: desc type: string enum: - asc - desc limit: default: 1000 type: number minimum: 1 maximum: 10000 offset: default: 0 type: number minimum: 0 multipart/form-data: schema: type: object properties: project_id: description: Required if using a company api key example: or_f45b94ba-5e35-4982-93ed-285e72ee14eb type: string start_date: default: '2026-01-01' description: >- full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21 example: '2025-09-22' type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ end_date: default: '2026-01-01' description: >- full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21 example: '2025-09-22' type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ product_ids: description: Filter to these product ids. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ brand_ids: description: Filter to products of these brands (global_brand_id). type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ category_ids: description: >- Filter to products in any of these categories (OR — a product matches if it falls under at least one). Category ids roll up: selecting a parent also matches products in its descendant categories. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ merchant_ids: description: Filter to products sold through these merchants. type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ country_codes: type: array items: type: string model_channel_ids: type: array items: type: string enum: - openai-0 - openai-1 - qwen-0 - openai-2 - perplexity-0 - perplexity-1 - google-0 - google-1 - google-2 - google-3 - google-4 - anthropic-0 - anthropic-1 - deepseek-0 - meta-0 - xai-0 - xai-1 - microsoft-0 - amazon-0 - mistral-0 - mistral-1 topic_ids: type: array items: type: string tag_ids: type: array items: type: string tag_operator: type: string enum: - and - or chat_scope: description: >- Which chats the visibility denominator counts: every in-scope chat ('all') or only product-gallery ('shopping') chats. Defaults to 'shopping'. type: string enum: - all - shopping source: type: string enum: - CATALOG - LLM search: type: string order_by: default: visibility type: string enum: - visibility - win_rate - avg_position - avg_rating - mention_count - name direction: default: desc type: string enum: - asc - desc limit: default: 1000 type: number minimum: 1 maximum: 10000 offset: default: 0 type: number minimum: 0 responses: '200': description: Products with headline metrics over the date range content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string name: type: string brand: type: string source: type: string enum: - CATALOG - LLM image_url: nullable: true type: string price_range: type: object additionalProperties: type: object properties: min: type: number max: type: number required: - min - max categories: type: array items: type: string mention_count: type: number win_count: type: number avg_position: nullable: true type: number avg_rating: nullable: true type: number visibility: type: number share_of_voice: type: number required: - id - name - brand - source - image_url - price_range - categories - mention_count - win_count - avg_position - avg_rating - visibility - share_of_voice total_count: type: number required: - data - total_count description: Products with headline metrics over the date range security: - APIKeyHeader: [] - APIKeyQuery: [] - BearerAuth: [] components: securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key APIKeyQuery: type: apiKey in: query name: api_key BearerAuth: type: http scheme: bearer bearerFormat: JWT ````