The report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a prompt_id filter to narrow it.
Aggregation Formulas
When aggregating results across multiple rows/dimensions, use the following formulas:
filters are pre-aggregation row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Note that brand_id in filters shrinks share_of_voice’s denominator too — so filtering to one brand collapses SoV to 1.0. Use having for brand_id if you want SoV preserved.
having are post-aggregation row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do not shrink ratio-metric denominators. Filtering {field: "brand_id", values: [X]} here returns only brand X’s row, but share_of_voice still divides X’s mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id.
Population fields (model_id etc.) are also allowed in having but require the matching value in dimensions so the column appears in GROUP BY; otherwise the request is rejected.
When dimensions are requested, the share_of_voice denominator follows the same grouping as the numerator. Requesting prompt_id as a dimension produces per-(brand × prompt) rows whose share_of_voice is the brand’s mentions in that prompt divided by all brands’ mentions in that prompt.
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].
Pre-aggregation row filters (applied as WHERE before grouping). Shrinks both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Filtering by brand_id here also shrinks share_of_voice's denominator — so SoV collapses to 1.0 when scoping to a single brand. If you want SoV preserved (X's share against all in-scope brands), put brand_id in having instead. Multiple filters are AND'd.
Post-aggregation row filters (applied as HAVING after grouping). Selects which aggregated rows are returned without shrinking ratio-metric denominators. Multiple filters are AND'd together.
Population fields — model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id — and brand_id take {field, operator, values} with operator in or not_in. Population fields require the matching value in dimensions so the column appears in GROUP BY.
Metric fields — visibility, share_of_voice, win_rate, sentiment, position — take {field, operator, value} with operator gt, gte, lt or lte, and need no matching dimensions entry. Each compares against the metric in the unit this endpoint returns it: visibility, share_of_voice and win_rate as a 0-1 ratio, sentiment as a 0-100 score, position as a rank where 1 is best. Values are validated against that unit, so a percentage where a ratio belongs is rejected rather than silently matching nothing. Two predicates on one field make a range; stating the same edge of a field twice, or a range no row could satisfy, is rejected. A row whose metric is undefined — no position or sentiment samples in the window — matches neither.
A metric predicate tests whichever row the grouping produces, so the same predicate asks a different question at each grouping: with dimensions: ["prompt_id"] it selects the prompts that individually pass, and with no dimensions it tests the brand's rolled-up totals.
Legacy comparison switch. When true without explicit comparison dates, each row gains a previous object computed over the adjacent equal-length window. Supplying previous_start_date and previous_end_date enables comparison over that exact window without this flag.
Response
200 - application/json
Success
Success
data
object[]
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Peec.ai Docs","colors":{"primary":"#000000","light":"#ffffff","dark":"#000000"},"logo":{"light":"https://mintcdn.com/peecai-b61a1960/BVQQX1wLWNjFOa_V/images/logo-white.svg?fit=max\u0026auto=format\u0026n=BVQQX1wLWNjFOa_V\u0026q=85\u0026s=5d3f30a498a2c71a875226adc1a9de52","dark":"https://mintcdn.com/peecai-b61a1960/AOqHu6-lYtIlVNI6/logo/PeecLogoWhite.png?fit=max\u0026auto=format\u0026n=AOqHu6-lYtIlVNI6\u0026q=85\u0026s=e68e57c3a6bd47ff8081386db20cc746"},"favicon":"https://mintcdn.com/peecai-b61a1960/ZPzAGzjR7kY6FmUI/favicon.ico?fit=max\u0026auto=format\u0026n=ZPzAGzjR7kY6FmUI\u0026q=85\u0026s=d8aae543639fa5a02a8634eedd5cfb2f","navbar":{"links":[{"href":"mailto:support@peec.ai","label":"Contact"},{"href":"https://peec.ai","label":"Website"},{"href":"https://app.peec.ai/sign-in","label":"Log In"}]},"footer":{"socials":{"website":"https://peec.ai","linkedin":"https://www.linkedin.com/company/peec-ai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"peecai-b61a1960","hasAudioNarration":false,"actualSubdomain":"peecai-b61a1960","customDomains":["docs.peec.ai"],"gitSource":{"type":"github","owner":"peec-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00631ec192f7e4f7752276","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Customer API","count":123},{"language":"default","tag":"Endpoints","count":117},{"language":"default","tag":"Project","count":62},{"language":"default","tag":"Research","count":52},{"language":"default","tag":"Documentation","count":44},{"language":"default","tag":"Brand Perception","count":17},{"language":"default","tag":"Products","count":17},{"language":"default","tag":"Interpret Your Results","count":9},{"language":"default","tag":"Agent Analytics","count":9},{"language":"default","tag":"Overview","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/reports/get-brands-report","slug":"/api-reference/reports/get-brands-report","pageMetadata":{"title":"Get Brands Report","description":"Get a report on Brands.\n\n## Prompt Scope\n\nThe report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a `prompt_id` filter to narrow it.\n\n## Aggregation Formulas\n\nWhen aggregating results across multiple rows/dimensions, use the following formulas:\n\n- **sentiment**: `((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100`\n- **position**: `sum(position_sum) / sum(position_count)`\n- **visibility**: `sum(visibility_count) / sum(visibility_total)`\n- **share_of_voice**: `mention_count / sum(mention_count)`\n- **win_rate**: `sum(win_count) / sum(visibility_total)`\n\n## `filters` vs `having`\n\n`filters` are **pre-aggregation** row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`. Note that `brand_id` in `filters` shrinks `share_of_voice`'s denominator too — so filtering to one brand collapses SoV to 1.0. Use `having` for `brand_id` if you want SoV preserved.\n\n`having` are **post-aggregation** row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do **not** shrink ratio-metric denominators. Filtering `{field: \"brand_id\", values: [X]}` here returns only brand X's row, but `share_of_voice` still divides X's mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`.\n\nPopulation fields (`model_id` etc.) are also allowed in `having` but require the matching value in `dimensions` so the column appears in GROUP BY; otherwise the request is rejected.\n\nWhen `dimensions` are requested, the `share_of_voice` denominator follows the same grouping as the numerator. Requesting `prompt_id` as a dimension produces per-(brand × prompt) rows whose `share_of_voice` is the brand's mentions in that prompt divided by all brands' mentions in that prompt.","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /reports/brands","href":"/api-reference/reports/get-brands-report","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h2: \"h2\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Get a report on Brands.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Prompt Scope\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a \", _jsx(_components.code, {\n children: \"prompt_id\"\n }), \" filter to narrow it.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Aggregation Formulas\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"When aggregating results across multiple rows/dimensions, use the following formulas:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"sentiment\"\n }), \": \", _jsx(_components.code, {\n children: \"((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"position\"\n }), \": \", _jsx(_components.code, {\n children: \"sum(position_sum) / sum(position_count)\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"visibility\"\n }), \": \", _jsx(_components.code, {\n children: \"sum(visibility_count) / sum(visibility_total)\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"share_of_voice\"\n }), \": \", _jsx(_components.code, {\n children: \"mention_count / sum(mention_count)\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"win_rate\"\n }), \": \", _jsx(_components.code, {\n children: \"sum(win_count) / sum(visibility_total)\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.h2, {\n children: [_jsx(_components.code, {\n children: \"filters\"\n }), \" vs \", _jsx(_components.code, {\n children: \"having\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"filters\"\n }), \" are \", _jsx(_components.strong, {\n children: \"pre-aggregation\"\n }), \" row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: \", _jsx(_components.code, {\n children: \"model_id\"\n }), \" (deprecated), \", _jsx(_components.code, {\n children: \"model_channel_id\"\n }), \", \", _jsx(_components.code, {\n children: \"country_code\"\n }), \", \", _jsx(_components.code, {\n children: \"prompt_id\"\n }), \", \", _jsx(_components.code, {\n children: \"tag_id\"\n }), \", \", _jsx(_components.code, {\n children: \"topic_id\"\n }), \", \", _jsx(_components.code, {\n children: \"chat_id\"\n }), \", \", _jsx(_components.code, {\n children: \"brand_id\"\n }), \". Note that \", _jsx(_components.code, {\n children: \"brand_id\"\n }), \" in \", _jsx(_components.code, {\n children: \"filters\"\n }), \" shrinks \", _jsx(_components.code, {\n children: \"share_of_voice\"\n }), \"’s denominator too — so filtering to one brand collapses SoV to 1.0. Use \", _jsx(_components.code, {\n children: \"having\"\n }), \" for \", _jsx(_components.code, {\n children: \"brand_id\"\n }), \" if you want SoV preserved.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"having\"\n }), \" are \", _jsx(_components.strong, {\n children: \"post-aggregation\"\n }), \" row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do \", _jsx(_components.strong, {\n children: \"not\"\n }), \" shrink ratio-metric denominators. Filtering \", _jsx(_components.code, {\n children: \"{field: \\\"brand_id\\\", values: [X]}\"\n }), \" here returns only brand X’s row, but \", _jsx(_components.code, {\n children: \"share_of_voice\"\n }), \" still divides X’s mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: \", _jsx(_components.code, {\n children: \"model_id\"\n }), \" (deprecated), \", _jsx(_components.code, {\n children: \"model_channel_id\"\n }), \", \", _jsx(_components.code, {\n children: \"country_code\"\n }), \", \", _jsx(_components.code, {\n children: \"prompt_id\"\n }), \", \", _jsx(_components.code, {\n children: \"tag_id\"\n }), \", \", _jsx(_components.code, {\n children: \"topic_id\"\n }), \", \", _jsx(_components.code, {\n children: \"chat_id\"\n }), \", \", _jsx(_components.code, {\n children: \"brand_id\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Population fields (\", _jsx(_components.code, {\n children: \"model_id\"\n }), \" etc.) are also allowed in \", _jsx(_components.code, {\n children: \"having\"\n }), \" but require the matching value in \", _jsx(_components.code, {\n children: \"dimensions\"\n }), \" so the column appears in GROUP BY; otherwise the request is rejected.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"When \", _jsx(_components.code, {\n children: \"dimensions\"\n }), \" are requested, the \", _jsx(_components.code, {\n children: \"share_of_voice\"\n }), \" denominator follows the same grouping as the numerator. Requesting \", _jsx(_components.code, {\n children: \"prompt_id\"\n }), \" as a dimension produces per-(brand × prompt) rows whose \", _jsx(_components.code, {\n children: \"share_of_voice\"\n }), \" is the brand’s mentions in that prompt divided by all brands’ mentions in that prompt.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Brands Report","description":"Get a report on Brands.\n\n## Prompt Scope\n\nThe report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a `prompt_id` filter to narrow it.\n\n## Aggregation Formulas\n\nWhen aggregating results across multiple rows/dimensions, use the following formulas:\n\n- **sentiment**: `((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100`\n- **position**: `sum(position_sum) / sum(position_count)`\n- **visibility**: `sum(visibility_count) / sum(visibility_total)`\n- **share_of_voice**: `mention_count / sum(mention_count)`\n- **win_rate**: `sum(win_count) / sum(visibility_total)`\n\n## `filters` vs `having`\n\n`filters` are **pre-aggregation** row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`. Note that `brand_id` in `filters` shrinks `share_of_voice`'s denominator too — so filtering to one brand collapses SoV to 1.0. Use `having` for `brand_id` if you want SoV preserved.\n\n`having` are **post-aggregation** row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do **not** shrink ratio-metric denominators. Filtering `{field: \"brand_id\", values: [X]}` here returns only brand X's row, but `share_of_voice` still divides X's mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`.\n\nPopulation fields (`model_id` etc.) are also allowed in `having` but require the matching value in `dimensions` so the column appears in GROUP BY; otherwise the request is rejected.\n\nWhen `dimensions` are requested, the `share_of_voice` denominator follows the same grouping as the numerator. Requesting `prompt_id` as a dimension produces per-(brand × prompt) rows whose `share_of_voice` is the brand's mentions in that prompt divided by all brands' mentions in that prompt.","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /reports/brands","href":"/api-reference/reports/get-brands-report","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["1e12cd59-daf1-4d22-8dbc-27007aeebea3","e861c293-20d1-4d41-9646-eb2d25b49302"],"summary":"Get Brands Report","description":"Get a report on Brands.\n\n## Prompt Scope\n\nThe report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a `prompt_id` filter to narrow it.\n\n## Aggregation Formulas\n\nWhen aggregating results across multiple rows/dimensions, use the following formulas:\n\n- **sentiment**: `((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100`\n- **position**: `sum(position_sum) / sum(position_count)`\n- **visibility**: `sum(visibility_count) / sum(visibility_total)`\n- **share_of_voice**: `mention_count / sum(mention_count)`\n- **win_rate**: `sum(win_count) / sum(visibility_total)`\n\n## `filters` vs `having`\n\n`filters` are **pre-aggregation** row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`. Note that `brand_id` in `filters` shrinks `share_of_voice`'s denominator too — so filtering to one brand collapses SoV to 1.0. Use `having` for `brand_id` if you want SoV preserved.\n\n`having` are **post-aggregation** row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do **not** shrink ratio-metric denominators. Filtering `{field: \"brand_id\", values: [X]}` here returns only brand X's row, but `share_of_voice` still divides X's mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`.\n\nPopulation fields (`model_id` etc.) are also allowed in `having` but require the matching value in `dimensions` so the column appears in GROUP BY; otherwise the request is rejected.\n\nWhen `dimensions` are requested, the `share_of_voice` denominator follows the same grouping as the numerator. Requesting `prompt_id` as a dimension produces per-(brand × prompt) rows whose `share_of_voice` is the brand's mentions in that prompt divided by all brands' mentions in that prompt.","tags":["Reports"],"parameters":["33dce485-4745-4033-babc-fcc51695dd4d"],"requestBody":"df6200e2-e0d0-43c8-a639-7176151e99a3","responses":{"200":"7f9bf72b-3620-4b54-b085-222c71c88b4c"},"operationId":"postReportsBrands","method":"post","type":"path","servers":["c8fa48c8-ee13-4560-993f-c6e90092f1c4"],"path":"/reports/brands","baseUrlOptions":["https://api.peec.ai/customer/v1"],"title":"Get Brands Report","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"33dce485-4745-4033-babc-fcc51695dd4d":{"name":"project_id","in":"query","required":false,"schema":{"description":"Required if using a company api key","example":"or_f45b94ba-5e35-4982-93ed-285e72ee14eb","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}}},"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","uniqueKey":"project_id","typeLabel":"string"},"limit":{"default":1000,"type":"integer","minimum":1,"maximum":500000,"uniqueKey":"limit","typeLabel":"integer"},"offset":{"default":0,"type":"integer","minimum":0,"maximum":500000,"uniqueKey":"offset","typeLabel":"integer"},"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])))$","uniqueKey":"start_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"end_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"previous_start_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"previous_end_date","typeLabel":"string\u003cdate>"},"dimensions":{"example":["tag_id","model_id"],"description":"Dimensions to break down the report by.","type":"array","items":{"type":"string","enum":["prompt_id","model_id","model_channel_id","tag_id","topic_id","date","week","month","country_code","chat_id"],"uniqueKey":"dimensions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"dimensions","typeLabel":"enum\u003cstring>[]"},"filters":{"description":"Pre-aggregation row filters (applied as WHERE before grouping). Shrinks both the numerator and the denominator of ratio metrics. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`. Filtering by `brand_id` here also shrinks `share_of_voice`'s denominator — so SoV collapses to 1.0 when scoping to a single brand. If you want SoV preserved (X's share against all in-scope brands), put `brand_id` in `having` instead. Multiple filters are AND'd.","example":[{"field":"model_id","operator":"in","values":["gpt-4o-search"]}],"type":"array","items":{"oneOf":[{"type":"object","description":"Deprecated: use model_channel_id filter instead","required":["field","operator","values"],"deprecated":true,"properties":{"field":{"type":"string","enum":["model_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","enum":["chatgpt-scraper","gpt-4o","gpt-4o-search","gpt-3.5-turbo","llama-sonar","perplexity-scraper","sonar","gemini-2.5-flash","gemini-3.1-flash-lite-search","gemini-scraper","google-ai-overview-scraper","google-ai-mode-scraper","llama-3.3-70b-instruct","deepseek-r1","deepseek-v4-pro","claude-3.5-haiku","claude-haiku-4.5","claude-sonnet-4","grok-scraper","microsoft-copilot-scraper","copilot-search-scraper","chatgpt-logged-in-scraper","grok-4","grok-4.3","grok-4.6","qwen-3-6-plus","qwen-3-7-plus","amazon-rufus-scraper","mistral-small-4","mistral-medium-3-5","muse-spark-1.2","muse-spark-1.3","muse-wonder-1.0","gemini-4-argon","naver-ai-briefing-scraper","claude-opus-5","claude-fable-5.1","gpt-6-astra","gpt-5.6-sol","gpt-5.6-terra","ernie-scraper","doubao-scraper","exa-answer","parallel"],"uniqueKey":"filters.items.[INDEX].oneOf.0.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["model_channel_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","google-5","anthropic-0","anthropic-1","anthropic-2","anthropic-3","deepseek-0","meta-0","meta-1","meta-2","xai-0","xai-1","microsoft-0","amazon-0","mistral-0","mistral-1","naver-0","openai-3","openai-4","openai-5","baidu-0","exa-0","parallel-0","microsoft-1","openai-6","doubao-0"],"uniqueKey":"filters.items.[INDEX].oneOf.1.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.2.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["topic_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.3.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["prompt_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.4.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["country_code"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","PR","PS","QA","RO","RS","SA","SE","SG","SI","SK","SR","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"],"uniqueKey":"filters.items.[INDEX].oneOf.5.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["chat_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.6.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["brand_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.7.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["shopping_category_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.8.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.9.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.9","typeLabel":"object"}],"uniqueKey":"filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"filters","typeLabel":"object[]"},"having":{"description":"Post-aggregation row filters (applied as HAVING after grouping). Selects which aggregated rows are returned without shrinking ratio-metric denominators. Multiple filters are AND'd together.\n\nPopulation fields — `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id` — and `brand_id` take `{field, operator, values}` with operator `in` or `not_in`. Population fields require the matching value in `dimensions` so the column appears in GROUP BY.\n\nMetric fields — `visibility`, `share_of_voice`, `win_rate`, `sentiment`, `position` — take `{field, operator, value}` with operator `gt`, `gte`, `lt` or `lte`, and need no matching `dimensions` entry. Each compares against the metric in the unit this endpoint returns it: `visibility`, `share_of_voice` and `win_rate` as a 0-1 ratio, `sentiment` as a 0-100 score, `position` as a rank where 1 is best. Values are validated against that unit, so a percentage where a ratio belongs is rejected rather than silently matching nothing. Two predicates on one field make a range; stating the same edge of a field twice, or a range no row could satisfy, is rejected. A row whose metric is undefined — no position or sentiment samples in the window — matches neither.\n\nA metric predicate tests whichever row the grouping produces, so the same predicate asks a different question at each grouping: with `dimensions: [\"prompt_id\"]` it selects the prompts that individually pass, and with no dimensions it tests the brand's rolled-up totals.","example":[{"field":"brand_id","operator":"in","values":["kw_abc123"]},{"field":"visibility","operator":"gte","value":0.1},{"field":"visibility","operator":"lte","value":0.9}],"type":"array","items":{"oneOf":[{"type":"object","description":"Deprecated: use model_channel_id filter instead","required":["field","operator","values"],"deprecated":true,"properties":{"field":{"type":"string","enum":["model_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","enum":["chatgpt-scraper","gpt-4o","gpt-4o-search","gpt-3.5-turbo","llama-sonar","perplexity-scraper","sonar","gemini-2.5-flash","gemini-3.1-flash-lite-search","gemini-scraper","google-ai-overview-scraper","google-ai-mode-scraper","llama-3.3-70b-instruct","deepseek-r1","deepseek-v4-pro","claude-3.5-haiku","claude-haiku-4.5","claude-sonnet-4","grok-scraper","microsoft-copilot-scraper","copilot-search-scraper","chatgpt-logged-in-scraper","grok-4","grok-4.3","grok-4.6","qwen-3-6-plus","qwen-3-7-plus","amazon-rufus-scraper","mistral-small-4","mistral-medium-3-5","muse-spark-1.2","muse-spark-1.3","muse-wonder-1.0","gemini-4-argon","naver-ai-briefing-scraper","claude-opus-5","claude-fable-5.1","gpt-6-astra","gpt-5.6-sol","gpt-5.6-terra","ernie-scraper","doubao-scraper","exa-answer","parallel"],"uniqueKey":"having.items.[INDEX].oneOf.0.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["model_channel_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","google-5","anthropic-0","anthropic-1","anthropic-2","anthropic-3","deepseek-0","meta-0","meta-1","meta-2","xai-0","xai-1","microsoft-0","amazon-0","mistral-0","mistral-1","naver-0","openai-3","openai-4","openai-5","baidu-0","exa-0","parallel-0","microsoft-1","openai-6","doubao-0"],"uniqueKey":"having.items.[INDEX].oneOf.1.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.2.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["topic_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.3.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["prompt_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.4.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["country_code"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","PR","PS","QA","RO","RS","SA","SE","SG","SI","SK","SR","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"],"uniqueKey":"having.items.[INDEX].oneOf.5.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["chat_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.6.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["brand_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.7.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","description":"Filters aggregated rows on a computed metric, in the same unit the report returns it: visibility, share_of_voice and win_rate as a 0-1 ratio, sentiment as a 0-100 score, position as a rank where 1 is best. Each field's value is validated against that unit, so a percentage where a ratio belongs is rejected rather than matching nothing. Combine two predicates for a range; stating the same bound twice, or a range no row can satisfy, is rejected. A row whose metric is undefined — no position or sentiment samples in the window — matches neither.","required":["field","operator","value"],"example":{"field":"visibility","operator":"gte","value":0.5},"properties":{"field":{"type":"string","enum":["visibility","share_of_voice","sentiment","position","win_rate"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.value","typeLabel":"number"}},"uniqueKey":"having.items.[INDEX].oneOf.8","typeLabel":"object"}],"uniqueKey":"having.items.[INDEX]","typeLabel":"object"},"uniqueKey":"having","typeLabel":"object[]"},"order_by":{"description":"Sort results by one or more fields. Multiple entries create a multi-key sort. Direction defaults to desc. When omitted, a default ordering is applied.","example":[{"field":"visibility","direction":"desc"}],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["visibility","visibility_count","mention_count","sentiment","position","share_of_voice","win_rate","date","week","month"],"isRequired":true,"uniqueKey":"order_by.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"direction":{"default":"desc","type":"string","enum":["asc","desc"],"uniqueKey":"order_by.items.[INDEX].direction","typeLabel":"enum\u003cstring>"}},"required":["field"],"uniqueKey":"order_by.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order_by","typeLabel":"object[]"},"include_previous_period":{"description":"Legacy comparison switch. When true without explicit comparison dates, each row gains a `previous` object computed over the adjacent equal-length window. Supplying previous_start_date and previous_end_date enables comparison over that exact window without this flag.","type":"boolean","uniqueKey":"include_previous_period","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"project_id":"or_f45b94ba-5e35-4982-93ed-285e72ee14eb","limit":1000,"offset":0,"start_date":"2025-09-22","end_date":"2025-09-22","previous_start_date":"2023-12-25","previous_end_date":"2023-12-25","dimensions":["tag_id","model_id"],"filters":[{"field":"model_id","operator":"in","values":["gpt-4o-search"]}],"having":[{"field":"brand_id","operator":"in","values":["kw_abc123"]},{"field":"visibility","operator":"gte","value":0.1},{"field":"visibility","operator":"lte","value":0.9}],"order_by":[{"field":"visibility","direction":"desc"}],"include_previous_period":true}}},"exampleType":"generated"},"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","uniqueKey":"project_id","typeLabel":"string"},"limit":{"default":1000,"type":"integer","minimum":1,"maximum":500000,"uniqueKey":"limit","typeLabel":"integer"},"offset":{"default":0,"type":"integer","minimum":0,"maximum":500000,"uniqueKey":"offset","typeLabel":"integer"},"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])))$","uniqueKey":"start_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"end_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"previous_start_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"previous_end_date","typeLabel":"string\u003cdate>"},"dimensions":{"example":["tag_id","model_id"],"description":"Dimensions to break down the report by.","type":"array","items":{"type":"string","enum":["prompt_id","model_id","model_channel_id","tag_id","topic_id","date","week","month","country_code","chat_id"],"uniqueKey":"dimensions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"dimensions","typeLabel":"enum\u003cstring>[]"},"filters":{"description":"Pre-aggregation row filters (applied as WHERE before grouping). Shrinks both the numerator and the denominator of ratio metrics. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`. Filtering by `brand_id` here also shrinks `share_of_voice`'s denominator — so SoV collapses to 1.0 when scoping to a single brand. If you want SoV preserved (X's share against all in-scope brands), put `brand_id` in `having` instead. Multiple filters are AND'd.","example":[{"field":"model_id","operator":"in","values":["gpt-4o-search"]}],"type":"array","items":{"oneOf":[{"type":"object","description":"Deprecated: use model_channel_id filter instead","required":["field","operator","values"],"deprecated":true,"properties":{"field":{"type":"string","enum":["model_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","enum":["chatgpt-scraper","gpt-4o","gpt-4o-search","gpt-3.5-turbo","llama-sonar","perplexity-scraper","sonar","gemini-2.5-flash","gemini-3.1-flash-lite-search","gemini-scraper","google-ai-overview-scraper","google-ai-mode-scraper","llama-3.3-70b-instruct","deepseek-r1","deepseek-v4-pro","claude-3.5-haiku","claude-haiku-4.5","claude-sonnet-4","grok-scraper","microsoft-copilot-scraper","copilot-search-scraper","chatgpt-logged-in-scraper","grok-4","grok-4.3","grok-4.6","qwen-3-6-plus","qwen-3-7-plus","amazon-rufus-scraper","mistral-small-4","mistral-medium-3-5","muse-spark-1.2","muse-spark-1.3","muse-wonder-1.0","gemini-4-argon","naver-ai-briefing-scraper","claude-opus-5","claude-fable-5.1","gpt-6-astra","gpt-5.6-sol","gpt-5.6-terra","ernie-scraper","doubao-scraper","exa-answer","parallel"],"uniqueKey":"filters.items.[INDEX].oneOf.0.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["model_channel_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","google-5","anthropic-0","anthropic-1","anthropic-2","anthropic-3","deepseek-0","meta-0","meta-1","meta-2","xai-0","xai-1","microsoft-0","amazon-0","mistral-0","mistral-1","naver-0","openai-3","openai-4","openai-5","baidu-0","exa-0","parallel-0","microsoft-1","openai-6","doubao-0"],"uniqueKey":"filters.items.[INDEX].oneOf.1.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.2.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["topic_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.3.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["prompt_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.4.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["country_code"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","PR","PS","QA","RO","RS","SA","SE","SG","SI","SK","SR","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"],"uniqueKey":"filters.items.[INDEX].oneOf.5.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["chat_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.6.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["brand_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.7.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["shopping_category_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.8.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.9.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.9","typeLabel":"object"}],"uniqueKey":"filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"filters","typeLabel":"object[]"},"having":{"description":"Post-aggregation row filters (applied as HAVING after grouping). Selects which aggregated rows are returned without shrinking ratio-metric denominators. Multiple filters are AND'd together.\n\nPopulation fields — `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id` — and `brand_id` take `{field, operator, values}` with operator `in` or `not_in`. Population fields require the matching value in `dimensions` so the column appears in GROUP BY.\n\nMetric fields — `visibility`, `share_of_voice`, `win_rate`, `sentiment`, `position` — take `{field, operator, value}` with operator `gt`, `gte`, `lt` or `lte`, and need no matching `dimensions` entry. Each compares against the metric in the unit this endpoint returns it: `visibility`, `share_of_voice` and `win_rate` as a 0-1 ratio, `sentiment` as a 0-100 score, `position` as a rank where 1 is best. Values are validated against that unit, so a percentage where a ratio belongs is rejected rather than silently matching nothing. Two predicates on one field make a range; stating the same edge of a field twice, or a range no row could satisfy, is rejected. A row whose metric is undefined — no position or sentiment samples in the window — matches neither.\n\nA metric predicate tests whichever row the grouping produces, so the same predicate asks a different question at each grouping: with `dimensions: [\"prompt_id\"]` it selects the prompts that individually pass, and with no dimensions it tests the brand's rolled-up totals.","example":[{"field":"brand_id","operator":"in","values":["kw_abc123"]},{"field":"visibility","operator":"gte","value":0.1},{"field":"visibility","operator":"lte","value":0.9}],"type":"array","items":{"oneOf":[{"type":"object","description":"Deprecated: use model_channel_id filter instead","required":["field","operator","values"],"deprecated":true,"properties":{"field":{"type":"string","enum":["model_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","enum":["chatgpt-scraper","gpt-4o","gpt-4o-search","gpt-3.5-turbo","llama-sonar","perplexity-scraper","sonar","gemini-2.5-flash","gemini-3.1-flash-lite-search","gemini-scraper","google-ai-overview-scraper","google-ai-mode-scraper","llama-3.3-70b-instruct","deepseek-r1","deepseek-v4-pro","claude-3.5-haiku","claude-haiku-4.5","claude-sonnet-4","grok-scraper","microsoft-copilot-scraper","copilot-search-scraper","chatgpt-logged-in-scraper","grok-4","grok-4.3","grok-4.6","qwen-3-6-plus","qwen-3-7-plus","amazon-rufus-scraper","mistral-small-4","mistral-medium-3-5","muse-spark-1.2","muse-spark-1.3","muse-wonder-1.0","gemini-4-argon","naver-ai-briefing-scraper","claude-opus-5","claude-fable-5.1","gpt-6-astra","gpt-5.6-sol","gpt-5.6-terra","ernie-scraper","doubao-scraper","exa-answer","parallel"],"uniqueKey":"having.items.[INDEX].oneOf.0.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["model_channel_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","google-5","anthropic-0","anthropic-1","anthropic-2","anthropic-3","deepseek-0","meta-0","meta-1","meta-2","xai-0","xai-1","microsoft-0","amazon-0","mistral-0","mistral-1","naver-0","openai-3","openai-4","openai-5","baidu-0","exa-0","parallel-0","microsoft-1","openai-6","doubao-0"],"uniqueKey":"having.items.[INDEX].oneOf.1.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.2.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["topic_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.3.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["prompt_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.4.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["country_code"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","PR","PS","QA","RO","RS","SA","SE","SG","SI","SK","SR","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"],"uniqueKey":"having.items.[INDEX].oneOf.5.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["chat_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.6.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["brand_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.7.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","description":"Filters aggregated rows on a computed metric, in the same unit the report returns it: visibility, share_of_voice and win_rate as a 0-1 ratio, sentiment as a 0-100 score, position as a rank where 1 is best. Each field's value is validated against that unit, so a percentage where a ratio belongs is rejected rather than matching nothing. Combine two predicates for a range; stating the same bound twice, or a range no row can satisfy, is rejected. A row whose metric is undefined — no position or sentiment samples in the window — matches neither.","required":["field","operator","value"],"example":{"field":"visibility","operator":"gte","value":0.5},"properties":{"field":{"type":"string","enum":["visibility","share_of_voice","sentiment","position","win_rate"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.value","typeLabel":"number"}},"uniqueKey":"having.items.[INDEX].oneOf.8","typeLabel":"object"}],"uniqueKey":"having.items.[INDEX]","typeLabel":"object"},"uniqueKey":"having","typeLabel":"object[]"},"order_by":{"description":"Sort results by one or more fields. Multiple entries create a multi-key sort. Direction defaults to desc. When omitted, a default ordering is applied.","example":[{"field":"visibility","direction":"desc"}],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["visibility","visibility_count","mention_count","sentiment","position","share_of_voice","win_rate","date","week","month"],"isRequired":true,"uniqueKey":"order_by.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"direction":{"default":"desc","type":"string","enum":["asc","desc"],"uniqueKey":"order_by.items.[INDEX].direction","typeLabel":"enum\u003cstring>"}},"required":["field"],"uniqueKey":"order_by.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order_by","typeLabel":"object[]"},"include_previous_period":{"description":"Legacy comparison switch. When true without explicit comparison dates, each row gains a `previous` object computed over the adjacent equal-length window. Supplying previous_start_date and previous_end_date enables comparison over that exact window without this flag.","type":"boolean","uniqueKey":"include_previous_period","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"project_id":"or_f45b94ba-5e35-4982-93ed-285e72ee14eb","limit":1000,"offset":0,"start_date":"2025-09-22","end_date":"2025-09-22","previous_start_date":"2023-12-25","previous_end_date":"2023-12-25","dimensions":["tag_id","model_id"],"filters":[{"field":"model_id","operator":"in","values":["gpt-4o-search"]}],"having":[{"field":"brand_id","operator":"in","values":["kw_abc123"]},{"field":"visibility","operator":"gte","value":0.1},{"field":"visibility","operator":"lte","value":0.9}],"order_by":[{"field":"visibility","direction":"desc"}],"include_previous_period":true}}},"exampleType":"generated"},"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","uniqueKey":"project_id","typeLabel":"string"},"limit":{"default":1000,"type":"integer","minimum":1,"maximum":500000,"uniqueKey":"limit","typeLabel":"integer"},"offset":{"default":0,"type":"integer","minimum":0,"maximum":500000,"uniqueKey":"offset","typeLabel":"integer"},"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])))$","uniqueKey":"start_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"end_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"previous_start_date","typeLabel":"string\u003cdate>"},"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])))$","uniqueKey":"previous_end_date","typeLabel":"string\u003cdate>"},"dimensions":{"example":["tag_id","model_id"],"description":"Dimensions to break down the report by.","type":"array","items":{"type":"string","enum":["prompt_id","model_id","model_channel_id","tag_id","topic_id","date","week","month","country_code","chat_id"],"uniqueKey":"dimensions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"dimensions","typeLabel":"enum\u003cstring>[]"},"filters":{"description":"Pre-aggregation row filters (applied as WHERE before grouping). Shrinks both the numerator and the denominator of ratio metrics. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `brand_id`. Filtering by `brand_id` here also shrinks `share_of_voice`'s denominator — so SoV collapses to 1.0 when scoping to a single brand. If you want SoV preserved (X's share against all in-scope brands), put `brand_id` in `having` instead. Multiple filters are AND'd.","example":[{"field":"model_id","operator":"in","values":["gpt-4o-search"]}],"type":"array","items":{"oneOf":[{"type":"object","description":"Deprecated: use model_channel_id filter instead","required":["field","operator","values"],"deprecated":true,"properties":{"field":{"type":"string","enum":["model_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","enum":["chatgpt-scraper","gpt-4o","gpt-4o-search","gpt-3.5-turbo","llama-sonar","perplexity-scraper","sonar","gemini-2.5-flash","gemini-3.1-flash-lite-search","gemini-scraper","google-ai-overview-scraper","google-ai-mode-scraper","llama-3.3-70b-instruct","deepseek-r1","deepseek-v4-pro","claude-3.5-haiku","claude-haiku-4.5","claude-sonnet-4","grok-scraper","microsoft-copilot-scraper","copilot-search-scraper","chatgpt-logged-in-scraper","grok-4","grok-4.3","grok-4.6","qwen-3-6-plus","qwen-3-7-plus","amazon-rufus-scraper","mistral-small-4","mistral-medium-3-5","muse-spark-1.2","muse-spark-1.3","muse-wonder-1.0","gemini-4-argon","naver-ai-briefing-scraper","claude-opus-5","claude-fable-5.1","gpt-6-astra","gpt-5.6-sol","gpt-5.6-terra","ernie-scraper","doubao-scraper","exa-answer","parallel"],"uniqueKey":"filters.items.[INDEX].oneOf.0.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.0.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["model_channel_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","google-5","anthropic-0","anthropic-1","anthropic-2","anthropic-3","deepseek-0","meta-0","meta-1","meta-2","xai-0","xai-1","microsoft-0","amazon-0","mistral-0","mistral-1","naver-0","openai-3","openai-4","openai-5","baidu-0","exa-0","parallel-0","microsoft-1","openai-6","doubao-0"],"uniqueKey":"filters.items.[INDEX].oneOf.1.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.1.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.2.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.2.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["topic_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.3.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.3.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["prompt_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.4.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.4.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["country_code"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","PR","PS","QA","RO","RS","SA","SE","SG","SI","SK","SR","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"],"uniqueKey":"filters.items.[INDEX].oneOf.5.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.5.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["chat_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.6.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.6.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["brand_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.7.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.7.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["shopping_category_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.8.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.8.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"filters.items.[INDEX].oneOf.9.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"filters.items.[INDEX].oneOf.9.values","typeLabel":"string[]"}},"uniqueKey":"filters.items.[INDEX].oneOf.9","typeLabel":"object"}],"uniqueKey":"filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"filters","typeLabel":"object[]"},"having":{"description":"Post-aggregation row filters (applied as HAVING after grouping). Selects which aggregated rows are returned without shrinking ratio-metric denominators. Multiple filters are AND'd together.\n\nPopulation fields — `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id` — and `brand_id` take `{field, operator, values}` with operator `in` or `not_in`. Population fields require the matching value in `dimensions` so the column appears in GROUP BY.\n\nMetric fields — `visibility`, `share_of_voice`, `win_rate`, `sentiment`, `position` — take `{field, operator, value}` with operator `gt`, `gte`, `lt` or `lte`, and need no matching `dimensions` entry. Each compares against the metric in the unit this endpoint returns it: `visibility`, `share_of_voice` and `win_rate` as a 0-1 ratio, `sentiment` as a 0-100 score, `position` as a rank where 1 is best. Values are validated against that unit, so a percentage where a ratio belongs is rejected rather than silently matching nothing. Two predicates on one field make a range; stating the same edge of a field twice, or a range no row could satisfy, is rejected. A row whose metric is undefined — no position or sentiment samples in the window — matches neither.\n\nA metric predicate tests whichever row the grouping produces, so the same predicate asks a different question at each grouping: with `dimensions: [\"prompt_id\"]` it selects the prompts that individually pass, and with no dimensions it tests the brand's rolled-up totals.","example":[{"field":"brand_id","operator":"in","values":["kw_abc123"]},{"field":"visibility","operator":"gte","value":0.1},{"field":"visibility","operator":"lte","value":0.9}],"type":"array","items":{"oneOf":[{"type":"object","description":"Deprecated: use model_channel_id filter instead","required":["field","operator","values"],"deprecated":true,"properties":{"field":{"type":"string","enum":["model_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","enum":["chatgpt-scraper","gpt-4o","gpt-4o-search","gpt-3.5-turbo","llama-sonar","perplexity-scraper","sonar","gemini-2.5-flash","gemini-3.1-flash-lite-search","gemini-scraper","google-ai-overview-scraper","google-ai-mode-scraper","llama-3.3-70b-instruct","deepseek-r1","deepseek-v4-pro","claude-3.5-haiku","claude-haiku-4.5","claude-sonnet-4","grok-scraper","microsoft-copilot-scraper","copilot-search-scraper","chatgpt-logged-in-scraper","grok-4","grok-4.3","grok-4.6","qwen-3-6-plus","qwen-3-7-plus","amazon-rufus-scraper","mistral-small-4","mistral-medium-3-5","muse-spark-1.2","muse-spark-1.3","muse-wonder-1.0","gemini-4-argon","naver-ai-briefing-scraper","claude-opus-5","claude-fable-5.1","gpt-6-astra","gpt-5.6-sol","gpt-5.6-terra","ernie-scraper","doubao-scraper","exa-answer","parallel"],"uniqueKey":"having.items.[INDEX].oneOf.0.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.0.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["model_channel_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","google-5","anthropic-0","anthropic-1","anthropic-2","anthropic-3","deepseek-0","meta-0","meta-1","meta-2","xai-0","xai-1","microsoft-0","amazon-0","mistral-0","mistral-1","naver-0","openai-3","openai-4","openai-5","baidu-0","exa-0","parallel-0","microsoft-1","openai-6","doubao-0"],"uniqueKey":"having.items.[INDEX].oneOf.1.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.1.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["tag_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in","has_all"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.2.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.2.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["topic_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.3.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.3.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["prompt_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.4.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.4.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["country_code"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"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","PR","PS","QA","RO","RS","SA","SE","SG","SI","SK","SR","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"],"uniqueKey":"having.items.[INDEX].oneOf.5.values.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.5.values","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"having.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["chat_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.6.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.6.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["field","operator","values"],"properties":{"field":{"type":"string","enum":["brand_id"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["in","not_in"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.operator","typeLabel":"enum\u003cstring>"},"values":{"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"having.items.[INDEX].oneOf.7.values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.7.values","typeLabel":"string[]"}},"uniqueKey":"having.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","description":"Filters aggregated rows on a computed metric, in the same unit the report returns it: visibility, share_of_voice and win_rate as a 0-1 ratio, sentiment as a 0-100 score, position as a rank where 1 is best. Each field's value is validated against that unit, so a percentage where a ratio belongs is rejected rather than matching nothing. Combine two predicates for a range; stating the same bound twice, or a range no row can satisfy, is rejected. A row whose metric is undefined — no position or sentiment samples in the window — matches neither.","required":["field","operator","value"],"example":{"field":"visibility","operator":"gte","value":0.5},"properties":{"field":{"type":"string","enum":["visibility","share_of_voice","sentiment","position","win_rate"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","isRequired":true,"uniqueKey":"having.items.[INDEX].oneOf.8.value","typeLabel":"number"}},"uniqueKey":"having.items.[INDEX].oneOf.8","typeLabel":"object"}],"uniqueKey":"having.items.[INDEX]","typeLabel":"object"},"uniqueKey":"having","typeLabel":"object[]"},"order_by":{"description":"Sort results by one or more fields. Multiple entries create a multi-key sort. Direction defaults to desc. When omitted, a default ordering is applied.","example":[{"field":"visibility","direction":"desc"}],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["visibility","visibility_count","mention_count","sentiment","position","share_of_voice","win_rate","date","week","month"],"isRequired":true,"uniqueKey":"order_by.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"direction":{"default":"desc","type":"string","enum":["asc","desc"],"uniqueKey":"order_by.items.[INDEX].direction","typeLabel":"enum\u003cstring>"}},"required":["field"],"uniqueKey":"order_by.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order_by","typeLabel":"object[]"},"include_previous_period":{"description":"Legacy comparison switch. When true without explicit comparison dates, each row gains a `previous` object computed over the adjacent equal-length window. Supplying previous_start_date and previous_end_date enables comparison over that exact window without this flag.","type":"boolean","uniqueKey":"include_previous_period","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"project_id":"or_f45b94ba-5e35-4982-93ed-285e72ee14eb","limit":1000,"offset":0,"start_date":"2025-09-22","end_date":"2025-09-22","previous_start_date":"2023-12-25","previous_end_date":"2023-12-25","dimensions":["tag_id","model_id"],"filters":[{"field":"model_id","operator":"in","values":["gpt-4o-search"]}],"having":[{"field":"brand_id","operator":"in","values":["kw_abc123"]},{"field":"visibility","operator":"gte","value":0.1},{"field":"visibility","operator":"lte","value":0.9}],"order_by":[{"field":"visibility","direction":"desc"}],"include_previous_period":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7f9bf72b-3620-4b54-b085-222c71c88b4c":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"object","properties":{"id":{"type":"string","example":"kw_915e742b-396d-4a86-ad57-8bc84e8c2232","isRequired":true,"uniqueKey":"data.items.[INDEX].brand.id","typeLabel":"string"},"name":{"type":"string","example":"Peec AI","isRequired":true,"uniqueKey":"data.items.[INDEX].brand.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.items.[INDEX].brand","typeLabel":"object"},"mention_count":{"type":"number","example":42,"isRequired":true,"uniqueKey":"data.items.[INDEX].mention_count","typeLabel":"number"},"visibility":{"type":"number","example":0.5,"isRequired":true,"uniqueKey":"data.items.[INDEX].visibility","typeLabel":"number"},"visibility_count":{"type":"number","example":5,"isRequired":true,"uniqueKey":"data.items.[INDEX].visibility_count","typeLabel":"number"},"visibility_total":{"type":"number","example":10,"isRequired":true,"uniqueKey":"data.items.[INDEX].visibility_total","typeLabel":"number"},"prompt":{"type":"object","properties":{"id":{"type":"string","example":"pr_93f790de-5b7a-45ee-b782-61103c81f20d","isRequired":true,"uniqueKey":"data.items.[INDEX].prompt.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.items.[INDEX].prompt","typeLabel":"object"},"model":{"deprecated":true,"description":"Deprecated: use model_channel instead","type":"object","properties":{"id":{"type":"string","example":"gpt-4o-search","isRequired":true,"uniqueKey":"data.items.[INDEX].model.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.items.[INDEX].model","typeLabel":"object"},"model_channel":{"type":"object","properties":{"id":{"type":"string","example":"openai-1","isRequired":true,"uniqueKey":"data.items.[INDEX].model_channel.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.items.[INDEX].model_channel","typeLabel":"object"},"tag":{"type":"object","properties":{"id":{"type":"string","example":"tg_23abec5b-100a-4261-9ee7-1effe68f0149","isRequired":true,"uniqueKey":"data.items.[INDEX].tag.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.items.[INDEX].tag","typeLabel":"object"},"topic":{"type":"object","properties":{"id":{"type":"string","example":"to_e6b8cdd3-a51b-4d94-a866-28dbe6b830a6","isRequired":true,"uniqueKey":"data.items.[INDEX].topic.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.items.[INDEX].topic","typeLabel":"object"},"country_code":{"example":"US","type":"string","uniqueKey":"data.items.[INDEX].country_code","typeLabel":"string"},"chat":{"type":"object","properties":{"id":{"type":"string","example":"ch_abc123","isRequired":true,"uniqueKey":"data.items.[INDEX].chat.id","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.items.[INDEX].chat","typeLabel":"object"},"date":{"example":"2025-03-15","type":"string","uniqueKey":"data.items.[INDEX].date","typeLabel":"string"},"week":{"example":"2025-03-10","description":"Start (Monday) of the ISO week bucket.","type":"string","uniqueKey":"data.items.[INDEX].week","typeLabel":"string"},"month":{"example":"2025-03-01","description":"First day of the month bucket.","type":"string","uniqueKey":"data.items.[INDEX].month","typeLabel":"string"},"share_of_voice":{"example":0.15,"description":"Share of total mentions attributed to this brand within the row's dimension grouping. The denominator sums mentions across all brands within the same dimension values (e.g. when grouping by `prompt_id`, across all brands within that prompt). Pre-aggregation `filters` shrink both numerator and denominator together — filtering by `brand_id` here collapses SoV to 1.0. Post-aggregation `having` (e.g. `brand_id`) selects which rows are returned without shrinking the denominator, so SoV stays in [0, 1].","type":"number","uniqueKey":"data.items.[INDEX].share_of_voice","typeLabel":"number"},"win_rate":{"example":0.2,"description":"The share of chats where the brand is ranked first (0-1 ratio). A chat counts when the brand is named before every other brand in the answer, tracked or not. The denominator is `visibility_total`.","type":"number","minimum":0,"maximum":1,"uniqueKey":"data.items.[INDEX].win_rate","typeLabel":"number"},"win_count":{"example":2,"type":"number","uniqueKey":"data.items.[INDEX].win_count","typeLabel":"number"},"sentiment":{"example":50,"type":"number","uniqueKey":"data.items.[INDEX].sentiment","typeLabel":"number"},"sentiment_sum":{"example":0,"type":"number","uniqueKey":"data.items.[INDEX].sentiment_sum","typeLabel":"number"},"sentiment_count":{"type":"number","example":10,"uniqueKey":"data.items.[INDEX].sentiment_count","typeLabel":"number"},"position":{"example":1.5,"type":"number","uniqueKey":"data.items.[INDEX].position","typeLabel":"number"},"position_sum":{"example":15,"type":"number","uniqueKey":"data.items.[INDEX].position_sum","typeLabel":"number"},"position_count":{"type":"number","example":10,"uniqueKey":"data.items.[INDEX].position_count","typeLabel":"number"},"previous":{"description":"Same metrics computed over the requested comparison window, present when explicit comparison dates or include_previous_period enabled comparison and a matching row existed in it.","type":"object","properties":{"mention_count":{"type":"number","example":42,"isRequired":true,"uniqueKey":"data.items.[INDEX].previous.mention_count","typeLabel":"number"},"visibility":{"type":"number","example":0.5,"isRequired":true,"uniqueKey":"data.items.[INDEX].previous.visibility","typeLabel":"number"},"visibility_count":{"type":"number","example":5,"isRequired":true,"uniqueKey":"data.items.[INDEX].previous.visibility_count","typeLabel":"number"},"visibility_total":{"type":"number","example":10,"isRequired":true,"uniqueKey":"data.items.[INDEX].previous.visibility_total","typeLabel":"number"},"date":{"example":"2025-03-15","type":"string","uniqueKey":"data.items.[INDEX].previous.date","typeLabel":"string"},"share_of_voice":{"example":0.15,"description":"Share of total mentions attributed to this brand within the row's dimension grouping. The denominator sums mentions across all brands within the same dimension values (e.g. when grouping by `prompt_id`, across all brands within that prompt). Pre-aggregation `filters` shrink both numerator and denominator together — filtering by `brand_id` here collapses SoV to 1.0. Post-aggregation `having` (e.g. `brand_id`) selects which rows are returned without shrinking the denominator, so SoV stays in [0, 1].","type":"number","uniqueKey":"data.items.[INDEX].previous.share_of_voice","typeLabel":"number"},"win_rate":{"example":0.2,"description":"The share of chats where the brand is ranked first (0-1 ratio). A chat counts when the brand is named before every other brand in the answer, tracked or not. The denominator is `visibility_total`.","type":"number","minimum":0,"maximum":1,"uniqueKey":"data.items.[INDEX].previous.win_rate","typeLabel":"number"},"win_count":{"example":2,"type":"number","uniqueKey":"data.items.[INDEX].previous.win_count","typeLabel":"number"},"sentiment":{"example":50,"type":"number","uniqueKey":"data.items.[INDEX].previous.sentiment","typeLabel":"number"},"sentiment_sum":{"example":0,"type":"number","uniqueKey":"data.items.[INDEX].previous.sentiment_sum","typeLabel":"number"},"sentiment_count":{"type":"number","example":10,"uniqueKey":"data.items.[INDEX].previous.sentiment_count","typeLabel":"number"},"position":{"example":1.5,"type":"number","uniqueKey":"data.items.[INDEX].previous.position","typeLabel":"number"},"position_sum":{"example":15,"type":"number","uniqueKey":"data.items.[INDEX].previous.position_sum","typeLabel":"number"},"position_count":{"type":"number","example":10,"uniqueKey":"data.items.[INDEX].previous.position_count","typeLabel":"number"}},"required":["mention_count","visibility","visibility_count","visibility_total"],"uniqueKey":"data.items.[INDEX].previous","typeLabel":"object"}},"required":["brand","mention_count","visibility","visibility_count","visibility_total"],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"required":["data"],"description":"Success","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"brand":{"id":"kw_915e742b-396d-4a86-ad57-8bc84e8c2232","name":"Peec AI"},"mention_count":42,"visibility":0.5,"visibility_count":5,"visibility_total":10,"prompt":{"id":"pr_93f790de-5b7a-45ee-b782-61103c81f20d"},"model":{"id":"gpt-4o-search"},"model_channel":{"id":"openai-1"},"tag":{"id":"tg_23abec5b-100a-4261-9ee7-1effe68f0149"},"topic":{"id":"to_e6b8cdd3-a51b-4d94-a866-28dbe6b830a6"},"country_code":"US","chat":{"id":"ch_abc123"},"date":"2025-03-15","week":"2025-03-10","month":"2025-03-01","share_of_voice":0.15,"win_rate":0.2,"win_count":2,"sentiment":50,"sentiment_sum":0,"sentiment_count":10,"position":1.5,"position_sum":15,"position_count":10,"previous":{"mention_count":42,"visibility":0.5,"visibility_count":5,"visibility_total":10,"date":"2025-03-15","share_of_voice":0.15,"win_rate":0.2,"win_count":2,"sentiment":50,"sentiment_sum":0,"sentiment_count":10,"position":1.5,"position_sum":15,"position_count":10}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1e12cd59-daf1-4d22-8dbc-27007aeebea3":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"}},"e861c293-20d1-4d41-9646-eb2d25b49302":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"c8fa48c8-ee13-4560-993f-c6e90092f1c4":{"url":"https://api.peec.ai/customer/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-Key"}],"title":"APIKeyHeader"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"https://api.peec.ai/customer/v1/openapi/json"},"subdomain":"peecai-b61a1960","siteName":"Peec.ai Docs","title":"Get Brands Report - Peec.ai Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T15:11:58.062Z","originalFileLocation":"api-reference/reports/get-brands-report.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get a report on Brands. ## Prompt Scope The report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a prompt_id filter to narrow it. ## Aggregation Formulas When aggregating results across multiple rows/dimensions, use the following formulas: - sentiment: ((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100 - position: sum(position_sum) / sum(position_count) - visibility: sum(visibility_count) / sum(visibility_total) - share_of_voice: mention_count / sum(mention_count) - win_rate: sum(win_count) / sum(visibility_total) ## filters vs having filters are pre-aggregation row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Note that brand_id in filters shrinks share_of_voice\u0026#x27;s denominator too — so filtering to one brand collapses SoV to 1.0. Use having for brand_id if you want SoV preserved. having are post-aggregation row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do not shrink ratio-metric denominators. Filtering {field: \u0026quot;brand_id\u0026quot;, values: [X]} here returns only brand X\u0026#x27;s row, but share_of_voice still divides X\u0026#x27;s mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Population fields (model_id etc.) are also allowed in having but require the matching value in dimensions so the column appears in GROUP BY; otherwise the request is rejected. When dimensions are requested, the share_of_voice denominator follows the same grouping as the numerator. Requesting prompt_id as a dimension produces per-(brand × prompt) rows whose share_of_voice is the brand\u0026#x27;s mentions in that prompt divided by all brands\u0026#x27; mentions in that prompt.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Peec.ai Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Brands Report - Peec.ai Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a report on Brands. ## Prompt Scope The report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a prompt_id filter to narrow it. ## Aggregation Formulas When aggregating results across multiple rows/dimensions, use the following formulas: - sentiment: ((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100 - position: sum(position_sum) / sum(position_count) - visibility: sum(visibility_count) / sum(visibility_total) - share_of_voice: mention_count / sum(mention_count) - win_rate: sum(win_count) / sum(visibility_total) ## filters vs having filters are pre-aggregation row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Note that brand_id in filters shrinks share_of_voice\u0026#x27;s denominator too — so filtering to one brand collapses SoV to 1.0. Use having for brand_id if you want SoV preserved. having are post-aggregation row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do not shrink ratio-metric denominators. Filtering {field: \u0026quot;brand_id\u0026quot;, values: [X]} here returns only brand X\u0026#x27;s row, but share_of_voice still divides X\u0026#x27;s mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Population fields (model_id etc.) are also allowed in having but require the matching value in dimensions so the column appears in GROUP BY; otherwise the request is rejected. When dimensions are requested, the share_of_voice denominator follows the same grouping as the numerator. Requesting prompt_id as a dimension produces per-(brand × prompt) rows whose share_of_voice is the brand\u0026#x27;s mentions in that prompt divided by all brands\u0026#x27; mentions in that prompt.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Peec.ai Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.peec.ai/api-reference/reports/get-brands-report\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://peecai-b61a1960.mintlify.site/_mintlify/api/og/v2?division=Reports\u0026amp;title=Get+Brands+Report\u0026amp;description=Get+a+report+on+Brands.%0A%0A%23%23+Prompt+Scope%0A%0AThe+report+covers+every+prompt+in+the+project+that+has+not+been+deleted%2C+archived+prompts+included%2C+so+history+stays+i\u0026amp;theme=3497822b04003214442ec868\u0026amp;signature=66bb8a4456cf09e705ec4a32410b7bca7567894f0a3ae024fa5c9544f8c4a6d2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Brands Report - Peec.ai Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a report on Brands. ## Prompt Scope The report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a prompt_id filter to narrow it. ## Aggregation Formulas When aggregating results across multiple rows/dimensions, use the following formulas: - sentiment: ((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100 - position: sum(position_sum) / sum(position_count) - visibility: sum(visibility_count) / sum(visibility_total) - share_of_voice: mention_count / sum(mention_count) - win_rate: sum(win_count) / sum(visibility_total) ## filters vs having filters are pre-aggregation row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Note that brand_id in filters shrinks share_of_voice\u0026#x27;s denominator too — so filtering to one brand collapses SoV to 1.0. Use having for brand_id if you want SoV preserved. having are post-aggregation row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do not shrink ratio-metric denominators. Filtering {field: \u0026quot;brand_id\u0026quot;, values: [X]} here returns only brand X\u0026#x27;s row, but share_of_voice still divides X\u0026#x27;s mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Population fields (model_id etc.) are also allowed in having but require the matching value in dimensions so the column appears in GROUP BY; otherwise the request is rejected. When dimensions are requested, the share_of_voice denominator follows the same grouping as the numerator. Requesting prompt_id as a dimension produces per-(brand × prompt) rows whose share_of_voice is the brand\u0026#x27;s mentions in that prompt divided by all brands\u0026#x27; mentions in that prompt.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://peecai-b61a1960.mintlify.site/_mintlify/api/og/v2?division=Reports\u0026amp;title=Get+Brands+Report\u0026amp;description=Get+a+report+on+Brands.%0A%0A%23%23+Prompt+Scope%0A%0AThe+report+covers+every+prompt+in+the+project+that+has+not+been+deleted%2C+archived+prompts+included%2C+so+history+stays+i\u0026amp;theme=3497822b04003214442ec868\u0026amp;signature=66bb8a4456cf09e705ec4a32410b7bca7567894f0a3ae024fa5c9544f8c4a6d2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/peecai-b61a1960/zMn2L1kVVj65q3Df/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Peec.ai Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.peec.ai/api-reference/reports/get-brands-report\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/reports/get-brands-report.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.peec.ai/#organization\",\"name\":\"Peec.ai Docs\",\"url\":\"https://docs.peec.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/peecai-b61a1960/BVQQX1wLWNjFOa_V/images/logo-white.svg?fit=max\u0026auto=format\u0026n=BVQQX1wLWNjFOa_V\u0026q=85\u0026s=5d3f30a498a2c71a875226adc1a9de52\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.peec.ai#website\",\"name\":\"Peec.ai Docs\",\"url\":\"https://docs.peec.ai\",\"publisher\":{\"@id\":\"https://docs.peec.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.peec.ai/api-reference/reports/get-brands-report#webpage\",\"url\":\"https://docs.peec.ai/api-reference/reports/get-brands-report\",\"name\":\"Get Brands Report\",\"description\":\"Get a report on Brands. ## Prompt Scope The report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a prompt_id filter to narrow it. ## Aggregation Formulas When aggregating results across multiple rows/dimensions, use the following formulas: - sentiment: ((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100 - position: sum(position_sum) / sum(position_count) - visibility: sum(visibility_count) / sum(visibility_total) - share_of_voice: mention_count / sum(mention_count) - win_rate: sum(win_count) / sum(visibility_total) ## filters vs having filters are pre-aggregation row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Note that brand_id in filters shrinks share_of_voice's denominator too — so filtering to one brand collapses SoV to 1.0. Use having for brand_id if you want SoV preserved. having are post-aggregation row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do not shrink ratio-metric denominators. Filtering {field: \\\"brand_id\\\", values: [X]} here returns only brand X's row, but share_of_voice still divides X's mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Population fields (model_id etc.) are also allowed in having but require the matching value in dimensions so the column appears in GROUP BY; otherwise the request is rejected. When dimensions are requested, the share_of_voice denominator follows the same grouping as the numerator. Requesting prompt_id as a dimension produces per-(brand × prompt) rows whose share_of_voice is the brand's mentions in that prompt divided by all brands' mentions in that prompt.\",\"dateModified\":\"2026-11-20T15:11:58.062Z\",\"isPartOf\":{\"@id\":\"https://docs.peec.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.peec.ai/api-reference/reports/get-brands-report#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.peec.ai/api-reference/reports/get-brands-report#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Peec.ai Docs\",\"item\":\"https://docs.peec.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Brands Report\",\"item\":\"https://docs.peec.ai/api-reference/reports/get-brands-report\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.peec.ai/api-reference/reports/get-brands-report#apireference\",\"headline\":\"Get Brands Report\",\"name\":\"Get Brands Report\",\"description\":\"Get a report on Brands. ## Prompt Scope The report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a prompt_id filter to narrow it. ## Aggregation Formulas When aggregating results across multiple rows/dimensions, use the following formulas: - sentiment: ((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100 - position: sum(position_sum) / sum(position_count) - visibility: sum(visibility_count) / sum(visibility_total) - share_of_voice: mention_count / sum(mention_count) - win_rate: sum(win_count) / sum(visibility_total) ## filters vs having filters are pre-aggregation row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Note that brand_id in filters shrinks share_of_voice's denominator too — so filtering to one brand collapses SoV to 1.0. Use having for brand_id if you want SoV preserved. having are post-aggregation row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do not shrink ratio-metric denominators. Filtering {field: \\\"brand_id\\\", values: [X]} here returns only brand X's row, but share_of_voice still divides X's mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Population fields (model_id etc.) are also allowed in having but require the matching value in dimensions so the column appears in GROUP BY; otherwise the request is rejected. When dimensions are requested, the share_of_voice denominator follows the same grouping as the numerator. Requesting prompt_id as a dimension produces per-(brand × prompt) rows whose share_of_voice is the brand's mentions in that prompt divided by all brands' mentions in that prompt.\",\"url\":\"https://docs.peec.ai/api-reference/reports/get-brands-report\",\"mainEntityOfPage\":{\"@id\":\"https://docs.peec.ai/api-reference/reports/get-brands-report#webpage\"},\"dateModified\":\"2026-11-20T15:11:58.062Z\",\"publisher\":{\"@id\":\"https://docs.peec.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.peec.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Peec.ai Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Peec.ai Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/reports/get-brands-report.md","siteName":"Peec.ai Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"newspaper","pages":[{"title":"Documentation","href":"/intro-to-peec-ai"}]},{"tab":"Agencies","icon":"handshake","pages":[{"title":"Agencies","href":"/agencies/agency-getting-started"}]},{"tab":"MCP Server","icon":"plug","pages":[{"title":"MCP Server","href":"/mcp/introduction"}]},{"tab":"Customer API","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"Introduction to Peec API","sidebarTitle":"Introduction","icon":"book","href":"/api/introduction"},{"title":"Authentication for Peec API","sidebarTitle":"Authentication","icon":"lock","href":"/api/authentication"},{"title":"Rate Limits for Peec API","sidebarTitle":"Rate Limits","icon":"timer","href":"/api/ratelimits"},{"title":"Model channels","sidebarTitle":"Model Channels","icon":"tags","href":"/api/model-channels"},{"title":"Filtering and dimensions","sidebarTitle":"Filtering \u0026 Dimensions","icon":"filter","href":"/api/filtering-and-dimensions"},{"title":"Changelog","description":"Track updates, improvements, and breaking changes to the Peec API.","icon":"list","sidebarTitle":"Changelog","href":"/api/changelog"}]},{"group":"Endpoints","pages":[{"group":"Reports","pages":[{"title":"Get Brands Report","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /reports/brands","href":"/api-reference/reports/get-brands-report"},{"title":"Get Domains Report","description":"Get a report on Source Domains.\n\n## Prompt Scope\n\nThe report covers every prompt in the project that has not been deleted, archived prompts included, so history stays intact after a prompt is archived. Use a `prompt_id` filter to narrow it.\n\n## Aggregation Formulas\n\nWhen aggregating results across multiple rows/dimensions, use the following formulas:\n\n- **citation_rate**: `sum(citation_count) / sum(retrieved_chat_count)`\n- **retrieval_rate**: `sum(retrieval_count) / sum(total_chat_count)`\n- **retrieved_percentage**: `sum(retrieved_chat_count) / sum(total_chat_count)`\n- **cited_percentage**: `sum(cited_chat_count) / sum(total_chat_count)`\n\n## `filters` vs `having`\n\n`filters` are **pre-aggregation** row filters (applied as WHERE before GROUP BY) on the source-row table. Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `domain`, `domain_classification`, `url`, `url_classification`, `mentioned_brand_id`, `mentioned_brand_count`, `gap`, `url_tag_id`, `domain_tag_id`.\n- Population (`model_id`, `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`) shrink both numerator and denominator (`total_chat_count`).\n- Source-side (`domain`, `domain_classification`, `url`, `url_classification`) and per-row mentioned-brand predicates (`mentioned_brand_id`, `mentioned_brand_count`, `gap`) shrink the source-row scope feeding aggregation. `total_chat_count` is computed from a chat-level table that doesn't carry these columns, so the denominator narrows only on chat-level fields.\n\n`having` are **post-aggregation** row filters (applied as HAVING after GROUP BY). Allowed fields: `model_id` (deprecated), `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`, `domain`, `domain_classification`, `mentioned_brand_id`, `mentioned_brand_count`, `gap`. They select which aggregated rows are returned and do not affect denominators.","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /reports/domains","href":"/api-reference/reports/get-domains-report"},{"title":"Get Links Report","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /reports/links","href":"/api-reference/reports/get-links-report"},{"title":"Get URLs Report","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /reports/urls","href":"/api-reference/reports/get-urls-report"},{"title":"Get URL Content","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /sources/urls/content","href":"/api-reference/reports/get-url-content"},{"title":"List URL Content Versions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /sources/urls/content/versions","href":"/api-reference/reports/list-url-content-versions"},{"title":"Get URL Content Diff","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /sources/urls/content/diff","href":"/api-reference/reports/get-url-content-diff"}]},{"group":"Project","pages":[{"title":"List Fanout Search Queries","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /queries/search","href":"/api-reference/project/list-fanout-search-queries"},{"title":"List Fanout Shopping Queries","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /queries/shopping","href":"/api-reference/project/list-fanout-shopping-queries"},{"title":"List Brands","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brands","href":"/api-reference/project/list-brands"},{"title":"Create Brand","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /brands","href":"/api-reference/project/create-brand"},{"title":"List Brand Social Channels","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brands/social-channels","href":"/api-reference/project/list-brand-social-channels"},{"title":"List Brand Suggestions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brands/suggestions","href":"/api-reference/project/list-brand-suggestions"},{"title":"Accept Brand Suggestion","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /brands/suggestions/{brand_suggestion_id}/accept","href":"/api-reference/project/accept-brand-suggestion"},{"title":"Reject Brand Suggestion","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /brands/suggestions/{brand_suggestion_id}/reject","href":"/api-reference/project/reject-brand-suggestion"},{"title":"Delete Brand","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json delete /brands/{brand_id}","href":"/api-reference/project/delete-brand"},{"title":"Update Brand","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json patch /brands/{brand_id}","href":"/api-reference/project/update-brand"},{"title":"Set Brand Social Channels","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json put /brands/{brand_id}/social-channels","href":"/api-reference/project/set-brand-social-channels"},{"title":"List Prompts","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /prompts","href":"/api-reference/project/list-prompts"},{"title":"Create Prompt","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /prompts","href":"/api-reference/project/create-prompt"},{"title":"List Prompt Suggestions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /prompts/suggestions","href":"/api-reference/project/list-prompt-suggestions"},{"title":"Generate Prompt Suggestions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /prompts/suggestions/generate","href":"/api-reference/project/generate-prompt-suggestions"},{"title":"Get Prompt Suggestion Generation","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /prompts/suggestions/generations/{generation_id}","href":"/api-reference/project/get-prompt-suggestion-generation"},{"title":"Accept Prompt Suggestion","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /prompts/suggestions/{prompt_suggestion_id}/accept","href":"/api-reference/project/accept-prompt-suggestion"},{"title":"Reject Prompt Suggestion","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /prompts/suggestions/{prompt_suggestion_id}/reject","href":"/api-reference/project/reject-prompt-suggestion"},{"title":"Update Prompt Suggestions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /prompts/suggestions/update","href":"/api-reference/project/update-prompt-suggestions"},{"title":"Delete Prompt","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json delete /prompts/{prompt_id}","href":"/api-reference/project/delete-prompt"},{"title":"Update Prompt","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json patch /prompts/{prompt_id}","href":"/api-reference/project/update-prompt"},{"title":"Archive Prompt","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /prompts/{prompt_id}/archive","href":"/api-reference/project/archive-prompt"},{"title":"Unarchive Prompt","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /prompts/{prompt_id}/unarchive","href":"/api-reference/project/unarchive-prompt"},{"title":"Invite Project Members","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /members/invite","href":"/api-reference/project/invite-project-members"},{"title":"List Tags","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /tags","href":"/api-reference/project/list-tags"},{"title":"Create Tag","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /tags","href":"/api-reference/project/create-tag"},{"title":"Delete Tag","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json delete /tags/{tag_id}","href":"/api-reference/project/delete-tag"},{"title":"Update Tag","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json patch /tags/{tag_id}","href":"/api-reference/project/update-tag"},{"title":"List Tag Groups","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /tag-groups","href":"/api-reference/project/list-tag-groups"},{"title":"Delete Tag Group","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json delete /tag-groups","href":"/api-reference/project/delete-tag-group"},{"title":"Update Tag Group","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json patch /tag-groups/{group}","href":"/api-reference/project/update-tag-group"},{"title":"List Topics","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /topics","href":"/api-reference/project/list-topics"},{"title":"Create Topic","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /topics","href":"/api-reference/project/create-topic"},{"title":"Generate Topics","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /topics/generate","href":"/api-reference/project/generate-topics"},{"title":"List Topic Suggestions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /topics/suggestions","href":"/api-reference/project/list-topic-suggestions"},{"title":"Accept Topic Suggestion","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /topics/suggestions/{topic_suggestion_id}/accept","href":"/api-reference/project/accept-topic-suggestion"},{"title":"Reject Topic Suggestion","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /topics/suggestions/{topic_suggestion_id}/reject","href":"/api-reference/project/reject-topic-suggestion"},{"title":"Delete Topic","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json delete /topics/{topic_id}","href":"/api-reference/project/delete-topic"},{"title":"Update Topic","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json patch /topics/{topic_id}","href":"/api-reference/project/update-topic"},{"title":"List Models","deprecated":true,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /models","href":"/api-reference/project/list-models"},{"title":"List Model Channels","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /model-channels","href":"/api-reference/project/list-model-channels"},{"title":"List Bots","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /agent-analytics/bots","href":"/api-reference/project/list-bots"},{"title":"List Agent logs","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /agent-analytics/logs","href":"/api-reference/project/list-agent-logs"},{"title":"Get Agent Visits","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /agent-analytics/visits","href":"/api-reference/project/get-agent-visits"},{"title":"List Chats","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /chats","href":"/api-reference/project/list-chats"},{"title":"Get Chat","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /chats/{chat_id}/content","href":"/api-reference/project/get-chat"},{"title":"Get Project Profile","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /project-profile","href":"/api-reference/project/get-project-profile"},{"title":"Set Project Profile","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json put /project-profile","href":"/api-reference/project/set-project-profile"},{"title":"List Custom Domain Classifications","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /classifications/domains","href":"/api-reference/project/list-custom-domain-classifications"},{"title":"Create Custom Domain Classification","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /classifications/domains","href":"/api-reference/project/create-custom-domain-classification"},{"title":"Delete Custom Domain Classification","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json delete /classifications/domains","href":"/api-reference/project/delete-custom-domain-classification"},{"title":"Set Domain Classification","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json put /classifications/domain-assignments","href":"/api-reference/project/set-domain-classification"},{"title":"List Custom URL Classifications","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /classifications/urls","href":"/api-reference/project/list-custom-url-classifications"},{"title":"Create Custom URL Classification","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /classifications/urls","href":"/api-reference/project/create-custom-url-classification"},{"title":"Delete Custom URL Classification","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json delete /classifications/urls","href":"/api-reference/project/delete-custom-url-classification"},{"title":"Set URL Classification","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json put /classifications/url-assignments","href":"/api-reference/project/set-url-classification"},{"title":"List Source Tags","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /source-tags","href":"/api-reference/project/list-source-tags"},{"title":"Create Source Tag","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /source-tags","href":"/api-reference/project/create-source-tag"},{"title":"Delete Source Tag","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json delete /source-tags/{source_tag_id}","href":"/api-reference/project/delete-source-tag"},{"title":"Update Source Tag","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json patch /source-tags/{source_tag_id}","href":"/api-reference/project/update-source-tag"},{"title":"Update URL Source Tags","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json put /source-tags/url-assignments","href":"/api-reference/project/update-url-source-tags"},{"title":"Update Domain Source Tags","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json put /source-tags/domain-assignments","href":"/api-reference/project/update-domain-source-tags"}]},{"group":"Products","pages":[{"title":"List Products","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/list","href":"/api-reference/products/list-products"},{"title":"Get Product","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/detail","href":"/api-reference/products/get-product"},{"title":"Get Shopping Attributes","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/attributes","href":"/api-reference/products/get-shopping-attributes"},{"title":"Get Shopping Summary","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/summary","href":"/api-reference/products/get-shopping-summary"},{"title":"Get Shopping Trend","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/trend","href":"/api-reference/products/get-shopping-trend"},{"title":"List Shopping Performance","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/performance","href":"/api-reference/products/list-shopping-performance"},{"title":"List Shopping Demand","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/demand","href":"/api-reference/products/list-shopping-demand"},{"title":"List Merchants","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/merchants","href":"/api-reference/products/list-merchants"},{"title":"Create Products","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/create","href":"/api-reference/products/create-products"},{"title":"Update Products","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/update","href":"/api-reference/products/update-products"},{"title":"Delete Products","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /products/delete","href":"/api-reference/products/delete-products"},{"title":"List Categories","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /categories","href":"/api-reference/products/list-categories"},{"title":"Create Categories","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /categories/create","href":"/api-reference/products/create-categories"},{"title":"Update Categories","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /categories/update","href":"/api-reference/products/update-categories"},{"title":"Delete Categories","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /categories/delete","href":"/api-reference/products/delete-categories"},{"title":"List Global Brands","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /global-brands","href":"/api-reference/products/list-global-brands"},{"title":"Create Global Brand","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /global-brands","href":"/api-reference/products/create-global-brand"}]},{"group":"Actions","pages":[{"title":"List Actions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /actions/list","href":"/api-reference/actions/list-actions"},{"title":"Get Action","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /actions/detail","href":"/api-reference/actions/get-action"},{"title":"List Action Platforms","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /actions/platforms","href":"/api-reference/actions/list-action-platforms"},{"title":"Create Actions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /actions/create","href":"/api-reference/actions/create-actions"},{"title":"Update Actions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /actions/update","href":"/api-reference/actions/update-actions"},{"title":"Delete Actions","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /actions/delete","href":"/api-reference/actions/delete-actions"},{"title":"Update Action Status","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /actions/status","href":"/api-reference/actions/update-action-status"},{"title":"Set Action Step Completion","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /actions/steps/completion","href":"/api-reference/actions/set-action-step-completion"}]},{"group":"Brand Perception","pages":[{"title":"Get Brand Perception Attributes","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/brand-attributes","href":"/api-reference/brand-perception/get-brand-perception-attributes"},{"title":"Get Brand Perception Attribute Rankings","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/attribute-rankings","href":"/api-reference/brand-perception/get-brand-perception-attribute-rankings"},{"title":"Get Brand Perception Attribute Sources","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/attribute-sources","href":"/api-reference/brand-perception/get-brand-perception-attribute-sources"},{"title":"Get Brand Perception Attribute History","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/attribute-history","href":"/api-reference/brand-perception/get-brand-perception-attribute-history"},{"title":"Get Brand Perception Competitive Breakdown","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/competitive-breakdown","href":"/api-reference/brand-perception/get-brand-perception-competitive-breakdown"},{"title":"Get Brand Perception Objections","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/objections","href":"/api-reference/brand-perception/get-brand-perception-objections"},{"title":"Get Brand Perception Objection Sources","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/objection-sources","href":"/api-reference/brand-perception/get-brand-perception-objection-sources"},{"title":"Get Brand Perception Fact-Checking Verdicts","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/fact-checking-verdicts","href":"/api-reference/brand-perception/get-brand-perception-fact-checking-verdicts"},{"title":"Get Brand Perception Claim Sources","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/claim-sources","href":"/api-reference/brand-perception/get-brand-perception-claim-sources"},{"title":"List Facts","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /facts","href":"/api-reference/brand-perception/list-facts"},{"title":"Create Facts","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /facts/create","href":"/api-reference/brand-perception/create-facts"},{"title":"Update Facts","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /facts/update","href":"/api-reference/brand-perception/update-facts"},{"title":"Delete Facts","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /facts/delete","href":"/api-reference/brand-perception/delete-facts"},{"title":"List Brand Perception Industries","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/industries","href":"/api-reference/brand-perception/list-brand-perception-industries"},{"title":"List Brand Perception Attribute Clusters","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /brand-perception/attribute-clusters","href":"/api-reference/brand-perception/list-brand-perception-attribute-clusters"},{"title":"Edit Brand Perception Attribute Clusters","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /brand-perception/attribute-clusters/edit","href":"/api-reference/brand-perception/edit-brand-perception-attribute-clusters"},{"title":"Create Brand Perception Attribute Clusters","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /brand-perception/attribute-clusters/create","href":"/api-reference/brand-perception/create-brand-perception-attribute-clusters"}]},{"group":"Agent Analytics","pages":[{"title":"Get Agent Readiness","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /agent-analytics/readiness","href":"/api-reference/agent-analytics/get-agent-readiness"},{"title":"Request Agent Readiness Audits","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /agent-analytics/readiness/audits","href":"/api-reference/agent-analytics/request-agent-readiness-audits"},{"title":"Get AI Referrals","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /agent-analytics/google-analytics/referrals","href":"/api-reference/agent-analytics/get-ai-referrals"},{"title":"List Referral Sources","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /agent-analytics/google-analytics/list-referral-sources","href":"/api-reference/agent-analytics/list-referral-sources"}]},{"group":"Company","pages":[{"title":"List Projects","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json get /projects","href":"/api-reference/company/list-projects"},{"title":"Create Project","deprecated":null,"version":null,"openapi":"https://api.peec.ai/customer/v1/openapi/json post /projects","href":"/api-reference/company/create-project"}]}]}]},{"tab":"Research","hidden":true,"searchable":true,"pages":[{"title":"Research","href":"/research/ai-bot-types"}]}]},"basePath":"","title":"Get Brands Report - Peec.ai Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}