{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cognizo Docs","description":"Cognizo API and MCP Documentation. Track and grow your brand's visibility, share of voice, and sentiment across AI search engines like ChatGPT, Claude, Perplexity, and Google AI Overviews.","colors":{"primary":"#6C4CF1","light":"#8A6EF5","dark":"#4A2FD0"},"logo":{"light":"https://mintcdn.com/cognizo/x-lz_CTiDXjk7exn/images/cognizo-logo.png?fit=max\u0026auto=format\u0026n=x-lz_CTiDXjk7exn\u0026q=85\u0026s=beb92c1c8994be1c625caf4c4840ba0b","dark":"https://mintcdn.com/cognizo/x-lz_CTiDXjk7exn/images/cognizo-logo-dark.png?fit=max\u0026auto=format\u0026n=x-lz_CTiDXjk7exn\u0026q=85\u0026s=afa66996adab115482c97e8d5ba5ecd9","href":"https://docs.cognizo.ai"},"favicon":"https://mintcdn.com/cognizo/aQn_f7JfezHrAXFA/favicon.png?fit=max\u0026auto=format\u0026n=aQn_f7JfezHrAXFA\u0026q=85\u0026s=a77aea5ad0f9e341aa31106b5363b783","background":{"color":{"dark":"#0B081C"}},"navbar":{"links":[{"href":"https://cognizo.ai","label":"Website"},{"href":"https://help.cognizo.ai","label":"Help Center"},{"href":"https://www.cognizo.ai/blog","label":"Blog"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.cognizo.ai"}},"footer":{"socials":{"website":"https://cognizo.ai","linkedin":"https://linkedin.com/company/cognizo"}},"seo":{"indexing":"all"},"fonts":{"family":"Geist"},"icons":{"library":"fontawesome"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cognizo","hasAudioNarration":false,"actualSubdomain":"cognizo","customDomains":["docs.cognizo.ai"],"gitSource":{"type":"github","owner":"cognizo-ai","repo":"cognizo-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"29cee2e4-9777-4d4c-b42a-474cddc0af33","liveDeploymentHistoryId":"6ae4ed2bafc3f6fb7305af70","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4ed2bafc3f6fb7305af70"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae4ed2bafc3f6fb7305af70","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":79},{"language":"default","tag":"ContentStudio","count":13},{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Citations","count":8},{"language":"default","tag":"Prompts","count":8},{"language":"default","tag":"BrandActions","count":6},{"language":"default","tag":"Technical audit","count":6},{"language":"default","tag":"Brands","count":5},{"language":"default","tag":"Opportunities","count":5},{"language":"default","tag":"Topics","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"llms-txt-v2","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":"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":"vite-origin","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":"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}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/metrics/brand-level-sentiment-aggregate-+-time-series","slug":"/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series","pageMetadata":{"title":"Brand-level sentiment (aggregate + time series)","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/sentiment","href":"/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series","autogeneratedByOpenApi":true},"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":"Brand-level sentiment (aggregate + time series)","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/sentiment","href":"/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Brand-level sentiment (aggregate + time series)","tags":["Metrics"],"parameters":["ca1e8688-9c04-4838-aff0-076c8086d687","b63a6ea5-f318-4e61-a475-62883b7414bc","6bd3d69a-4905-4568-ad33-869c6ad46920","1cbfb1d0-47b4-4a0e-8afd-7b627ef58b54","45e2d073-9e9c-4cdd-bb3b-ae6faa34a1b0","0ded4c03-dea5-4e75-a1bd-02a12c44f9d0","c3465d30-3057-4de1-a46d-217662674b74","77002c6f-0bda-4136-a6b1-9a450c3fcfa4","e3a4e88d-4f54-48e0-b9c3-e6a9a74c0f1e","1ef5858c-6ee2-4d41-bd1a-29f264fa023e"],"responses":{"200":"63893517-11f7-4245-85f1-d2c6b2bf14db","403":"108a4d80-b431-460e-b18e-64709e4595e0","404":"ab76d1be-e7aa-4716-a7b2-1ed69a11057b","500":"706ebb21-34db-468f-a474-38e674ff03a4"},"operationId":"get_brand_sentiment","method":"get","type":"path","servers":["1a28411b-53fb-41ce-be43-58f79ba80bcf"],"security":["5b6dc2ab-64a5-4379-9221-a06e2aded3ed"],"path":"/api/v2/brands/{brand_id}/sentiment","baseUrlOptions":["https://core.cognizo.ai"],"title":"Brand-level sentiment (aggregate + time series)","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ca1e8688-9c04-4838-aff0-076c8086d687":{"name":"filter[target_brand]","in":"query","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"b63a6ea5-f318-4e61-a475-62883b7414bc":{"name":"filter[ran_at_start]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"6bd3d69a-4905-4568-ad33-869c6ad46920":{"name":"filter[ran_at_end]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"1cbfb1d0-47b4-4a0e-8afd-7b627ef58b54":{"name":"filter[granularity]","in":"query","required":false,"schema":{"type":"string","enum":["day","week","month"],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"45e2d073-9e9c-4cdd-bb3b-ae6faa34a1b0":{"name":"filter[brand_ids]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>[]"}},"0ded4c03-dea5-4e75-a1bd-02a12c44f9d0":{"name":"filter[provider_ids]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>[]"}},"c3465d30-3057-4de1-a46d-217662674b74":{"name":"filter[region_ids]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>[]"}},"77002c6f-0bda-4136-a6b1-9a450c3fcfa4":{"name":"filter[topic_ids]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>[]"}},"e3a4e88d-4f54-48e0-b9c3-e6a9a74c0f1e":{"name":"page","in":"query","required":false,"schema":{"type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"1ef5858c-6ee2-4d41-bd1a-29f264fa023e":{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"776a4bbe-c161-49b6-b6ee-04c1cdbf260b":{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"63893517-11f7-4245-85f1-d2c6b2bf14db":{"description":"metric envelope","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"metric_type":{"type":"string","enum":["visibility","share_of_voice","first_position","middle_position","last_position","sentiment","average_position"],"isRequired":true,"uniqueKey":"data.metric_type","typeLabel":"enum\u003cstring>"},"date_range":{"type":"array","items":{"type":"string","format":"date-time","uniqueKey":"data.date_range.items.[INDEX]","typeLabel":"string\u003cdate-time>"},"isRequired":true,"uniqueKey":"data.date_range","typeLabel":"string\u003cdate-time>[]"},"aggregate_metrics":{"type":"object","properties":{"start_date":{"type":"string","isRequired":true,"uniqueKey":"data.aggregate_metrics.start_date","typeLabel":"string"},"values":{"type":"array","items":{"type":"object","description":"One brand's value for the enclosing metric_type over the date range. The unit of `value` depends on metric_type — see the `value` field.","properties":{"domain":{"oneOf":[{"type":"string","description":"The company's domain as a bare hostname (\"redsift.com\") — scheme, www and path stripped — for the row's logo. Derived from the competitor record or the brand's attached domain, so it is null for a mapping that matches no tracked entity or one with no domain on file. Do not guess a logo from `brand_name` when this is null: a name search answers with whoever matches (core#453).","isRequired":true,"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The company's domain as a bare hostname (\"redsift.com\") — scheme, www and path stripped — for the row's logo. Derived from the competitor record or the brand's attached domain, so it is null for a mapping that matches no tracked entity or one with no domain on file. Do not guess a logo from `brand_name` when this is null: a name search answers with whoever matches (core#453).","isRequired":true,"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].domain","typeLabel":"string | null"},"value":{"oneOf":[{"type":"number","minimum":0,"description":"Metric value for this brand; the UNIT depends on metric_type. `visibility`, `share_of_voice`, and the position metrics (`first`/`middle`/`last`) are a 0–100 PERCENTAGE of the brand's runs (never null — 0 when there's no data). `sentiment` is the AVERAGE sentiment score on a 1–100 scale (NOT a percentage), and is null when the brand has no scored runs in the window. `average_position` is the brand's mean BEST position in the answers it appears in (>= 1, lower is better), null when it has no appearances in the window. It is never a raw count — do not re-aggregate it client-side.","isRequired":true,"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Metric value for this brand; the UNIT depends on metric_type. `visibility`, `share_of_voice`, and the position metrics (`first`/`middle`/`last`) are a 0–100 PERCENTAGE of the brand's runs (never null — 0 when there's no data). `sentiment` is the AVERAGE sentiment score on a 1–100 scale (NOT a percentage), and is null when the brand has no scored runs in the window. `average_position` is the brand's mean BEST position in the answers it appears in (>= 1, lower is better), null when it has no appearances in the window. It is never a raw count — do not re-aggregate it client-side.","isRequired":true,"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].value","typeLabel":"number | null"},"is_target":{"type":"boolean","description":"True for the workspace's own brand (the target); false for competitors.","isRequired":true,"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].is_target","typeLabel":"boolean"},"brand_name":{"oneOf":[{"type":"string","description":"Display name of the brand this row is for; null for unattributed rows.","uniqueKey":"data.aggregate_metrics.values.items.[INDEX].brand_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name of the brand this row is for; null for unattributed rows.","uniqueKey":"data.aggregate_metrics.values.items.[INDEX].brand_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].brand_name","typeLabel":"string | null"},"found_brand_id":{"oneOf":[{"type":"string","format":"uuid","description":"Canonical brand-mapping id; null when the brand isn't resolved to a mapping.","uniqueKey":"data.aggregate_metrics.values.items.[INDEX].found_brand_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Canonical brand-mapping id; null when the brand isn't resolved to a mapping.","uniqueKey":"data.aggregate_metrics.values.items.[INDEX].found_brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].found_brand_id","typeLabel":"string\u003cuuid> | null"},"diff":{"oneOf":[{"type":"number","description":"Change in `value` vs the previous equal-length period (same unit as `value`). Null when a prior value can't be computed.","uniqueKey":"data.aggregate_metrics.values.items.[INDEX].diff.oneOf.0","typeLabel":"number"},{"type":"null","description":"Change in `value` vs the previous equal-length period (same unit as `value`). Null when a prior value can't be computed.","uniqueKey":"data.aggregate_metrics.values.items.[INDEX].diff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].diff","typeLabel":"number | null"},"rank":{"oneOf":[{"type":"integer","description":"1-based rank of this brand by `value` within the metric (1 = highest; for `average_position` 1 = LOWEST, i.e. best). Present on aggregate rows; null when unranked.","uniqueKey":"data.aggregate_metrics.values.items.[INDEX].rank.oneOf.0","typeLabel":"integer"},{"type":"null","description":"1-based rank of this brand by `value` within the metric (1 = highest; for `average_position` 1 = LOWEST, i.e. best). Present on aggregate rows; null when unranked.","uniqueKey":"data.aggregate_metrics.values.items.[INDEX].rank.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.aggregate_metrics.values.items.[INDEX].rank","typeLabel":"integer | null"}},"required":["value","is_target","domain"],"uniqueKey":"data.aggregate_metrics.values.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.aggregate_metrics.values","typeLabel":"object[]"},"end_date":{"oneOf":[{"type":"string","uniqueKey":"data.aggregate_metrics.end_date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.aggregate_metrics.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.aggregate_metrics.end_date","typeLabel":"string | null"}},"required":["start_date","values"],"isRequired":true,"uniqueKey":"data.aggregate_metrics","typeLabel":"object"},"time_based_metrics":{"type":"array","items":{"type":"object","properties":{"start_date":{"type":"string","isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].start_date","typeLabel":"string"},"values":{"type":"array","items":{"type":"object","description":"One brand's value for the enclosing metric_type over the date range. The unit of `value` depends on metric_type — see the `value` field.","properties":{"domain":{"oneOf":[{"type":"string","description":"The company's domain as a bare hostname (\"redsift.com\") — scheme, www and path stripped — for the row's logo. Derived from the competitor record or the brand's attached domain, so it is null for a mapping that matches no tracked entity or one with no domain on file. Do not guess a logo from `brand_name` when this is null: a name search answers with whoever matches (core#453).","isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The company's domain as a bare hostname (\"redsift.com\") — scheme, www and path stripped — for the row's logo. Derived from the competitor record or the brand's attached domain, so it is null for a mapping that matches no tracked entity or one with no domain on file. Do not guess a logo from `brand_name` when this is null: a name search answers with whoever matches (core#453).","isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].domain","typeLabel":"string | null"},"value":{"oneOf":[{"type":"number","minimum":0,"description":"Metric value for this brand; the UNIT depends on metric_type. `visibility`, `share_of_voice`, and the position metrics (`first`/`middle`/`last`) are a 0–100 PERCENTAGE of the brand's runs (never null — 0 when there's no data). `sentiment` is the AVERAGE sentiment score on a 1–100 scale (NOT a percentage), and is null when the brand has no scored runs in the window. `average_position` is the brand's mean BEST position in the answers it appears in (>= 1, lower is better), null when it has no appearances in the window. It is never a raw count — do not re-aggregate it client-side.","isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Metric value for this brand; the UNIT depends on metric_type. `visibility`, `share_of_voice`, and the position metrics (`first`/`middle`/`last`) are a 0–100 PERCENTAGE of the brand's runs (never null — 0 when there's no data). `sentiment` is the AVERAGE sentiment score on a 1–100 scale (NOT a percentage), and is null when the brand has no scored runs in the window. `average_position` is the brand's mean BEST position in the answers it appears in (>= 1, lower is better), null when it has no appearances in the window. It is never a raw count — do not re-aggregate it client-side.","isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].value","typeLabel":"number | null"},"is_target":{"type":"boolean","description":"True for the workspace's own brand (the target); false for competitors.","isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].is_target","typeLabel":"boolean"},"brand_name":{"oneOf":[{"type":"string","description":"Display name of the brand this row is for; null for unattributed rows.","uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].brand_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name of the brand this row is for; null for unattributed rows.","uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].brand_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].brand_name","typeLabel":"string | null"},"found_brand_id":{"oneOf":[{"type":"string","format":"uuid","description":"Canonical brand-mapping id; null when the brand isn't resolved to a mapping.","uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].found_brand_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Canonical brand-mapping id; null when the brand isn't resolved to a mapping.","uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].found_brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].found_brand_id","typeLabel":"string\u003cuuid> | null"},"diff":{"oneOf":[{"type":"number","description":"Change in `value` vs the previous equal-length period (same unit as `value`). Null when a prior value can't be computed.","uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].diff.oneOf.0","typeLabel":"number"},{"type":"null","description":"Change in `value` vs the previous equal-length period (same unit as `value`). Null when a prior value can't be computed.","uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].diff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].diff","typeLabel":"number | null"},"rank":{"oneOf":[{"type":"integer","description":"1-based rank of this brand by `value` within the metric (1 = highest; for `average_position` 1 = LOWEST, i.e. best). Present on aggregate rows; null when unranked.","uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].rank.oneOf.0","typeLabel":"integer"},{"type":"null","description":"1-based rank of this brand by `value` within the metric (1 = highest; for `average_position` 1 = LOWEST, i.e. best). Present on aggregate rows; null when unranked.","uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].rank.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX].rank","typeLabel":"integer | null"}},"required":["value","is_target","domain"],"uniqueKey":"data.time_based_metrics.items.[INDEX].values.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.time_based_metrics.items.[INDEX].values","typeLabel":"object[]"},"end_date":{"oneOf":[{"type":"string","uniqueKey":"data.time_based_metrics.items.[INDEX].end_date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.time_based_metrics.items.[INDEX].end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.time_based_metrics.items.[INDEX].end_date","typeLabel":"string | null"}},"required":["start_date","values"],"uniqueKey":"data.time_based_metrics.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.time_based_metrics","typeLabel":"object[]"}},"required":["metric_type","date_range","aggregate_metrics","time_based_metrics"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"metric_type":"visibility","date_range":["2023-11-07T05:31:56Z"],"aggregate_metrics":{"start_date":"\u003cstring>","values":[{"domain":"\u003cstring>","value":1,"is_target":true,"brand_name":"\u003cstring>","found_brand_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","diff":123,"rank":123}],"end_date":"\u003cstring>"},"time_based_metrics":[{"start_date":"\u003cstring>","values":[{"domain":"\u003cstring>","value":1,"is_target":true,"brand_name":"\u003cstring>","found_brand_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","diff":123,"rank":123}],"end_date":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"108a4d80-b431-460e-b18e-64709e4595e0":{"description":"organization access revoked (ORGANIZATION_ACCESS_REVOKED): the access token's organization is no longer one of the user's memberships (they left, were removed, or the organization was deleted). The session itself is still valid: drop the organization's client state and refresh the session, which moves it to another organization.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable reason; see `error_code`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string | null"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","message","field"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"ab76d1be-e7aa-4716-a7b2-1ed69a11057b":{"description":"brand not found (NOT_FOUND): no such brand, or it belongs to another organization (the two are indistinguishable by design).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable reason; see `error_code`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string | null"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","message","field"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"706ebb21-34db-468f-a474-38e674ff03a4":{"description":"unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable machine-readable reason; see `error_code`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string | null"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","message","field"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5b6dc2ab-64a5-4379-9221-a06e2aded3ed":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[],"schemeName":"apiKey"}}},"servers":{"1a28411b-53fb-41ce-be43-58f79ba80bcf":{"url":"https://core.cognizo.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-KEY"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"cognizo","siteName":"Cognizo Docs","title":"Brand-level sentiment (aggregate + time series) - Cognizo Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T19:17:04.991Z","originalFileLocation":"api-reference/metrics/brand-level-sentiment-aggregate-+-time-series.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=\"application-name\" content=\"Cognizo 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/cognizo/gUxCvqimeXGJ3dX1/_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/cognizo/gUxCvqimeXGJ3dX1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cognizo/gUxCvqimeXGJ3dX1/_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/cognizo/gUxCvqimeXGJ3dX1/_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/cognizo/gUxCvqimeXGJ3dX1/_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/cognizo/gUxCvqimeXGJ3dX1/_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/cognizo/gUxCvqimeXGJ3dX1/_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/cognizo/gUxCvqimeXGJ3dX1/_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/cognizo/gUxCvqimeXGJ3dX1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Brand-level sentiment (aggregate + time series) - Cognizo Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cognizo Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cognizo.mintlify.app/_mintlify/api/og/v2?division=Metrics\u0026amp;title=Brand-level+sentiment+%28aggregate+%2B+time+series%29\u0026amp;theme=ba2aed5c62369492a9ac6532\u0026amp;signature=ef67276e6f77b8eb3091be1c79d5c63d8828465d4979d88c1f6f11eac2006d23\">\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=\"Brand-level sentiment (aggregate + time series) - Cognizo Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cognizo.mintlify.app/_mintlify/api/og/v2?division=Metrics\u0026amp;title=Brand-level+sentiment+%28aggregate+%2B+time+series%29\u0026amp;theme=ba2aed5c62369492a9ac6532\u0026amp;signature=ef67276e6f77b8eb3091be1c79d5c63d8828465d4979d88c1f6f11eac2006d23\">\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/cognizo/gUxCvqimeXGJ3dX1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cognizo Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6C4CF1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/metrics/brand-level-sentiment-aggregate-%2B-time-series.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cognizo.ai/#organization\",\"name\":\"Cognizo Docs\",\"url\":\"https://docs.cognizo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cognizo/x-lz_CTiDXjk7exn/images/cognizo-logo.png?fit=max\u0026auto=format\u0026n=x-lz_CTiDXjk7exn\u0026q=85\u0026s=beb92c1c8994be1c625caf4c4840ba0b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cognizo.ai#website\",\"name\":\"Cognizo Docs\",\"url\":\"https://docs.cognizo.ai\",\"publisher\":{\"@id\":\"https://docs.cognizo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series#webpage\",\"url\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series\",\"name\":\"Brand-level sentiment (aggregate + time series)\",\"dateModified\":\"2026-10-30T19:17:04.991Z\",\"isPartOf\":{\"@id\":\"https://docs.cognizo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Metrics\",\"item\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-visibility-aggregate-+-time-series\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Brand-level sentiment (aggregate + time series)\",\"item\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series#apireference\",\"headline\":\"Brand-level sentiment (aggregate + time series)\",\"name\":\"Brand-level sentiment (aggregate + time series)\",\"url\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cognizo.ai/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series#webpage\"},\"dateModified\":\"2026-10-30T19:17:04.991Z\",\"publisher\":{\"@id\":\"https://docs.cognizo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cognizo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cognizo Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cognizo Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"Brands","pages":[{"title":"List brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands","href":"/api-reference/brands/list-brands"},{"title":"Create (or reactivate) a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands","href":"/api-reference/brands/create-or-reactivate-a-brand"},{"title":"Get a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}","href":"/api-reference/brands/get-a-brand"},{"title":"Soft-delete a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/brands/{brand_id}","href":"/api-reference/brands/soft-delete-a-brand"},{"title":"Update a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/brands/{brand_id}","href":"/api-reference/brands/update-a-brand"}]},{"group":"Metrics","pages":[{"title":"Brand-level visibility (aggregate + time series)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/visibility","href":"/api-reference/metrics/brand-level-visibility-aggregate-+-time-series"},{"title":"Brand-level share of voice (aggregate + time series)","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/share_of_voice","href":"/api-reference/metrics/brand-level-share-of-voice-aggregate-+-time-series"},{"title":"Brand-level sentiment (aggregate + time series)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/sentiment","href":"/api-reference/metrics/brand-level-sentiment-aggregate-+-time-series"},{"title":"Brand-level average position (aggregate + time series)","description":"Mean best position of each brand in the AI answers it appears in: per answer the brand's highest listing counts once. 1.00 = always listed first; lower is better, and rank 1 is the lowest average. `value` is null for brands with no appearances in the window.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/average_position","href":"/api-reference/metrics/brand-level-average-position-aggregate-+-time-series"}]},{"group":"Topics","pages":[{"title":"List a brand's topics with their metrics and prompt counts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/topics","href":"/api-reference/topics/list-a-brands-topics-with-their-metrics-and-prompt-counts"},{"title":"Bulk-create topics (reactivates soft-deleted names)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/topics","href":"/api-reference/topics/bulk-create-topics-reactivates-soft-deleted-names"},{"title":"Get one topic with extended metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/topics/{topic_id}","href":"/api-reference/topics/get-one-topic-with-extended-metrics"},{"title":"Soft-delete a topic and deactivate its prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/brands/{brand_id}/topics/{topic_id}","href":"/api-reference/topics/soft-delete-a-topic-and-deactivate-its-prompts"},{"title":"Rename / soft-delete a topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/brands/{brand_id}/topics/{topic_id}","href":"/api-reference/topics/rename-soft-delete-a-topic"}]},{"group":"Prompts","pages":[{"title":"List a brand's prompts with their metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/prompts","href":"/api-reference/prompts/list-a-brands-prompts-with-their-metrics"},{"title":"Bulk-add prompts to a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/prompts","href":"/api-reference/prompts/bulk-add-prompts-to-a-brand"},{"title":"Bulk-edit prompts (move topic / soft delete / reactivate)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/brands/{brand_id}/prompts","href":"/api-reference/prompts/bulk-edit-prompts-move-topic-soft-delete-reactivate"},{"title":"Get a single prompt's metrics row","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/prompts/{prompt_id}/{region_id}","href":"/api-reference/prompts/get-a-single-prompts-metrics-row"},{"title":"Prompt-level visibility (aggregate + time series)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/prompts/{prompt_id}/{region_id}/visibility","href":"/api-reference/prompts/prompt-level-visibility-aggregate-+-time-series"},{"title":"Prompt-level share of voice (aggregate + time series)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/prompts/{prompt_id}/{region_id}/share_of_voice","href":"/api-reference/prompts/prompt-level-share-of-voice-aggregate-+-time-series"},{"title":"Prompt-level sentiment (aggregate + time series)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/prompts/{prompt_id}/{region_id}/sentiment","href":"/api-reference/prompts/prompt-level-sentiment-aggregate-+-time-series"},{"title":"Prompt-level average position (aggregate + time series)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/prompts/{prompt_id}/{region_id}/average_position","href":"/api-reference/prompts/prompt-level-average-position-aggregate-+-time-series"}]},{"group":"Citations","pages":[{"title":"Most-cited domains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/domains","href":"/api-reference/citations/most-cited-domains"},{"title":"Domain-level share overview (citation/mention series + type breakdown)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/domains/overview","href":"/api-reference/citations/domain-level-share-overview-citationmention-series-+-type-breakdown"},{"title":"Most-cited pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/pages","href":"/api-reference/citations/most-cited-pages"},{"title":"Page-level share overview (citation/mention series + page-type breakdown)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/pages/overview","href":"/api-reference/citations/page-level-share-overview-citationmention-series-+-page-type-breakdown"},{"title":"Citations overview (summary stats, distributions, top growing)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/overview","href":"/api-reference/citations/citations-overview-summary-stats-distributions-top-growing"},{"title":"Citation summary by domain type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/summary","href":"/api-reference/citations/citation-summary-by-domain-type"},{"title":"Owned-citation share time series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/citation_share","href":"/api-reference/citations/owned-citation-share-time-series"},{"title":"Brand-mention share time series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/mention_share","href":"/api-reference/citations/brand-mention-share-time-series"}]},{"group":"Competitors","pages":[{"title":"List tracked competitors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/competitors","href":"/api-reference/competitors/list-tracked-competitors"},{"title":"Track a competitor directly","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/competitors","href":"/api-reference/competitors/track-a-competitor-directly"},{"title":"Untrack a competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/brands/{brand_id}/competitors/{competitor_id}","href":"/api-reference/competitors/untrack-a-competitor"}]},{"group":"Competitor Suggestions","pages":[{"title":"List pending suggestions (last week, ranked by visibility)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/competitor_suggestions","href":"/api-reference/competitor-suggestions/list-pending-suggestions-last-week-ranked-by-visibility"},{"title":"Reject a suggestion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/brands/{brand_id}/competitor_suggestions/{suggestion_id}","href":"/api-reference/competitor-suggestions/reject-a-suggestion"},{"title":"Accept a suggestion and track the competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/competitor_suggestions/{suggestion_id}/accept","href":"/api-reference/competitor-suggestions/accept-a-suggestion-and-track-the-competitor"}]},{"group":"Ads","pages":[{"title":"List ads (distinct creatives) running on a brand's prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/ads","href":"/api-reference/ads/list-ads-distinct-creatives-running-on-a-brands-prompts"},{"title":"Ad-visibility breakdown by dimension","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/ads/breakdown","href":"/api-reference/ads/ad-visibility-breakdown-by-dimension"},{"title":"Single ad detail (with copy)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/ads/{ad_id}","href":"/api-reference/ads/single-ad-detail-with-copy"}]},{"group":"Advertisers","pages":[{"title":"List advertisers running ads on a brand's prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/advertisers","href":"/api-reference/advertisers/list-advertisers-running-ads-on-a-brands-prompts"},{"title":"Advertiser summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/advertisers/{advertiser_id}","href":"/api-reference/advertisers/advertiser-summary"},{"title":"Ads an advertiser ran","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/advertisers/{advertiser_id}/ads","href":"/api-reference/advertisers/ads-an-advertiser-ran"}]},{"group":"Filters","pages":[{"title":"List available regions with their ids and country codes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/regions","href":"/api-reference/filters/list-available-regions-with-their-ids-and-country-codes"}]},{"group":"ContentStudio","pages":[{"title":"List content recommendations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/content_studio/recommendations","href":"/api-reference/contentstudio/list-content-recommendations"},{"title":"List content briefs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/content_studio/briefs","href":"/api-reference/contentstudio/list-content-briefs"},{"title":"Create a custom brief (triggers async brief generation)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/content_studio/briefs","href":"/api-reference/contentstudio/create-a-custom-brief-triggers-async-brief-generation"},{"title":"Show one brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/content_studio/briefs/{id}","href":"/api-reference/contentstudio/show-one-brief"},{"title":"Soft-delete a brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/brands/{brand_id}/content_studio/briefs/{id}","href":"/api-reference/contentstudio/soft-delete-a-brief"},{"title":"Rename a content brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/brands/{brand_id}/content_studio/briefs/{id}","href":"/api-reference/contentstudio/rename-a-content-brief"},{"title":"Trigger async article generation from the finalized brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/content_studio/briefs/{id}/generate_article","href":"/api-reference/contentstudio/trigger-async-article-generation-from-the-finalized-brief"},{"title":"Show one article","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/content_studio/articles/{id}","href":"/api-reference/contentstudio/show-one-article"},{"title":"Update an article's content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/brands/{brand_id}/content_studio/articles/{id}","href":"/api-reference/contentstudio/update-an-articles-content"},{"title":"Soft-delete an article","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/brands/{brand_id}/content_studio/articles/{id}","href":"/api-reference/contentstudio/soft-delete-an-article"},{"title":"Get the brand's content guideline document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/content_studio/brand_guidelines","href":"/api-reference/contentstudio/get-the-brands-content-guideline-document"},{"title":"Update one or more sections of the brand guidelines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/brands/{brand_id}/content_studio/brand_guidelines","href":"/api-reference/contentstudio/update-one-or-more-sections-of-the-brand-guidelines"},{"title":"List a brand's feed leads (paginated, newest-first)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/content_studio/feed_leads","href":"/api-reference/contentstudio/list-a-brands-feed-leads-paginated-newest-first"}]},{"group":"Opportunities","pages":[{"title":"List opportunities for a brand (filterable, paginated, sortable)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/opportunities","href":"/api-reference/opportunities/list-opportunities-for-a-brand-filterable-paginated-sortable"},{"title":"Detail payload for a single opportunity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/opportunities/{id}","href":"/api-reference/opportunities/detail-payload-for-a-single-opportunity"},{"title":"Replace the opportunity's strategy-list memberships (multi-list)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/brands/{brand_id}/opportunities/{id}/lists","href":"/api-reference/opportunities/replace-the-opportunitys-strategy-list-memberships-multi-list"},{"title":"Current compute-worker state + daily quota snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/opportunities/compute","href":"/api-reference/opportunities/current-compute-worker-state-+-daily-quota-snapshot"},{"title":"Enqueue a per-brand opportunity recompute","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/opportunities/compute","href":"/api-reference/opportunities/enqueue-a-per-brand-opportunity-recompute"}]},{"group":"Opportunity Lists","pages":[{"title":"List the brand's strategy lists","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/opportunity_lists","href":"/api-reference/opportunity-lists/list-the-brands-strategy-lists"},{"title":"Create a new strategy list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/opportunity_lists","href":"/api-reference/opportunity-lists/create-a-new-strategy-list"},{"title":"Delete a strategy list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/brands/{brand_id}/opportunity_lists/{id}","href":"/api-reference/opportunity-lists/delete-a-strategy-list"},{"title":"Rename / recolor / reorder a strategy list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/brands/{brand_id}/opportunity_lists/{id}","href":"/api-reference/opportunity-lists/rename-recolor-reorder-a-strategy-list"}]},{"group":"BrandActions","pages":[{"title":"List this week's open decision cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/weekly_actions","href":"/api-reference/brandactions/list-this-weeks-open-decision-cards"},{"title":"The card's evidence pane — generic blocks behind the one-line description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/weekly_actions/{action_id}/details","href":"/api-reference/brandactions/the-cards-evidence-pane-—-generic-blocks-behind-the-one-line-description"},{"title":"Dismiss an action (the (type, source) pair never returns)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/weekly_actions/{action_id}/dismiss","href":"/api-reference/brandactions/dismiss-an-action-the-type-source-pair-never-returns"},{"title":"Complete an action (informational cards' \"Got it\")","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/weekly_actions/{action_id}/complete","href":"/api-reference/brandactions/complete-an-action-informational-cards-\"got-it\""},{"title":"Snooze an action to next week (\"Later\")","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/weekly_actions/{action_id}/snooze","href":"/api-reference/brandactions/snooze-an-action-to-next-week-\"later\""},{"title":"Restore a snoozed or dismissed action back onto the deck","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/weekly_actions/{action_id}/restore","href":"/api-reference/brandactions/restore-a-snoozed-or-dismissed-action-back-onto-the-deck"}]},{"group":"WeeklyTasks","pages":[{"title":"List this week's tasks — work in motion and work done","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/weekly_tasks","href":"/api-reference/weeklytasks/list-this-weeks-tasks-—-work-in-motion-and-work-done"}]},{"group":"Technical audit","pages":[{"title":"Technical audit summary for one domain: counts, the top problems to fix, and any run in progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/technical_audit","href":"/api-reference/technical-audit/technical-audit-summary-for-one-domain:-counts-the-top-problems-to-fix-and-any-run-in-progress"},{"title":"Start a technical audit on one domain; uses the monthly audit quota, then poll the summary until running is null","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/technical_audit","href":"/api-reference/technical-audit/start-a-technical-audit-on-one-domain;-uses-the-monthly-audit-quota-then-poll-the-summary-until-running-is-null"},{"title":"List the websites the brand can audit, with each one's latest technical audit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/technical_audit/domains","href":"/api-reference/technical-audit/list-the-websites-the-brand-can-audit-with-each-ones-latest-technical-audit"},{"title":"Add a website to audit (any site, e.g. a docs or regional site) without making it a brand domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/brands/{brand_id}/technical_audit/domains","href":"/api-reference/technical-audit/add-a-website-to-audit-any-site-eg-a-docs-or-regional-site-without-making-it-a-brand-domain"},{"title":"Every check of a domain's latest technical audit, with what was found and how to fix it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/technical_audit/checks","href":"/api-reference/technical-audit/every-check-of-a-domains-latest-technical-audit-with-what-was-found-and-how-to-fix-it"},{"title":"Pages a technical audit check flagged, most important first, with each page's fix","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/brands/{brand_id}/technical_audit/checks/{check_key}/pages","href":"/api-reference/technical-audit/pages-a-technical-audit-check-flagged-most-important-first-with-each-pages-fix"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"Brand-level sentiment (aggregate + time series) - Cognizo Docs","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}