> ## 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. # Get Shopping Attributes > The LLM-extracted attribute comparison grid for a product (scope=product) or the whole catalog (scope=overview), split by tab into characteristics, facts, and dimensions. Columns are competing brands (compare_by=brand) or competing products (compare_by=product, scope=product only). Deltas are computed against an explicit comparison window (previous_start_date/previous_end_date) or the equal-length window immediately before. ## OpenAPI ````yaml https://api.peec.ai/customer/v1/openapi/json post /products/attributes 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/attributes: post: tags: - Products summary: Get Shopping Attributes description: >- The LLM-extracted attribute comparison grid for a product (scope=product) or the whole catalog (scope=overview), split by tab into characteristics, facts, and dimensions. Columns are competing brands (compare_by=brand) or competing products (compare_by=product, scope=product only). Deltas are computed against an explicit comparison window (previous_start_date/previous_end_date) or the equal-length window immediately before. operationId: postProductsAttributes 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])))$ previous_start_date: description: >- 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]. 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])))$ previous_end_date: description: >- End of the explicit comparison window. Provide together with previous_start_date, or omit both to auto-derive. 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])))$ scope: default: product description: >- `product` compares one product (needs product_id); `overview` compares the whole catalog. type: string enum: - product - overview compare_by: default: brand description: >- Grid columns: competing `brand`s, or competing `product`s. `product` is only valid when scope=product. type: string enum: - brand - product tab: default: characteristics description: >- `characteristics` (qualitative values), `facts` (true/false), `dimensions` (ordinal ratings). type: string enum: - characteristics - facts - dimensions product_id: description: Required when scope=product. 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 category ids (from list_categories); selecting a parent also matches its descendants. e.g. ["3f2504e0-4f89-41d3-9a0c-0305e82c3301"]. 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: description: >- Filter to chats from these countries (ISO 3166-1 alpha-2), e.g. ["US", "GB"]. Omit for all countries. type: array items: type: string enum: - AE - AL - AM - AR - AT - AU - BA - BE - BG - BH - BO - BR - BS - BY - CA - CH - CL - CN - CO - CR - CY - CZ - DE - DK - DO - EC - EE - EG - ES - FI - FR - GB - GE - GH - GR - GT - HK - HN - HR - HU - ID - IE - IL - IN - IQ - IS - IT - JO - JP - KR - KW - LB - LI - LT - LU - LV - MA - MD - ME - MK - MN - MT - MX - MY - NG - NI - NL - 'NO' - NZ - OM - PK - PA - PE - PH - PL - PT - PY - PS - QA - RO - RS - SA - SE - SG - SI - SK - SV - TH - TN - TR - TW - UA - US - UY - VE - VN - ZA - AD - AF - AS - AZ - BB - BQ - CG - CI - CM - CW - DM - DZ - FO - GF - GP - JM - KG - KH - KI - KZ - LK - LR - LS - MW - NC - PG - TD - TF - UG - VU - ZW model_ids: description: >- Filter to these model ids (from list_models), e.g. ["gpt-4o"]. Omit for all models. type: array items: type: string enum: - chatgpt - microsoft-copilot - sonar-api - grok-api - gpt-4o-search - sonar - google-ai-overview - google-ai-mode - gemini-2-5-flash - gemini-3-1-flash-lite - gemini-3-1-flash-lite-search - claude-sonnet-4 - claude-sonnet-4-6 - claude-haiku-4-5 - grok-2-1212 - gpt-4o - qwen-3-6-plus - qwen-3-7-plus - gpt-3-5-turbo - gemini-1-5-flash - deepseek-r1 - deepseek-v4-pro - llama-3-3-70b-instruct - gpt-5-1 - gemini-2-5-flash-preview-05-20 - claude-3-5-sonnet - chatgpt-ui - gpt-5-search - gpt-5-6-luna - perplexity-ui - gemini-ui - grok-4 - grok-4-3 - grok-ui - microsoft-copilot-ui - claude-3-5-haiku - llama-3-1-sonar-small-128k-online - amazon-rufus - mistral-small-4 - mistral-medium-3-5 model_channel_ids: description: >- Filter to these model channel ids (from list_model_channels), e.g. ["openai-0"]. Omit for all engines. 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: description: >- Filter to prompts under any of these topic ids (from list_topics), e.g. ["to_a1b2c3"]. type: array items: type: string tag_ids: description: >- Filter to prompts carrying these tag ids (from list_tags; combine with tag_operator), e.g. ["tg_a1b2c3"]. type: array items: type: string tag_operator: description: >- Match prompts carrying any (or, default) or all (and) of tag_ids. type: string enum: - and - or search: description: >- Substring match on dimension name (and value, characteristics). type: string competitor_count: description: Grid columns; default 6. `0` disables competitor lookup. type: integer minimum: 0 maximum: 20 values_per_group: description: Characteristics tab only; default 12. type: integer minimum: 1 maximum: 50 limit: description: Page size over dimension groups. type: integer minimum: 1 maximum: 100 offset: description: Number of dimension groups to skip for pagination, e.g. 0. type: integer minimum: 0 maximum: 9007199254740991 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])))$ previous_start_date: description: >- 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]. 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])))$ previous_end_date: description: >- End of the explicit comparison window. Provide together with previous_start_date, or omit both to auto-derive. 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])))$ scope: default: product description: >- `product` compares one product (needs product_id); `overview` compares the whole catalog. type: string enum: - product - overview compare_by: default: brand description: >- Grid columns: competing `brand`s, or competing `product`s. `product` is only valid when scope=product. type: string enum: - brand - product tab: default: characteristics description: >- `characteristics` (qualitative values), `facts` (true/false), `dimensions` (ordinal ratings). type: string enum: - characteristics - facts - dimensions product_id: description: Required when scope=product. 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 category ids (from list_categories); selecting a parent also matches its descendants. e.g. ["3f2504e0-4f89-41d3-9a0c-0305e82c3301"]. 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: description: >- Filter to chats from these countries (ISO 3166-1 alpha-2), e.g. ["US", "GB"]. Omit for all countries. type: array items: type: string enum: - AE - AL - AM - AR - AT - AU - BA - BE - BG - BH - BO - BR - BS - BY - CA - CH - CL - CN - CO - CR - CY - CZ - DE - DK - DO - EC - EE - EG - ES - FI - FR - GB - GE - GH - GR - GT - HK - HN - HR - HU - ID - IE - IL - IN - IQ - IS - IT - JO - JP - KR - KW - LB - LI - LT - LU - LV - MA - MD - ME - MK - MN - MT - MX - MY - NG - NI - NL - 'NO' - NZ - OM - PK - PA - PE - PH - PL - PT - PY - PS - QA - RO - RS - SA - SE - SG - SI - SK - SV - TH - TN - TR - TW - UA - US - UY - VE - VN - ZA - AD - AF - AS - AZ - BB - BQ - CG - CI - CM - CW - DM - DZ - FO - GF - GP - JM - KG - KH - KI - KZ - LK - LR - LS - MW - NC - PG - TD - TF - UG - VU - ZW model_ids: description: >- Filter to these model ids (from list_models), e.g. ["gpt-4o"]. Omit for all models. type: array items: type: string enum: - chatgpt - microsoft-copilot - sonar-api - grok-api - gpt-4o-search - sonar - google-ai-overview - google-ai-mode - gemini-2-5-flash - gemini-3-1-flash-lite - gemini-3-1-flash-lite-search - claude-sonnet-4 - claude-sonnet-4-6 - claude-haiku-4-5 - grok-2-1212 - gpt-4o - qwen-3-6-plus - qwen-3-7-plus - gpt-3-5-turbo - gemini-1-5-flash - deepseek-r1 - deepseek-v4-pro - llama-3-3-70b-instruct - gpt-5-1 - gemini-2-5-flash-preview-05-20 - claude-3-5-sonnet - chatgpt-ui - gpt-5-search - gpt-5-6-luna - perplexity-ui - gemini-ui - grok-4 - grok-4-3 - grok-ui - microsoft-copilot-ui - claude-3-5-haiku - llama-3-1-sonar-small-128k-online - amazon-rufus - mistral-small-4 - mistral-medium-3-5 model_channel_ids: description: >- Filter to these model channel ids (from list_model_channels), e.g. ["openai-0"]. Omit for all engines. 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: description: >- Filter to prompts under any of these topic ids (from list_topics), e.g. ["to_a1b2c3"]. type: array items: type: string tag_ids: description: >- Filter to prompts carrying these tag ids (from list_tags; combine with tag_operator), e.g. ["tg_a1b2c3"]. type: array items: type: string tag_operator: description: >- Match prompts carrying any (or, default) or all (and) of tag_ids. type: string enum: - and - or search: description: >- Substring match on dimension name (and value, characteristics). type: string competitor_count: description: Grid columns; default 6. `0` disables competitor lookup. type: integer minimum: 0 maximum: 20 values_per_group: description: Characteristics tab only; default 12. type: integer minimum: 1 maximum: 50 limit: description: Page size over dimension groups. type: integer minimum: 1 maximum: 100 offset: description: Number of dimension groups to skip for pagination, e.g. 0. type: integer minimum: 0 maximum: 9007199254740991 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])))$ previous_start_date: description: >- 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]. 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])))$ previous_end_date: description: >- End of the explicit comparison window. Provide together with previous_start_date, or omit both to auto-derive. 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])))$ scope: default: product description: >- `product` compares one product (needs product_id); `overview` compares the whole catalog. type: string enum: - product - overview compare_by: default: brand description: >- Grid columns: competing `brand`s, or competing `product`s. `product` is only valid when scope=product. type: string enum: - brand - product tab: default: characteristics description: >- `characteristics` (qualitative values), `facts` (true/false), `dimensions` (ordinal ratings). type: string enum: - characteristics - facts - dimensions product_id: description: Required when scope=product. 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 category ids (from list_categories); selecting a parent also matches its descendants. e.g. ["3f2504e0-4f89-41d3-9a0c-0305e82c3301"]. 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: description: >- Filter to chats from these countries (ISO 3166-1 alpha-2), e.g. ["US", "GB"]. Omit for all countries. type: array items: type: string enum: - AE - AL - AM - AR - AT - AU - BA - BE - BG - BH - BO - BR - BS - BY - CA - CH - CL - CN - CO - CR - CY - CZ - DE - DK - DO - EC - EE - EG - ES - FI - FR - GB - GE - GH - GR - GT - HK - HN - HR - HU - ID - IE - IL - IN - IQ - IS - IT - JO - JP - KR - KW - LB - LI - LT - LU - LV - MA - MD - ME - MK - MN - MT - MX - MY - NG - NI - NL - 'NO' - NZ - OM - PK - PA - PE - PH - PL - PT - PY - PS - QA - RO - RS - SA - SE - SG - SI - SK - SV - TH - TN - TR - TW - UA - US - UY - VE - VN - ZA - AD - AF - AS - AZ - BB - BQ - CG - CI - CM - CW - DM - DZ - FO - GF - GP - JM - KG - KH - KI - KZ - LK - LR - LS - MW - NC - PG - TD - TF - UG - VU - ZW model_ids: description: >- Filter to these model ids (from list_models), e.g. ["gpt-4o"]. Omit for all models. type: array items: type: string enum: - chatgpt - microsoft-copilot - sonar-api - grok-api - gpt-4o-search - sonar - google-ai-overview - google-ai-mode - gemini-2-5-flash - gemini-3-1-flash-lite - gemini-3-1-flash-lite-search - claude-sonnet-4 - claude-sonnet-4-6 - claude-haiku-4-5 - grok-2-1212 - gpt-4o - qwen-3-6-plus - qwen-3-7-plus - gpt-3-5-turbo - gemini-1-5-flash - deepseek-r1 - deepseek-v4-pro - llama-3-3-70b-instruct - gpt-5-1 - gemini-2-5-flash-preview-05-20 - claude-3-5-sonnet - chatgpt-ui - gpt-5-search - gpt-5-6-luna - perplexity-ui - gemini-ui - grok-4 - grok-4-3 - grok-ui - microsoft-copilot-ui - claude-3-5-haiku - llama-3-1-sonar-small-128k-online - amazon-rufus - mistral-small-4 - mistral-medium-3-5 model_channel_ids: description: >- Filter to these model channel ids (from list_model_channels), e.g. ["openai-0"]. Omit for all engines. 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: description: >- Filter to prompts under any of these topic ids (from list_topics), e.g. ["to_a1b2c3"]. type: array items: type: string tag_ids: description: >- Filter to prompts carrying these tag ids (from list_tags; combine with tag_operator), e.g. ["tg_a1b2c3"]. type: array items: type: string tag_operator: description: >- Match prompts carrying any (or, default) or all (and) of tag_ids. type: string enum: - and - or search: description: >- Substring match on dimension name (and value, characteristics). type: string competitor_count: description: Grid columns; default 6. `0` disables competitor lookup. type: integer minimum: 0 maximum: 20 values_per_group: description: Characteristics tab only; default 12. type: integer minimum: 1 maximum: 50 limit: description: Page size over dimension groups. type: integer minimum: 1 maximum: 100 offset: description: Number of dimension groups to skip for pagination, e.g. 0. type: integer minimum: 0 maximum: 9007199254740991 responses: '200': description: Response for status 200 content: application/json: schema: oneOf: - type: object properties: competitors: type: array items: anyOf: - type: object properties: global_brand_id: 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)$ name: type: string domain: type: string mentions: type: number required: - global_brand_id - name - domain - mentions - type: object properties: product_id: 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)$ name: type: string brand_name: nullable: true type: string image_url: nullable: true type: string mentions: type: number required: - product_id - name - brand_name - image_url - mentions total_groups: type: number tab: type: string enum: - characteristics groups: type: array items: type: object properties: dimension_id: type: string name: type: string total_mentions: type: number total_mentions_delta: nullable: true type: number value_count: type: number values: type: array items: type: object properties: value: type: string mentions: type: number mentions_delta: nullable: true type: number competitor_mentions: type: array items: type: number required: - value - mentions - mentions_delta - competitor_mentions required: - dimension_id - name - total_mentions - total_mentions_delta - value_count - values required: - competitors - total_groups - tab - groups - type: object properties: competitors: type: array items: anyOf: - type: object properties: global_brand_id: 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)$ name: type: string domain: type: string mentions: type: number required: - global_brand_id - name - domain - mentions - type: object properties: product_id: 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)$ name: type: string brand_name: nullable: true type: string image_url: nullable: true type: string mentions: type: number required: - product_id - name - brand_name - image_url - mentions total_groups: type: number tab: type: string enum: - facts groups: type: array items: oneOf: - type: object properties: dimension_id: type: string name: type: string total_mentions: type: number total_mentions_delta: nullable: true type: number value_type: type: string enum: - BOOLEAN unit: nullable: true type: string own: type: object properties: true_count: type: number false_count: type: number unrecognized_count: type: number required: - true_count - false_count - unrecognized_count competitor_values: type: array items: type: object properties: true_count: type: number false_count: type: number unrecognized_count: type: number required: - true_count - false_count - unrecognized_count required: - dimension_id - name - total_mentions - total_mentions_delta - value_type - unit - own - competitor_values - type: object properties: dimension_id: type: string name: type: string total_mentions: type: number total_mentions_delta: nullable: true type: number value_type: type: string enum: - NUMERIC unit: nullable: true type: string own: nullable: true type: object properties: min: type: number max: type: number average: type: number median: type: number required: - min - max - average - median competitor_values: type: array items: nullable: true type: object properties: min: type: number max: type: number average: type: number median: type: number required: - min - max - average - median required: - dimension_id - name - total_mentions - total_mentions_delta - value_type - unit - own - competitor_values required: - competitors - total_groups - tab - groups - type: object properties: competitors: type: array items: anyOf: - type: object properties: global_brand_id: 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)$ name: type: string domain: type: string mentions: type: number required: - global_brand_id - name - domain - mentions - type: object properties: product_id: 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)$ name: type: string brand_name: nullable: true type: string image_url: nullable: true type: string mentions: type: number required: - product_id - name - brand_name - image_url - mentions total_groups: type: number tab: type: string enum: - dimensions groups: type: array items: type: object properties: dimension_id: type: string name: type: string total_mentions: type: number total_mentions_delta: nullable: true type: number own: nullable: true type: object properties: min: type: number max: type: number average: type: number median: type: number required: - min - max - average - median competitor_values: type: array items: nullable: true type: object properties: min: type: number max: type: number average: type: number median: type: number required: - min - max - average - median required: - dimension_id - name - total_mentions - total_mentions_delta - own - competitor_values required: - competitors - total_groups - tab - groups 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 ````