Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes relative_mention_rate: the entry’s mentions as a percentage of responses that mention at least one tracked brand.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AthenaHQ","colors":{"primary":"#4f39f6","light":"#7c86ff","dark":"#4f39f6"},"logo":{"light":"https://mintcdn.com/athenahq/L9mnbtCFYX94d6KY/logo/ahq_logo.svg?fit=max\u0026auto=format\u0026n=L9mnbtCFYX94d6KY\u0026q=85\u0026s=e929a8fbe48ea55a88a26164326a1b68","dark":"https://mintcdn.com/athenahq/L9mnbtCFYX94d6KY/logo/ahq_logo.svg?fit=max\u0026auto=format\u0026n=L9mnbtCFYX94d6KY\u0026q=85\u0026s=e929a8fbe48ea55a88a26164326a1b68"},"favicon":"https://mintcdn.com/athenahq/l-RALGQGlLg9vCM3/favicon.ico?fit=max\u0026auto=format\u0026n=l-RALGQGlLg9vCM3\u0026q=85\u0026s=902f75ca9d61dedcf06910b630c2349b","navbar":{"links":[{"href":"mailto:support@athenahq.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.athenahq.ai/settings/api"}},"footer":{"socials":{"website":"https://athenahq.ai","linkedin":"https://linkedin.com/company/athena-hq"}},"contextual":{"options":["copy","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"getting-started/setup"},{"language":"es","default":false,"navbar":{"links":[{"href":"mailto:support@athenahq.ai","label":"Soporte"}],"primary":{"type":"button","label":"Panel","href":"https://app.athenahq.ai/settings/api"}},"href":"es/getting-started/setup"},{"language":"fr","default":false,"navbar":{"links":[{"href":"mailto:support@athenahq.ai","label":"Assistance"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://app.athenahq.ai/settings/api"}},"href":"fr/getting-started/setup"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"athenahq","hasAudioNarration":false,"actualSubdomain":"athenahq","customDomains":["docs.athenahq.ai"],"gitSource":{"type":"github","owner":"ay-ay-ay-ay","repo":"athenahq","deployBranch":"main","contentDirectory":"docs-api","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6aee06954549cdf23e03eba9","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"en","tag":"API Reference","count":134},{"language":"es","tag":"Referencia de la API","count":134},{"language":"fr","tag":"Référence de l’API","count":134},{"language":"en","tag":"Documentation","count":57},{"language":"es","tag":"Documentación","count":57},{"language":"fr","tag":"Documentation","count":57},{"language":"en","tag":"Page Reference","count":49},{"language":"es","tag":"Referencia de páginas","count":49},{"language":"fr","tag":"Référence des pages","count":49},{"language":"en","tag":"Content \u0026 Knowledge","count":43},{"language":"es","tag":"Contenido y conocimiento","count":43},{"language":"fr","tag":"Contenu et connaissances","count":43},{"language":"en","tag":"Core Resources","count":34},{"language":"es","tag":"Recursos principales","count":34},{"language":"fr","tag":"Ressources principales","count":34},{"language":"en","tag":"Administration","count":32},{"language":"es","tag":"Administración","count":32},{"language":"fr","tag":"Administration","count":32},{"language":"en","tag":"Content Hub","count":19},{"language":"es","tag":"Centro de contenido","count":19},{"language":"fr","tag":"Content Hub","count":19},{"language":"en","tag":"Analytics","count":16},{"language":"es","tag":"Analítica","count":16},{"language":"fr","tag":"Analyses","count":16},{"language":"en","tag":"Knowledge Base","count":15},{"language":"es","tag":"Base de conocimientos","count":15},{"language":"fr","tag":"Base de connaissances","count":15},{"language":"en","tag":"Members","count":12},{"language":"es","tag":"Miembros","count":12},{"language":"fr","tag":"Membres","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/metrics/cumulative-share-of-voice","slug":"/api-reference/metrics/cumulative-share-of-voice","pageMetadata":{"title":"Cumulative Share of Voice","description":"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes `relative_mention_rate`: the entry's mentions as a percentage of responses that mention at least one tracked brand.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/share-of-voice/cumulative","href":"/api-reference/metrics/cumulative-share-of-voice","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes \", _jsx(_components.code, {\n children: \"relative_mention_rate\"\n }), \": the entry’s mentions as a percentage of responses that mention at least one tracked brand.\"]\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":"Cumulative Share of Voice","description":"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes `relative_mention_rate`: the entry's mentions as a percentage of responses that mention at least one tracked brand.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/share-of-voice/cumulative","href":"/api-reference/metrics/cumulative-share-of-voice","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Metrics"],"summary":"Cumulative Share of Voice","description":"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes `relative_mention_rate`: the entry's mentions as a percentage of responses that mention at least one tracked brand.","operationId":"getCumulativeSOV","security":["12dcf68c-b45b-448b-a4af-516edaf61062"],"requestBody":"60f6bceb-5916-4d58-8d36-7421b420c576","responses":{"200":"11c59fce-e3c2-4e53-908e-9fe07b315654","400":"1de252bb-996e-4cba-aa5e-ddf4d13ab73d","401":"623d7f85-2eec-4f2b-bbfd-3a22393f8fce","403":"3ebb1f31-490e-40be-b411-896c75ac894a","404":"613f81c0-4f4d-430e-ad11-f011ff3d1827","500":"9f216d41-f5b6-4419-9c48-8f3262311d4c"},"method":"post","type":"path","servers":["90885314-6248-4e0c-9577-887220ce4051"],"path":"/api/v1/metrics/share-of-voice/cumulative","baseUrlOptions":["https://api.athenahq.ai"],"title":"Cumulative Share of Voice","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for share of voice endpoints","required":["website_id","filters"],"properties":{"website_id":{"type":"string","format":"uuid","description":"The ID of the website to query share of voice for","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"website_id","typeLabel":"string\u003cuuid>"},"filters":{"type":"object","description":"Filters for the metrics endpoints: the shared response filters plus an optional saved view.","required":["start_date"],"properties":{"start_date":{"type":"string","format":"date-time","description":"Filter start date (UTC)","example":"2024-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"filters.start_date","typeLabel":"string\u003cdate-time>"},"schedule_id":{"oneOf":[{"type":"string","description":"Select one streaming schedule. Use the selection returned by GET /api/v1/prompt-schedules. Default includes all pre-cutover history and ad hoc runs; archived schedules retain results. The retired manual token is accepted as an alias of default. This field takes one schedule; a list returns 400.","default":"default","enum":["default","manual"],"uniqueKey":"filters.schedule_id.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Select one streaming schedule. Use the selection returned by GET /api/v1/prompt-schedules. Default includes all pre-cutover history and ad hoc runs; archived schedules retain results. The retired manual token is accepted as an alias of default. This field takes one schedule; a list returns 400.","format":"uuid","default":"default","uniqueKey":"filters.schedule_id.oneOf.1","typeLabel":"string\u003cuuid>"}],"uniqueKey":"filters.schedule_id","typeLabel":"enum\u003cstring> | string\u003cuuid>"},"end_date":{"type":"string","format":"date-time","description":"Filter end date (UTC)","example":"2024-12-31T23:59:59.999Z","uniqueKey":"filters.end_date","typeLabel":"string\u003cdate-time>"},"models":{"type":"array","description":"Filter by AI models","items":{"type":"string","enum":["chatgpt","perplexity","gemini","google_ai_overview","copilot","claude","ai_mode","grok","deepseek","meta_ai","mistral"],"uniqueKey":"filters.models.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["chatgpt","perplexity"],"uniqueKey":"filters.models","typeLabel":"enum\u003cstring>[]"},"prompt_ids":{"type":"array","description":"Filter by specific prompt IDs","items":{"type":"string","format":"uuid","uniqueKey":"filters.prompt_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"filters.prompt_ids","typeLabel":"string\u003cuuid>[]"},"competitor_ids":{"type":"array","description":"Filter by specific competitor IDs","items":{"type":"string","format":"uuid","uniqueKey":"filters.competitor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"filters.competitor_ids","typeLabel":"string\u003cuuid>[]"},"location_ids":{"type":"array","description":"Filter by location IDs. Pass this in the JSON body as `filters.location_ids`, even when filtering by a single location. Use IDs returned by `GET /api/v1/locations`.","items":{"type":"string","format":"uuid","uniqueKey":"filters.location_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"example":["123e4567-e89b-12d3-a456-426614174111"],"uniqueKey":"filters.location_ids","typeLabel":"string\u003cuuid>[]"},"prompt_status":{"type":"string","enum":["active","paused"],"description":"Filter by prompt status","uniqueKey":"filters.prompt_status","typeLabel":"enum\u003cstring>"},"prompt_type":{"type":"string","enum":["branded","non_branded"],"description":"Filter by prompt type","uniqueKey":"filters.prompt_type","typeLabel":"enum\u003cstring>"},"saved_view_id":{"type":"string","format":"uuid","description":"A saved view to apply, from `GET /api/v1/saved-views`. Its filters apply the way the dashboard applies them, including the dashboard's defaults of active prompts and every model. Any filter you also send replaces the view's value for that field. The view's saved date range is ignored: `start_date` and `end_date` decide the window. Returns `404` when the view is not on `website_id`, and `400` naming any view filter the API cannot apply, which you can replace by sending that filter explicitly.","example":"123e4567-e89b-12d3-a456-426614174222","uniqueKey":"filters.saved_view_id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"filters","typeLabel":"object"}},"example":{"website_id":"123e4567-e89b-12d3-a456-426614174000","filters":{"start_date":"2024-01-01T00:00:00.000Z","end_date":"2024-01-31T23:59:59.999Z","location_ids":["123e4567-e89b-12d3-a456-426614174111"]}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"website_id":"123e4567-e89b-12d3-a456-426614174000","filters":{"start_date":"2024-01-01T00:00:00.000Z","end_date":"2024-01-31T23:59:59.999Z","location_ids":["123e4567-e89b-12d3-a456-426614174111"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"11c59fce-e3c2-4e53-908e-9fe07b315654":{"description":"Successful response with share of voice data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","description":"A share of voice entry showing brand/competitor visibility","required":["name","value","relative_mention_rate","absolute_value","is_self"],"properties":{"name":{"type":"string","description":"Brand or competitor name","example":"Acme Corp","isRequired":true,"uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"value":{"type":"number","description":"Share of voice percentage (0-100)","example":33.3,"isRequired":true,"uniqueKey":"data.items.[INDEX].value","typeLabel":"number"},"relative_mention_rate":{"type":"number","description":"Relative mention rate percentage (0-100): mentions of this brand/competitor divided by the number of responses that mention at least one tracked brand","example":40,"isRequired":true,"uniqueKey":"data.items.[INDEX].relative_mention_rate","typeLabel":"number"},"absolute_value":{"type":"integer","description":"Raw mention count","example":150,"isRequired":true,"uniqueKey":"data.items.[INDEX].absolute_value","typeLabel":"integer"},"is_self":{"type":"boolean","description":"True if this entry represents your tracked website","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].is_self","typeLabel":"boolean"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"example":{"data":[{"name":"Acme Corp","value":33.3,"relative_mention_rate":40,"absolute_value":150,"is_self":true},{"name":"Competitor Inc","value":26.7,"relative_mention_rate":32,"absolute_value":120,"is_self":false}]},"examples":{"Example":{"title":"Example","value":{"data":[{"name":"Acme Corp","value":33.3,"relative_mention_rate":40,"absolute_value":150,"is_self":true},{"name":"Competitor Inc","value":26.7,"relative_mention_rate":32,"absolute_value":120,"is_self":false}]}}},"exampleType":"examples"}},"exampleType":"examples"},"1de252bb-996e-4cba-aa5e-ddf4d13ab73d":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"Error response object","required":["error"],"properties":{"error":{"type":"string","description":"Error message describing what went wrong","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missing_website_id":{"title":"missing_website_id","value":{"error":"website_id: Required"}},"missing_filters":{"title":"missing_filters","value":{"error":"filters: Required"}}},"exampleType":"examples"}},"exampleType":"examples"},"623d7f85-2eec-4f2b-bbfd-3a22393f8fce":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","description":"Error response object","required":["error"],"properties":{"error":{"type":"string","description":"Error message describing what went wrong","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"3ebb1f31-490e-40be-b411-896c75ac894a":{"description":"Forbidden - You don't have access to this website","content":{"application/json":{"schema":{"type":"object","description":"Error response object","required":["error"],"properties":{"error":{"type":"string","description":"Error message describing what went wrong","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized access to this website"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized access to this website"}}},"exampleType":"examples"}},"exampleType":"examples"},"613f81c0-4f4d-430e-ad11-f011ff3d1827":{"description":"Website not found","content":{"application/json":{"schema":{"type":"object","description":"Error response object","required":["error"],"properties":{"error":{"type":"string","description":"Error message describing what went wrong","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Website not found"},"examples":{"Example":{"title":"Example","value":{"error":"Website not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"9f216d41-f5b6-4419-9c48-8f3262311d4c":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Error response object","required":["error"],"properties":{"error":{"type":"string","description":"Error message describing what went wrong","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"12dcf68c-b45b-448b-a4af-516edaf61062":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. You can create one [here](https://app.athenahq.ai/organization?tab=api).","scopes":[],"schemeName":"apiKey"}}},"servers":{"90885314-6248-4e0c-9577-887220ce4051":{"url":"https://api.athenahq.ai","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. You can create one [here](https://app.athenahq.ai/organization?tab=api).","scopes":[],"schemeName":"apiKey"},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. You can create one [here](https://app.athenahq.ai/organization?tab=api).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-api-key"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"athenahq","siteName":"AthenaHQ","title":"Cumulative Share of Voice - AthenaHQ","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/metrics/cumulative-share-of-voice","matchLevel":0},"es":{"href":"/es/api-reference/metrics/cumulative-share-of-voice","matchLevel":1},"fr":{"href":"/fr/api-reference/metrics/cumulative-share-of-voice","matchLevel":1}}},"lastModified":"2026-11-06T07:22:17.239Z","originalFileLocation":"api-reference/metrics/cumulative-share-of-voice.mdx","locale":"en"},"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=\"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes relative_mention_rate: the entry\u0026#x27;s mentions as a percentage of responses that mention at least one tracked brand.\">\u003cmeta data-mint-head name=\"application-name\" content=\"AthenaHQ\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/athenahq/CgBKLUlhcFuNVwLc/_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/athenahq/CgBKLUlhcFuNVwLc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/athenahq/CgBKLUlhcFuNVwLc/_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/athenahq/CgBKLUlhcFuNVwLc/_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/athenahq/CgBKLUlhcFuNVwLc/_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/athenahq/CgBKLUlhcFuNVwLc/_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/athenahq/CgBKLUlhcFuNVwLc/_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/athenahq/CgBKLUlhcFuNVwLc/_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/athenahq/CgBKLUlhcFuNVwLc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cumulative Share of Voice - AthenaHQ\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes relative_mention_rate: the entry\u0026#x27;s mentions as a percentage of responses that mention at least one tracked brand.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AthenaHQ\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://athenahq.mintlify.site/_mintlify/api/og/v2?division=Share+of+Voice\u0026amp;title=Cumulative+Share+of+Voice\u0026amp;description=Returns+aggregated+share+of+voice+percentages+across+the+specified+date+range.+Shows+what+percentage+of+AI+responses+mention+your+brand+versus+competitors.+Each\u0026amp;theme=0b3a918be6754723090d9161\u0026amp;signature=4093b7a95708df3b7bea057b38d9d0c14733da55cb5a5bd55344c2fbfddd64fd\">\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=\"Cumulative Share of Voice - AthenaHQ\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes relative_mention_rate: the entry\u0026#x27;s mentions as a percentage of responses that mention at least one tracked brand.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://athenahq.mintlify.site/_mintlify/api/og/v2?division=Share+of+Voice\u0026amp;title=Cumulative+Share+of+Voice\u0026amp;description=Returns+aggregated+share+of+voice+percentages+across+the+specified+date+range.+Shows+what+percentage+of+AI+responses+mention+your+brand+versus+competitors.+Each\u0026amp;theme=0b3a918be6754723090d9161\u0026amp;signature=4093b7a95708df3b7bea057b38d9d0c14733da55cb5a5bd55344c2fbfddd64fd\">\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/athenahq/CgBKLUlhcFuNVwLc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AthenaHQ\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4f39f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice\">\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/cumulative-share-of-voice.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.athenahq.ai/es/api-reference/metrics/cumulative-share-of-voice\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.athenahq.ai/fr/api-reference/metrics/cumulative-share-of-voice\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.athenahq.ai/#organization\",\"name\":\"AthenaHQ\",\"url\":\"https://docs.athenahq.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/athenahq/L9mnbtCFYX94d6KY/logo/ahq_logo.svg?fit=max\u0026auto=format\u0026n=L9mnbtCFYX94d6KY\u0026q=85\u0026s=e929a8fbe48ea55a88a26164326a1b68\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.athenahq.ai#website\",\"name\":\"AthenaHQ\",\"url\":\"https://docs.athenahq.ai\",\"publisher\":{\"@id\":\"https://docs.athenahq.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice#webpage\",\"url\":\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice\",\"name\":\"Cumulative Share of Voice\",\"description\":\"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes relative_mention_rate: the entry's mentions as a percentage of responses that mention at least one tracked brand.\",\"dateModified\":\"2026-11-06T07:22:17.239Z\",\"isPartOf\":{\"@id\":\"https://docs.athenahq.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Analytics\",\"item\":\"https://docs.athenahq.ai/api-reference/attributes/list-attributes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cumulative Share of Voice\",\"item\":\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice#apireference\",\"headline\":\"Cumulative Share of Voice\",\"name\":\"Cumulative Share of Voice\",\"description\":\"Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes relative_mention_rate: the entry's mentions as a percentage of responses that mention at least one tracked brand.\",\"url\":\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice\",\"mainEntityOfPage\":{\"@id\":\"https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice#webpage\"},\"dateModified\":\"2026-11-06T07:22:17.239Z\",\"publisher\":{\"@id\":\"https://docs.athenahq.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.athenahq.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AthenaHQ\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AthenaHQ","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/setup"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"Introduction","icon":"book","href":"/api-reference/introduction"},{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Single Sign-On (SSO)","icon":"lock","href":"/api-reference/sso"},{"title":"Rate Limits","icon":"gauge","href":"/api-reference/rate-limits"},{"title":"Changelog","icon":"clock-rotate-left","href":"/api-reference/changelog"}]},{"group":"Integrations","pages":[{"title":"MCP Server","icon":"plug","href":"/api-reference/mcp"},{"title":"Looker Studio","icon":"chart-line","href":"/api-reference/looker-studio"},{"title":"Power BI \u0026 Microsoft Fabric","icon":"chart-column","href":"/api-reference/powerbi-fabric"},{"title":"Saved view exports","icon":"file-export","href":"/api-reference/saved-view-exports"}]},{"group":"Core Resources","pages":[{"group":"Utilities","pages":[{"title":"Validate API Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/validate-api-key","href":"/api-reference/basics/validate-api-key"},{"title":"Get Date Range","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/date-range","href":"/api-reference/basics/get-date-range"},{"title":"Query Looker Studio report data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/looker-studio/data","href":"/api-reference/analytics/query-looker-studio-report-data"}]},{"group":"Websites","pages":[{"title":"Get Websites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/websites","href":"/api-reference/basics/get-websites"},{"title":"Create Website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/websites","href":"/api-reference/basics/create-website"},{"title":"Provision Website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/websites/provision","href":"/api-reference/basics/provision-website"},{"title":"Update Website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/websites/{website_id}","href":"/api-reference/basics/update-website"},{"title":"Delete Website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/websites/{website_id}/delete","href":"/api-reference/basics/delete-website"},{"title":"Restore Website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/websites/{website_id}/restore","href":"/api-reference/basics/restore-website"}]},{"group":"Prompts","pages":[{"title":"Get Prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/prompts","href":"/api-reference/basics/get-prompts"},{"title":"Create Prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/prompts","href":"/api-reference/basics/create-prompts"},{"title":"Update Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/prompts/{prompt_id}","href":"/api-reference/basics/update-prompt"},{"title":"Pause or Unpause Prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/prompts/status","href":"/api-reference/basics/pause-or-unpause-prompts"},{"title":"Delete Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/prompts/{prompt_id}","href":"/api-reference/basics/delete-prompt"},{"title":"Get Prompt Tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/prompt-tags","href":"/api-reference/basics/get-prompt-tags"},{"title":"List prompt schedules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/prompt-schedules","href":"/api-reference/basics/list-prompt-schedules"}]},{"group":"API Keys","pages":[{"title":"List API Keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/api-keys","href":"/api-reference/basics/list-api-keys"}]},{"group":"Activity","pages":[{"title":"List Activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/activity","href":"/api-reference/basics/list-activity"}]},{"group":"Topics","pages":[{"title":"Get Topics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/topics","href":"/api-reference/basics/get-topics"},{"title":"Create Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/topics","href":"/api-reference/basics/create-topic"},{"title":"Update Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/topics/{topic_id}","href":"/api-reference/basics/update-topic"},{"title":"Delete Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/topics/{topic_id}","href":"/api-reference/basics/delete-topic"}]},{"group":"Personas \u0026 Competitors","pages":[{"title":"Get Personas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/personas","href":"/api-reference/basics/get-personas"},{"title":"Get Competitors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/competitors","href":"/api-reference/basics/get-competitors"},{"title":"Get Identifiers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/identifiers","href":"/api-reference/basics/get-identifiers"}]},{"group":"Locations","pages":[{"title":"Get Locations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/locations","href":"/api-reference/basics/get-locations"},{"title":"Create Location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/locations","href":"/api-reference/basics/create-location"},{"title":"Update Location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/locations/{location_id}","href":"/api-reference/basics/update-location"},{"title":"Delete Location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/locations/{location_id}","href":"/api-reference/basics/delete-location"}]},{"group":"Responses","pages":[{"title":"Query Responses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/responses","href":"/api-reference/basics/query-responses"},{"title":"Start Response Streaming","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/response-streaming/start","href":"/api-reference/basics/start-response-streaming"},{"title":"Get Response Streaming Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/response-streaming/status","href":"/api-reference/basics/get-response-streaming-status"}]},{"group":"Saved Views","pages":[{"title":"Get Saved Views","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/saved-views","href":"/api-reference/basics/get-saved-views"},{"title":"Get Group Saved Views","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/group-saved-views","href":"/api-reference/basics/get-group-saved-views"}]}]},{"group":"Analytics","pages":[{"group":"Attributes","pages":[{"title":"List Attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/attributes","href":"/api-reference/attributes/list-attributes"},{"title":"Cumulative Attribute Metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/attributes/cumulative","href":"/api-reference/attributes/cumulative-attribute-metrics"},{"title":"Competitor Attribute Metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/attributes/competitors","href":"/api-reference/attributes/competitor-attribute-metrics"},{"title":"Attribute Time Series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/attributes/time-series","href":"/api-reference/attributes/attribute-time-series"},{"title":"Attribute Observations","description":"Returns individual brand trait observations: each row is one statement an AI response made about one entity (your brand or a competitor) for one attribute, with the supporting response excerpt as `text_span`. `score` runs from -1 to 1 and its sign always matches `positive`; its magnitude (0.1 to 1.0) is how strongly the wording praises or criticizes. `score` is `null` when the observation was not scored, because it was extracted before scoring existed or has no valid value. If you only need the direction, use `score ?? (positive ? 1 : -1)`. Omit `positive` for both directions. `sort: \"intensity\"` (the default) returns the strongest observations first with unscored ones last; `sort: \"recent\"` returns the newest first. A page can hold fewer than `page_size` rows when an excerpt is no longer available, so use `has_more` to decide whether to fetch the next page. Also available as the MCP tool `get_attribute_observations`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/attributes/observations","href":"/api-reference/attributes/attribute-observations"}]},{"group":"Share of Voice","pages":[{"title":"Cumulative Share of Voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/share-of-voice/cumulative","href":"/api-reference/metrics/cumulative-share-of-voice"},{"title":"Share of Voice Over Time","description":"Returns daily share of voice breakdown over the specified date range. Each entry contains the date and SOV percentages for your brand and competitors, plus each company's `relative_mention_rate`: its mentions as a percentage of that day's responses that mention at least one tracked brand.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/share-of-voice/time-series","href":"/api-reference/metrics/share-of-voice-over-time"}]},{"group":"Mention Rate","pages":[{"title":"Cumulative Mention Rate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/mention-rate/cumulative","href":"/api-reference/metrics/cumulative-mention-rate"},{"title":"Mention Rate Over Time","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/mention-rate/time-series","href":"/api-reference/metrics/mention-rate-over-time"}]},{"group":"Citation Rate","pages":[{"title":"Cumulative Citation Rate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/citation-rate/cumulative","href":"/api-reference/metrics/cumulative-citation-rate"},{"title":"Citation Rate Over Time","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/citation-rate/time-series","href":"/api-reference/metrics/citation-rate-over-time"}]},{"group":"Position","pages":[{"title":"Cumulative Position","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/position/cumulative","href":"/api-reference/metrics/cumulative-position"},{"title":"Position Over Time","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/position/time-series","href":"/api-reference/metrics/position-over-time"}]},{"group":"Shopping","pages":[{"title":"Shopping Metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/metrics/shopping","href":"/api-reference/metrics/shopping-metrics"}]},{"group":"AI Search Value","pages":[{"title":"AI Search Value","icon":"money-bill-trend-up","href":"/api-reference/ai-search-value"},{"title":"Get AI Search Value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/ai-search-value","href":"/api-reference/ai-search-value/get-ai-search-value"}]}]},{"group":"Content \u0026 Knowledge","pages":[{"group":"Content Hub","pages":[{"title":"List Content Hub Sheets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/content/sheets","href":"/api-reference/content/list-content-hub-sheets"},{"title":"List Tracked Content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content","href":"/api-reference/content/list-tracked-content"},{"title":"List Content Items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/content/items","href":"/api-reference/content/list-content-items"},{"title":"Get Content Detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/content/{content_id}","href":"/api-reference/content/get-content-detail"},{"title":"Per-Content Prompt Citation Breakdown","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/prompts","href":"/api-reference/content/per-content-prompt-citation-breakdown"},{"title":"Start Content Pipeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/generate","href":"/api-reference/content/start-content-pipeline"},{"title":"Get Content Pipeline Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/content/{content_id}/status","href":"/api-reference/content/get-content-pipeline-status"},{"title":"Get Content Draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/content/{content_id}/draft","href":"/api-reference/content/get-content-draft"},{"title":"Revise Content Brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/{content_id}/brief/revise","href":"/api-reference/content/revise-content-brief"},{"title":"Approve Content Brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/{content_id}/brief/approve","href":"/api-reference/content/approve-content-brief"},{"title":"Revise Content Draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/{content_id}/revise","href":"/api-reference/content/revise-content-draft"},{"title":"Edit Content Draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/{content_id}/edit","href":"/api-reference/content/edit-content-draft"},{"title":"List Content Versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/{content_id}/versions","href":"/api-reference/content/list-content-versions"},{"title":"Get Content Version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/content/{content_id}/versions/{version_id}","href":"/api-reference/content/get-content-version"},{"title":"Restore Content Version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/{content_id}/versions/{version_id}/restore","href":"/api-reference/content/restore-content-version"},{"title":"Mark Content as Published","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/{content_id}/publish","href":"/api-reference/content/mark-content-as-published"},{"title":"Track External URLs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/content/track","href":"/api-reference/content/track-external-urls"},{"title":"Rename Content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/content/{content_id}","href":"/api-reference/content/rename-content"},{"title":"Delete Content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/content/{content_id}","href":"/api-reference/content/delete-content"}]},{"group":"SEO Recommendations","pages":[{"title":"Submit SEO recommendations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/seo/recommendations","href":"/api-reference/seo-recommendations/submit-seo-recommendations"},{"title":"Get SEO recommendation job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/seo/recommendations/{job_id}","href":"/api-reference/seo-recommendations/get-seo-recommendation-job"}]},{"group":"Site Health","pages":[{"title":"List Site Health issues","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/seo/issues","href":"/api-reference/site-health/list-site-health-issues"},{"title":"List the pages a Site Health issue affects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/seo/issues/pages","href":"/api-reference/site-health/list-the-pages-a-site-health-issue-affects"},{"title":"Get Site Health analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/seo/analytics","href":"/api-reference/site-health/get-site-health-analytics"}]},{"group":"Knowledge Base","pages":[{"title":"Search Brand Facts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-base/facts/search","href":"/api-reference/knowledge-base/search-brand-facts"},{"title":"Get Brand Facts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-base/facts","href":"/api-reference/knowledge-base/get-brand-facts"},{"title":"Get Pillars","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-base/pillars","href":"/api-reference/knowledge-base/get-pillars"},{"title":"Get Pillar Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/knowledge-base/pillars/{pillar_id}/document","href":"/api-reference/knowledge-base/get-pillar-document"},{"title":"Add Brand Facts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-base/facts","href":"/api-reference/knowledge-base/add-brand-facts"},{"title":"Update Brand Fact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/knowledge-base/facts/{fact_id}","href":"/api-reference/knowledge-base/update-brand-fact"},{"title":"Delete Brand Facts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-base/facts/delete","href":"/api-reference/knowledge-base/delete-brand-facts"},{"title":"Move Brand Facts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-base/facts/move","href":"/api-reference/knowledge-base/move-brand-facts"},{"title":"Create Pillar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-base/pillars","href":"/api-reference/knowledge-base/create-pillar"},{"title":"Update Pillar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/knowledge-base/pillars/{pillar_id}","href":"/api-reference/knowledge-base/update-pillar"},{"title":"Delete Pillars","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-base/pillars/delete","href":"/api-reference/knowledge-base/delete-pillars"},{"title":"Merge Pillars","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/knowledge-base/pillars/merge","href":"/api-reference/knowledge-base/merge-pillars"}]},{"group":"Pitch Workspace","pages":[{"title":"Create a pitch report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/pitches","href":"/api-reference/pitch-workspace/create-a-pitch-report"},{"title":"List Pitches","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/pitches","href":"/api-reference/pitch-workspace/list-pitches"},{"title":"Get Pitch Report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/pitches/{pitch_id}","href":"/api-reference/pitch-workspace/get-pitch-report"}]},{"group":"Sources","pages":[{"title":"List Sources (by root domain)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/sources","href":"/api-reference/sources/list-sources-by-root-domain"},{"title":"List Source Pages (per URL)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/source-pages","href":"/api-reference/sources/list-source-pages-per-url"},{"title":"List YouTube Creators","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/sources/youtube-creators","href":"/api-reference/sources/list-youtube-creators"},{"title":"List YouTube Videos","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/sources/youtube-videos","href":"/api-reference/sources/list-youtube-videos"}]}]},{"group":"Administration","pages":[{"group":"Groups","pages":[{"title":"List Groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/groups","href":"/api-reference/groups/list-groups"},{"title":"Create Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/groups","href":"/api-reference/groups/create-group"},{"title":"Get Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/groups/{group_id}","href":"/api-reference/groups/get-group"},{"title":"Update Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/groups/{group_id}","href":"/api-reference/groups/update-group"}]},{"group":"Invites","pages":[{"title":"Create Invite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/invites","href":"/api-reference/team-management/create-invite"},{"title":"Bulk Invite to Websites or Groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/invites/bulk","href":"/api-reference/team-management/bulk-invite-to-websites-or-groups"},{"title":"Revoke Organization Invite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/invites/org/{invite_id}","href":"/api-reference/team-management/revoke-organization-invite"},{"title":"Revoke Website Invite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/invites/website/{invite_id}","href":"/api-reference/team-management/revoke-website-invite"}]},{"group":"Members","pages":[{"title":"List Organization Members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/organizations/members","href":"/api-reference/team-management/list-organization-members"},{"title":"List Website Members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/websites/{website_id}/members","href":"/api-reference/team-management/list-website-members"},{"title":"List Group Members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/groups/{group_id}/members","href":"/api-reference/team-management/list-group-members"},{"title":"Look Up User By Email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/users/by-email","href":"/api-reference/team-management/look-up-user-by-email"},{"title":"List User Websites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/users/{user_id}/websites","href":"/api-reference/team-management/list-user-websites"},{"title":"Remove User From Websites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/users/{user_id}/websites","href":"/api-reference/team-management/remove-user-from-websites"},{"title":"Update Organization Member Role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/organizations/members/{user_id}","href":"/api-reference/team-management/update-organization-member-role"},{"title":"Update Website Member Role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/websites/{website_id}/members/{user_id}","href":"/api-reference/team-management/update-website-member-role"},{"title":"Update Group Member Role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/groups/{group_id}/members/{user_id}","href":"/api-reference/team-management/update-group-member-role"},{"title":"Remove Group Member Access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/groups/{group_id}/members/{user_id}","href":"/api-reference/team-management/remove-group-member-access"},{"title":"Remove Organization Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/organizations/members/{user_id}","href":"/api-reference/team-management/remove-organization-member"},{"title":"Remove Website Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/websites/{website_id}/members/{user_id}","href":"/api-reference/team-management/remove-website-member"}]},{"group":"Roles","pages":[{"title":"List Roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/roles","href":"/api-reference/team-management/list-roles"},{"title":"Create Custom Role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/roles","href":"/api-reference/team-management/create-custom-role"},{"title":"Get Role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/roles/{role_id}","href":"/api-reference/team-management/get-role"},{"title":"Update Custom Role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/roles/{role_id}","href":"/api-reference/team-management/update-custom-role"},{"title":"Delete Custom Role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/roles/{role_id}","href":"/api-reference/team-management/delete-custom-role"}]},{"group":"Billing","pages":[{"title":"Get Website Credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/credits/website","href":"/api-reference/billing/get-website-credits"},{"title":"Get Organization Credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/credits/organization","href":"/api-reference/billing/get-organization-credits"},{"title":"Get Group Credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/credits/group","href":"/api-reference/billing/get-group-credits"},{"title":"Get Website Subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/subscriptions/website","href":"/api-reference/billing/get-website-subscription"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/subscriptions/cancel","href":"/api-reference/billing/cancel-subscription"}]},{"group":"AI Access","pages":[{"title":"AI Access","icon":"robot","href":"/api-reference/ai-access"},{"title":"Check AI accessibility for a domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/ai-access/check","href":"/api-reference/ai-access/check-ai-accessibility-for-a-domain"}]}]}]}]},{"language":"es","default":false,"navbar":{"links":[{"href":"mailto:support@athenahq.ai","label":"Soporte"}],"primary":{"type":"button","label":"Panel","href":"https://app.athenahq.ai/settings/api"}},"pages":[{"title":"es","href":"/es/api-reference/metrics/cumulative-share-of-voice"}]},{"language":"fr","default":false,"navbar":{"links":[{"href":"mailto:support@athenahq.ai","label":"Assistance"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://app.athenahq.ai/settings/api"}},"pages":[{"title":"fr","href":"/fr/api-reference/metrics/cumulative-share-of-voice"}]}]},"basePath":"","title":"Cumulative Share of Voice - AthenaHQ","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}