Beta — behind the sonar-onboarding feature flag. Workspaces the flag is off for get 404 FEATURE_DISABLED.
An ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a low–high range and a band (quiet / standard / busy); read high for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in unverifiedSources — it is never counted as zero. additionalTerms / excludeWords are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.
Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Octolens","colors":{"primary":"#7551B5","light":"#9266CC","dark":"#553788"},"logo":"https://mintcdn.com/octolens/WNDsqX0Zcsk1Nv6R/logo.png?fit=max\u0026auto=format\u0026n=WNDsqX0Zcsk1Nv6R\u0026q=85\u0026s=3b4eb4dc59ef232691d1bfb70bd366ef","favicon":"https://mintcdn.com/octolens/WNDsqX0Zcsk1Nv6R/favicon.png?fit=max\u0026auto=format\u0026n=WNDsqX0Zcsk1Nv6R\u0026q=85\u0026s=8d4d87d123e6614f6f2b19d5d6dbc931","navbar":{"links":[{"href":"mailto:hi@octolens.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.octolens.com"}},"footer":{"socials":{"x":"https://x.com/Octolens","website":"https://octolens.com"}},"integrations":{"plausible":{"domain":"octolens.com"}},"contextual":{"options":["copy","view","chatgpt","claude",{"title":"Copy all docs as Markdown","description":"Full documentation including every API endpoint, for pasting into AI tools","icon":"books","href":"/llms-full.txt"}],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"octolens","hasAudioNarration":false,"actualSubdomain":"octolens","customDomains":["octolens.com"],"gitSource":{"type":"github","owner":"octolens","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6aed7fafcf04481e86d79d59","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":116},{"language":"default","tag":"API v2","count":115},{"language":"default","tag":"CLI","count":39},{"language":"default","tag":"Documentation","count":24},{"language":"default","tag":"Onboarding","count":18},{"language":"default","tag":"Analytics","count":12},{"language":"default","tag":"Integrations","count":11},{"language":"default","tag":"Keywords","count":11},{"language":"default","tag":"Concepts","count":10},{"language":"default","tag":"Commands","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","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":[{"filePath":"style.css","content":"@media (min-width: 1024px){#navbar-transition-maple{width:calc(100vw - 19rem)!important;max-width:calc(100vw - 19rem)!important}.nav-tabs{flex:1 1 auto;justify-content:center;padding-right:8rem}#octolens-go-to-app{position:fixed;right:1.5rem;top:0.5rem;z-index:50;display:inline-flex;align-items:center;gap:0.375rem;background:#553788;color:#fff;padding:0.375rem 0.875rem;border-radius:9999px;font-size:0.8125rem;font-weight:500;text-decoration:none;transition:background-color 0.15s ease;white-space:nowrap}#octolens-go-to-app:hover{background:#7551B5;color:#fff}#octolens-go-to-app svg{width:0.75rem;height:0.75rem}}@media (max-width: 1023px){#octolens-go-to-app{display:none}}"}],"page":{"pagePath":"api-reference/keywords/estimate-keyword-volume","slug":"/api-reference/keywords/estimate-keyword-volume","pageMetadata":{"title":"Estimate keyword volume","description":"**Beta — behind the `sonar-onboarding` feature flag.** Workspaces the flag is off for get `404 FEATURE_DISABLED`.\n\nAn ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a `low`–`high` range and a `band` (`quiet` / `standard` / `busy`); read `high` for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in `unverifiedSources` — it is never counted as zero. `additionalTerms` / `excludeWords` are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/keywords/estimate","href":"/api-reference/keywords/estimate-keyword-volume","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [_jsxs(_components.strong, {\n children: [\"Beta — behind the \", _jsx(_components.code, {\n children: \"sonar-onboarding\"\n }), \" feature flag.\"]\n }), \" Workspaces the flag is off for get \", _jsx(_components.code, {\n children: \"404 FEATURE_DISABLED\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a \", _jsx(_components.code, {\n children: \"low\"\n }), \"–\", _jsx(_components.code, {\n children: \"high\"\n }), \" range and a \", _jsx(_components.code, {\n children: \"band\"\n }), \" (\", _jsx(_components.code, {\n children: \"quiet\"\n }), \" / \", _jsx(_components.code, {\n children: \"standard\"\n }), \" / \", _jsx(_components.code, {\n children: \"busy\"\n }), \"); read \", _jsx(_components.code, {\n children: \"high\"\n }), \" for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in \", _jsx(_components.code, {\n children: \"unverifiedSources\"\n }), \" — it is never counted as zero. \", _jsx(_components.code, {\n children: \"additionalTerms\"\n }), \" / \", _jsx(_components.code, {\n children: \"excludeWords\"\n }), \" are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Estimate keyword volume","description":"**Beta — behind the `sonar-onboarding` feature flag.** Workspaces the flag is off for get `404 FEATURE_DISABLED`.\n\nAn ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a `low`–`high` range and a `band` (`quiet` / `standard` / `busy`); read `high` for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in `unverifiedSources` — it is never counted as zero. `additionalTerms` / `excludeWords` are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/keywords/estimate","href":"/api-reference/keywords/estimate-keyword-volume","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/octolens/e456fc9c822f0ecf/scripts.js"],"openApiReferenceData":{"operation":{"operationId":"estimateKeywordVolume","summary":"Estimate keyword volume","description":"**Beta — behind the `sonar-onboarding` feature flag.** Workspaces the flag is off for get `404 FEATURE_DISABLED`.\n\nAn ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a `low`–`high` range and a `band` (`quiet` / `standard` / `busy`); read `high` for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in `unverifiedSources` — it is never counted as zero. `additionalTerms` / `excludeWords` are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.","tags":["Keywords"],"x-required-scope":"read","security":["d9ab286a-7cdb-4b08-b643-cb9af2b193a5"],"requestBody":"edfa3585-379d-4f36-84b6-977c803845e8","responses":{"200":"c0e17bc0-9727-43f8-8e69-3e9443ebea25","400":"d1457fcc-c3e3-4bc1-a3d5-8af4b03449f5","401":"4d2ba2ac-fa5b-4aec-862b-2487be455150","403":"10275c75-7521-4ae3-a196-09b3ec7750a8","429":"847588bf-3a92-4981-b8fd-2874a8f8263e","500":"039820de-e741-4e85-8628-7a2fb819d340"},"method":"post","type":"path","servers":["95c85c73-69fc-4455-89ee-030232ddd6be","7edc9ee9-5b0a-4aa6-8470-691b1ed2a22a"],"path":"/api/v2/keywords/estimate","baseUrlOptions":["https://app.octolens.com","http://localhost:3000"],"title":"Estimate keyword volume","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"candidates":{"description":"One or many candidates, measured concurrently under one time budget.","minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"keyword":{"description":"The bare keyword to measure.","type":"string","minLength":1,"maxLength":191,"isRequired":true,"uniqueKey":"candidates.items.[INDEX].keyword","typeLabel":"string"},"additionalTerms":{"oneOf":[{"type":"string","description":"Comma-separated anchor terms that must co-occur. Evaluated locally on the bare sample — costs no extra fetch.","maxLength":2000,"uniqueKey":"candidates.items.[INDEX].additionalTerms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Comma-separated anchor terms that must co-occur. Evaluated locally on the bare sample — costs no extra fetch.","uniqueKey":"candidates.items.[INDEX].additionalTerms.oneOf.1","typeLabel":"null"}],"uniqueKey":"candidates.items.[INDEX].additionalTerms","typeLabel":"string | null"},"additionalTermsAndOr":{"description":"`false` (default) = ALL anchor terms, `true` = ANY of them.","type":"boolean","uniqueKey":"candidates.items.[INDEX].additionalTermsAndOr","typeLabel":"boolean"},"excludeWords":{"oneOf":[{"type":"string","description":"Comma-separated words that drop a mention. Evaluated locally on the bare sample — costs no extra fetch.","maxLength":2000,"uniqueKey":"candidates.items.[INDEX].excludeWords.oneOf.0","typeLabel":"string"},{"type":"null","description":"Comma-separated words that drop a mention. Evaluated locally on the bare sample — costs no extra fetch.","uniqueKey":"candidates.items.[INDEX].excludeWords.oneOf.1","typeLabel":"null"}],"uniqueKey":"candidates.items.[INDEX].excludeWords","typeLabel":"string | null"}},"required":["keyword"],"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"candidates","typeLabel":"object[]"}},"required":["candidates"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"candidates":[{"keyword":"\u003cstring>","additionalTerms":"\u003cstring>","additionalTermsAndOr":true,"excludeWords":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c0e17bc0-9727-43f8-8e69-3e9443ebea25":{"description":"200 response","content":{"application/json":{"schema":{"description":"One estimate per candidate, in request order. Label every number from this endpoint \"estimate\".","type":"object","properties":{"estimates":{"type":"array","items":{"type":"object","properties":{"keyword":{"type":"string","isRequired":true,"uniqueKey":"estimates.items.[INDEX].keyword","typeLabel":"string"},"volume":{"description":"An ESTIMATE of a keyword's monthly mentions: a range and a band, never a point.","type":"object","properties":{"low":{"description":"Low end, mentions per 30 days.","type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.low","typeLabel":"integer"},"high":{"description":"High end, mentions per 30 days. Anything that blocks reads this.","type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.high","typeLabel":"integer"},"band":{"description":"`quiet` \u003c 300 mentions a month, `standard` 300–1,499, `busy` ≥ 1,500.","type":"string","enum":["quiet","standard","busy"],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.band","typeLabel":"enum\u003cstring>"},"basis":{"description":"`analog` = the same string's real collection in another workspace; `sampled` = adaptive-window provider counts × recall factors; `prior` = too few matches to count (\"under 30 a month\"), or — when `prior` is set and nothing could be measured — the Google Trends prior.","type":"string","enum":["analog","sampled","prior"],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.basis","typeLabel":"enum\u003cstring>"},"window":{"description":"The window the count was exact at. A source that hits its fetch cap at 30 days is re-asked at 7 days, then 1 day.","type":"string","enum":["30d","7d","1d"],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.window","typeLabel":"enum\u003cstring>"},"openEnded":{"description":"`true` = the range is a floor (\"over N a month\").","type":"boolean","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.openEnded","typeLabel":"boolean"},"perSource":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.perSource.items.[INDEX].source","typeLabel":"string"},"count":{"description":"Exact verified matches inside `window`.","type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.perSource.items.[INDEX].count","typeLabel":"integer"},"window":{"description":"The window the count was exact at. A source that hits its fetch cap at 30 days is re-asked at 7 days, then 1 day.","type":"string","enum":["30d","7d","1d"],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.perSource.items.[INDEX].window","typeLabel":"enum\u003cstring>"},"factor":{"description":"Per-source recall factor from the calibration harness.","type":"number","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.perSource.items.[INDEX].factor","typeLabel":"number"},"low":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.perSource.items.[INDEX].low","typeLabel":"integer"},"high":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.perSource.items.[INDEX].high","typeLabel":"integer"},"openEnded":{"description":"`true` when the source hit its cap even at 1 day: read `low`/`high` as \"over\".","type":"boolean","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.perSource.items.[INDEX].openEnded","typeLabel":"boolean"}},"required":["source","count","window","factor","low","high","openEnded"],"additionalProperties":false,"uniqueKey":"estimates.items.[INDEX].volume.perSource.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.perSource","typeLabel":"object[]"},"unverifiedSources":{"description":"Sources that timed out or failed. NOT zero — the range is a floor without them.","type":"array","items":{"type":"string","uniqueKey":"estimates.items.[INDEX].volume.unverifiedSources.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.unverifiedSources","typeLabel":"string[]"},"unmeasuredSources":{"description":"Sources never measured (dev.to among them), with the share of mentions they typically add and why.","type":"array","items":{"type":"object","properties":{"source":{"type":"string","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.unmeasuredSources.items.[INDEX].source","typeLabel":"string"},"typicalShare":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.unmeasuredSources.items.[INDEX].typicalShare.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.unmeasuredSources.items.[INDEX].typicalShare.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.unmeasuredSources.items.[INDEX].typicalShare","typeLabel":"number | null"},"reason":{"description":"Why the source is not measured — its share is unknown, never zero.","type":"string","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.unmeasuredSources.items.[INDEX].reason","typeLabel":"string"}},"required":["source","typicalShare","reason"],"additionalProperties":false,"uniqueKey":"estimates.items.[INDEX].volume.unmeasuredSources.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.unmeasuredSources","typeLabel":"object[]"},"caveats":{"type":"array","items":{"type":"string","uniqueKey":"estimates.items.[INDEX].volume.caveats.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.caveats","typeLabel":"string[]"},"prior":{"oneOf":[{"type":"object","description":"The Google Trends prior consulted for this keyword: a prior, never a count. It stands in only when every measured source is unverified.","required":["source","monthly","low","high"],"properties":{"source":{"type":"string","const":"google-trends","isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.prior.oneOf.0.source","typeLabel":"string"},"monthly":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.prior.oneOf.0.monthly","typeLabel":"integer"},"low":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.prior.oneOf.0.low","typeLabel":"integer"},"high":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume.prior.oneOf.0.high","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"estimates.items.[INDEX].volume.prior.oneOf.0","typeLabel":"object"},{"type":"null","description":"The Google Trends prior consulted for this keyword: a prior, never a count. It stands in only when every measured source is unverified.","uniqueKey":"estimates.items.[INDEX].volume.prior.oneOf.1","typeLabel":"null"}],"uniqueKey":"estimates.items.[INDEX].volume.prior","typeLabel":"object | null"},"disagreement":{"description":"`true` = the sample and the Trends prior disagree by more than 10×; the range was widened to cover both.","type":"boolean","uniqueKey":"estimates.items.[INDEX].volume.disagreement","typeLabel":"boolean"}},"required":["low","high","band","basis","window","openEnded","perSource","unverifiedSources","unmeasuredSources","caveats"],"additionalProperties":false,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].volume","typeLabel":"object"},"bareVolume":{"oneOf":[{"type":"object","description":"An ESTIMATE of a keyword's monthly mentions: a range and a band, never a point.","required":["low","high","band","basis","window","openEnded","perSource","unverifiedSources","unmeasuredSources","caveats"],"properties":{"low":{"description":"Low end, mentions per 30 days.","type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.low","typeLabel":"integer"},"high":{"description":"High end, mentions per 30 days. Anything that blocks reads this.","type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.high","typeLabel":"integer"},"band":{"description":"`quiet` \u003c 300 mentions a month, `standard` 300–1,499, `busy` ≥ 1,500.","type":"string","enum":["quiet","standard","busy"],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.band","typeLabel":"enum\u003cstring>"},"basis":{"description":"`analog` = the same string's real collection in another workspace; `sampled` = adaptive-window provider counts × recall factors; `prior` = too few matches to count (\"under 30 a month\"), or — when `prior` is set and nothing could be measured — the Google Trends prior.","type":"string","enum":["analog","sampled","prior"],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.basis","typeLabel":"enum\u003cstring>"},"window":{"description":"The window the count was exact at. A source that hits its fetch cap at 30 days is re-asked at 7 days, then 1 day.","type":"string","enum":["30d","7d","1d"],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.window","typeLabel":"enum\u003cstring>"},"openEnded":{"description":"`true` = the range is a floor (\"over N a month\").","type":"boolean","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.openEnded","typeLabel":"boolean"},"perSource":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource.items.[INDEX].source","typeLabel":"string"},"count":{"description":"Exact verified matches inside `window`.","type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource.items.[INDEX].count","typeLabel":"integer"},"window":{"description":"The window the count was exact at. A source that hits its fetch cap at 30 days is re-asked at 7 days, then 1 day.","type":"string","enum":["30d","7d","1d"],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource.items.[INDEX].window","typeLabel":"enum\u003cstring>"},"factor":{"description":"Per-source recall factor from the calibration harness.","type":"number","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource.items.[INDEX].factor","typeLabel":"number"},"low":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource.items.[INDEX].low","typeLabel":"integer"},"high":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource.items.[INDEX].high","typeLabel":"integer"},"openEnded":{"description":"`true` when the source hit its cap even at 1 day: read `low`/`high` as \"over\".","type":"boolean","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource.items.[INDEX].openEnded","typeLabel":"boolean"}},"required":["source","count","window","factor","low","high","openEnded"],"additionalProperties":false,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.perSource","typeLabel":"object[]"},"unverifiedSources":{"description":"Sources that timed out or failed. NOT zero — the range is a floor without them.","type":"array","items":{"type":"string","uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unverifiedSources.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unverifiedSources","typeLabel":"string[]"},"unmeasuredSources":{"description":"Sources never measured (dev.to among them), with the share of mentions they typically add and why.","type":"array","items":{"type":"object","properties":{"source":{"type":"string","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unmeasuredSources.items.[INDEX].source","typeLabel":"string"},"typicalShare":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unmeasuredSources.items.[INDEX].typicalShare.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unmeasuredSources.items.[INDEX].typicalShare.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unmeasuredSources.items.[INDEX].typicalShare","typeLabel":"number | null"},"reason":{"description":"Why the source is not measured — its share is unknown, never zero.","type":"string","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unmeasuredSources.items.[INDEX].reason","typeLabel":"string"}},"required":["source","typicalShare","reason"],"additionalProperties":false,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unmeasuredSources.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.unmeasuredSources","typeLabel":"object[]"},"caveats":{"type":"array","items":{"type":"string","uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.caveats.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.caveats","typeLabel":"string[]"},"prior":{"oneOf":[{"type":"object","description":"The Google Trends prior consulted for this keyword: a prior, never a count. It stands in only when every measured source is unverified.","required":["source","monthly","low","high"],"properties":{"source":{"type":"string","const":"google-trends","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.prior.oneOf.0.source","typeLabel":"string"},"monthly":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.prior.oneOf.0.monthly","typeLabel":"integer"},"low":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.prior.oneOf.0.low","typeLabel":"integer"},"high":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.prior.oneOf.0.high","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.prior.oneOf.0","typeLabel":"object"},{"type":"null","description":"The Google Trends prior consulted for this keyword: a prior, never a count. It stands in only when every measured source is unverified.","uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.prior.oneOf.1","typeLabel":"null"}],"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.prior","typeLabel":"object | null"},"disagreement":{"description":"`true` = the sample and the Trends prior disagree by more than 10×; the range was widened to cover both.","type":"boolean","uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0.disagreement","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].bareVolume","typeLabel":"object | null"},"variant":{"oneOf":[{"type":"object","required":["sampleSize","anchoredShare","excludedShare","retainedShare","collisionRatio"],"properties":{"sampleSize":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].variant.oneOf.0.sampleSize","typeLabel":"integer"},"anchoredShare":{"type":"number","minimum":0,"maximum":1,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].variant.oneOf.0.anchoredShare","typeLabel":"number"},"excludedShare":{"type":"number","minimum":0,"maximum":1,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].variant.oneOf.0.excludedShare","typeLabel":"number"},"retainedShare":{"type":"number","minimum":0,"maximum":1,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].variant.oneOf.0.retainedShare","typeLabel":"number"},"collisionRatio":{"description":"Share of bare matches NOT about the anchored sense (1 − anchoredShare); with no anchors, the share the exclude words remove.","type":"number","minimum":0,"maximum":1,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].variant.oneOf.0.collisionRatio","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"estimates.items.[INDEX].variant.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"estimates.items.[INDEX].variant.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"estimates.items.[INDEX].variant","typeLabel":"object | null"},"flagged":{"description":"`true` when a source is unverified or open-ended — treat the range as a floor.","type":"boolean","isRequired":true,"uniqueKey":"estimates.items.[INDEX].flagged","typeLabel":"boolean"}},"required":["keyword","volume","bareVolume","variant","flagged"],"additionalProperties":false,"uniqueKey":"estimates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"estimates","typeLabel":"object[]"},"calibration":{"type":"object","properties":{"fittedAt":{"type":"string","isRequired":true,"uniqueKey":"calibration.fittedAt","typeLabel":"string"}},"required":["fittedAt"],"additionalProperties":false,"isRequired":true,"uniqueKey":"calibration","typeLabel":"object"},"elapsedMs":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"elapsedMs","typeLabel":"integer"}},"required":["estimates","calibration","elapsedMs"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"estimates":[{"keyword":"\u003cstring>","volume":{"low":4503599627370495,"high":4503599627370495,"band":"quiet","basis":"analog","window":"30d","openEnded":true,"perSource":[{"source":"\u003cstring>","count":4503599627370495,"window":"30d","factor":123,"low":4503599627370495,"high":4503599627370495,"openEnded":true}],"unverifiedSources":["\u003cstring>"],"unmeasuredSources":[{"source":"\u003cstring>","typicalShare":123,"reason":"\u003cstring>"}],"caveats":["\u003cstring>"],"prior":{"source":"google-trends","monthly":4503599627370495,"low":4503599627370495,"high":4503599627370495},"disagreement":true},"bareVolume":{"low":4503599627370495,"high":4503599627370495,"band":"quiet","basis":"analog","window":"30d","openEnded":true,"perSource":[{"source":"\u003cstring>","count":4503599627370495,"window":"30d","factor":123,"low":4503599627370495,"high":4503599627370495,"openEnded":true}],"unverifiedSources":["\u003cstring>"],"unmeasuredSources":[{"source":"\u003cstring>","typicalShare":123,"reason":"\u003cstring>"}],"caveats":["\u003cstring>"],"prior":{"source":"google-trends","monthly":4503599627370495,"low":4503599627370495,"high":4503599627370495},"disagreement":true},"variant":{"sampleSize":4503599627370495,"anchoredShare":0.5,"excludedShare":0.5,"retainedShare":0.5,"collisionRatio":0.5},"flagged":true}],"calibration":{"fittedAt":"\u003cstring>"},"elapsedMs":4503599627370495}}},"exampleType":"generated"}},"exampleType":"generated"},"d1457fcc-c3e3-4bc1-a3d5-8af4b03449f5":{"description":"Validation error","content":{"application/json":{"schema":{"description":"Standard error envelope returned for all non-2xx responses. The `code` field is stable — safe to branch on programmatically. `code`, `message` and `status` are always present; anything else is additive and per-code (`details` on `VALIDATION_ERROR`, `upgradeUrl`/`upgradeCommand` on `UPGRADE_REQUIRED`).","type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code. See `ApiErrorCode` for the full list.","type":"string","enum":["UNAUTHORIZED","FORBIDDEN","RATE_LIMITED","VALIDATION_ERROR","INTERNAL_ERROR","MEMBER_REQUIRED","BRIEF_DISABLED","INVALID_BRIEF_LINK","PREFERENCE_CHANGED","BRIEF_NOT_FOUND","INVALID_BRIEF_WINDOW","INVALID_RECIPIENT_COUNT","ORGANIZATION_REQUIRED","FORBIDDEN_ORGANIZATION","MASTER_KEY_REQUIRED","AGENCY_INACTIVE","NOT_AN_AGENCY_WORKSPACE","AGENCY_NOT_FOUND","WORKSPACE_NOT_IN_AGENCY","ANCHOR_WORKSPACE","AGENCY_WORKSPACE_LIMIT","INVITE_FANOUT_TOO_LARGE","SUPERADMIN_REMOVE_FORBIDDEN","USER_REQUIRED","FLEX_REQUIRES_CAP","FLEX_REQUIRES_BUDGET","AGENCY_BILLING_NOT_CONFIGURED","WORKSPACE_CREATE_FAILED","WORKSPACE_SETUP_FAILED","WORKSPACE_ACCESS_FAILED","UPGRADE_REQUIRED","QUOTA_EXCEEDED","WORKSPACE_PENDING_REVIEW","SETUP_DECISION_PENDING","MENTIONS_PREVIEW_NOT_READY","MENTIONS_NOT_VIEWED","KEYWORDS_STEP_INVALID","ONBOARDING_STEP_NOT_CURRENT","ONBOARDING_REVISION_CHANGED","ONBOARDING_IN_PROGRESS","SETUP_DRAFT_NOT_FOUND","PAYWALL","SANDBOX_WORKSPACE","SECOND_FREE_TRIAL_FORBIDDEN","AUTH_LOOKUP_UNAVAILABLE","NOT_IMPLEMENTED","FEED_NOT_ONBOARDING","NOT_FOUND","FEED_NOT_FOUND","KEYWORD_NOT_FOUND","KEYWORDS_NOT_FOUND","POST_NOT_FOUND","MENTION_NOT_FOUND","SUMMARY_NOT_FOUND","SEARCH_NOT_FOUND","SUGGESTION_NOT_FOUND","COMPANY_NOT_FOUND","ORG_NOT_FOUND","SETTINGS_NOT_FOUND","NOTIFICATION_NOT_FOUND","VIEW_NOT_FOUND","ALERT_NOT_FOUND","ATTENTION_ITEM_NOT_FOUND","FEATURE_DISABLED","MENTION_KEYWORD_UNKNOWN","EXPORT_LINK_UNAVAILABLE","INVALID_INPUT","KEYWORD_LIMIT_EXCEEDED","KEYWORD_OPERATOR_SYNTAX","LAST_ADMIN","ITEM_EXISTS","INVALID_DOMAIN","INVALID_TIMEZONE","SLACK_NOT_CONNECTED","SLACK_CHANNEL_NOT_FOUND","SLACK_CHANNEL_REQUIRED","WEBHOOK_URL_INVALID","NO_DESTINATIONS","NO_SAMPLE_MENTION","INVALID_DESTINATION","DESTINATION_INDEX_OUT_OF_RANGE","FILTER_LIMIT_EXCEEDED","FILTER_CONDITION_LIMIT_EXCEEDED","ENGAGEMENT_METRICS_DISABLED","ATTENTION_ACTION_NOT_APPLY","WEB_SOURCE_UNAVAILABLE","INSTAGRAM_SOURCE_UNAVAILABLE","FACEBOOK_SOURCE_UNAVAILABLE","DISCORD_SOURCE_UNAVAILABLE","DISCORD_ADMIN_ONLY","DISCORD_LINK_NOT_FOUND","DISCORD_MONITOR_NOT_FOUND","DISCORD_CHANNEL_INVALID","DISCORD_KEYWORD_NOT_TEXT","DISCORD_MONITOR_EXISTS","DISCORD_LINK_BUSY","DISCORD_MONITOR_BUSY","FEED_FILTER_WRITE_CONFLICT","ENGAGE_FAILED","RELEVANCE_UPDATE_FAILED"],"example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message.","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"description":"HTTP status code — always matches the response status.","example":404,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"description":"Present on `VALIDATION_ERROR` responses. Contains Zod issues describing each failing field (path, code, message).","type":"array","items":{"oneOf":[{}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"any[]"},"upgradeUrl":{"description":"Present on `UPGRADE_REQUIRED` responses (additive — see `ApiErrorCode`): the URL of the upgrade page for this workspace.","example":"https://app.octolens.com/me/upgrade?src=agents","type":"string","uniqueKey":"error.upgradeUrl","typeLabel":"string"},"upgradeCommand":{"description":"Present on `UPGRADE_REQUIRED` responses (additive): the CLI command that mints a single-use, already-authenticated link into the upgrade page.","example":"octolens upgrade","type":"string","uniqueKey":"error.upgradeCommand","typeLabel":"string"}},"required":["code","message","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Resource not found","status":404,"details":["\u003cunknown>"],"upgradeUrl":"https://app.octolens.com/me/upgrade?src=agents","upgradeCommand":"octolens upgrade"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4d2ba2ac-fa5b-4aec-862b-2487be455150":{"description":"Missing or invalid authentication","content":{"application/json":{"schema":{"description":"Standard error envelope returned for all non-2xx responses. The `code` field is stable — safe to branch on programmatically. `code`, `message` and `status` are always present; anything else is additive and per-code (`details` on `VALIDATION_ERROR`, `upgradeUrl`/`upgradeCommand` on `UPGRADE_REQUIRED`).","type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code. See `ApiErrorCode` for the full list.","type":"string","enum":["UNAUTHORIZED","FORBIDDEN","RATE_LIMITED","VALIDATION_ERROR","INTERNAL_ERROR","MEMBER_REQUIRED","BRIEF_DISABLED","INVALID_BRIEF_LINK","PREFERENCE_CHANGED","BRIEF_NOT_FOUND","INVALID_BRIEF_WINDOW","INVALID_RECIPIENT_COUNT","ORGANIZATION_REQUIRED","FORBIDDEN_ORGANIZATION","MASTER_KEY_REQUIRED","AGENCY_INACTIVE","NOT_AN_AGENCY_WORKSPACE","AGENCY_NOT_FOUND","WORKSPACE_NOT_IN_AGENCY","ANCHOR_WORKSPACE","AGENCY_WORKSPACE_LIMIT","INVITE_FANOUT_TOO_LARGE","SUPERADMIN_REMOVE_FORBIDDEN","USER_REQUIRED","FLEX_REQUIRES_CAP","FLEX_REQUIRES_BUDGET","AGENCY_BILLING_NOT_CONFIGURED","WORKSPACE_CREATE_FAILED","WORKSPACE_SETUP_FAILED","WORKSPACE_ACCESS_FAILED","UPGRADE_REQUIRED","QUOTA_EXCEEDED","WORKSPACE_PENDING_REVIEW","SETUP_DECISION_PENDING","MENTIONS_PREVIEW_NOT_READY","MENTIONS_NOT_VIEWED","KEYWORDS_STEP_INVALID","ONBOARDING_STEP_NOT_CURRENT","ONBOARDING_REVISION_CHANGED","ONBOARDING_IN_PROGRESS","SETUP_DRAFT_NOT_FOUND","PAYWALL","SANDBOX_WORKSPACE","SECOND_FREE_TRIAL_FORBIDDEN","AUTH_LOOKUP_UNAVAILABLE","NOT_IMPLEMENTED","FEED_NOT_ONBOARDING","NOT_FOUND","FEED_NOT_FOUND","KEYWORD_NOT_FOUND","KEYWORDS_NOT_FOUND","POST_NOT_FOUND","MENTION_NOT_FOUND","SUMMARY_NOT_FOUND","SEARCH_NOT_FOUND","SUGGESTION_NOT_FOUND","COMPANY_NOT_FOUND","ORG_NOT_FOUND","SETTINGS_NOT_FOUND","NOTIFICATION_NOT_FOUND","VIEW_NOT_FOUND","ALERT_NOT_FOUND","ATTENTION_ITEM_NOT_FOUND","FEATURE_DISABLED","MENTION_KEYWORD_UNKNOWN","EXPORT_LINK_UNAVAILABLE","INVALID_INPUT","KEYWORD_LIMIT_EXCEEDED","KEYWORD_OPERATOR_SYNTAX","LAST_ADMIN","ITEM_EXISTS","INVALID_DOMAIN","INVALID_TIMEZONE","SLACK_NOT_CONNECTED","SLACK_CHANNEL_NOT_FOUND","SLACK_CHANNEL_REQUIRED","WEBHOOK_URL_INVALID","NO_DESTINATIONS","NO_SAMPLE_MENTION","INVALID_DESTINATION","DESTINATION_INDEX_OUT_OF_RANGE","FILTER_LIMIT_EXCEEDED","FILTER_CONDITION_LIMIT_EXCEEDED","ENGAGEMENT_METRICS_DISABLED","ATTENTION_ACTION_NOT_APPLY","WEB_SOURCE_UNAVAILABLE","INSTAGRAM_SOURCE_UNAVAILABLE","FACEBOOK_SOURCE_UNAVAILABLE","DISCORD_SOURCE_UNAVAILABLE","DISCORD_ADMIN_ONLY","DISCORD_LINK_NOT_FOUND","DISCORD_MONITOR_NOT_FOUND","DISCORD_CHANNEL_INVALID","DISCORD_KEYWORD_NOT_TEXT","DISCORD_MONITOR_EXISTS","DISCORD_LINK_BUSY","DISCORD_MONITOR_BUSY","FEED_FILTER_WRITE_CONFLICT","ENGAGE_FAILED","RELEVANCE_UPDATE_FAILED"],"example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message.","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"description":"HTTP status code — always matches the response status.","example":404,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"description":"Present on `VALIDATION_ERROR` responses. Contains Zod issues describing each failing field (path, code, message).","type":"array","items":{"oneOf":[{}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"any[]"},"upgradeUrl":{"description":"Present on `UPGRADE_REQUIRED` responses (additive — see `ApiErrorCode`): the URL of the upgrade page for this workspace.","example":"https://app.octolens.com/me/upgrade?src=agents","type":"string","uniqueKey":"error.upgradeUrl","typeLabel":"string"},"upgradeCommand":{"description":"Present on `UPGRADE_REQUIRED` responses (additive): the CLI command that mints a single-use, already-authenticated link into the upgrade page.","example":"octolens upgrade","type":"string","uniqueKey":"error.upgradeCommand","typeLabel":"string"}},"required":["code","message","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Resource not found","status":404,"details":["\u003cunknown>"],"upgradeUrl":"https://app.octolens.com/me/upgrade?src=agents","upgradeCommand":"octolens upgrade"}}}},"exampleType":"generated"}},"exampleType":"generated"},"10275c75-7521-4ae3-a196-09b3ec7750a8":{"description":"Forbidden (insufficient plan or permissions)","content":{"application/json":{"schema":{"description":"Standard error envelope returned for all non-2xx responses. The `code` field is stable — safe to branch on programmatically. `code`, `message` and `status` are always present; anything else is additive and per-code (`details` on `VALIDATION_ERROR`, `upgradeUrl`/`upgradeCommand` on `UPGRADE_REQUIRED`).","type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code. See `ApiErrorCode` for the full list.","type":"string","enum":["UNAUTHORIZED","FORBIDDEN","RATE_LIMITED","VALIDATION_ERROR","INTERNAL_ERROR","MEMBER_REQUIRED","BRIEF_DISABLED","INVALID_BRIEF_LINK","PREFERENCE_CHANGED","BRIEF_NOT_FOUND","INVALID_BRIEF_WINDOW","INVALID_RECIPIENT_COUNT","ORGANIZATION_REQUIRED","FORBIDDEN_ORGANIZATION","MASTER_KEY_REQUIRED","AGENCY_INACTIVE","NOT_AN_AGENCY_WORKSPACE","AGENCY_NOT_FOUND","WORKSPACE_NOT_IN_AGENCY","ANCHOR_WORKSPACE","AGENCY_WORKSPACE_LIMIT","INVITE_FANOUT_TOO_LARGE","SUPERADMIN_REMOVE_FORBIDDEN","USER_REQUIRED","FLEX_REQUIRES_CAP","FLEX_REQUIRES_BUDGET","AGENCY_BILLING_NOT_CONFIGURED","WORKSPACE_CREATE_FAILED","WORKSPACE_SETUP_FAILED","WORKSPACE_ACCESS_FAILED","UPGRADE_REQUIRED","QUOTA_EXCEEDED","WORKSPACE_PENDING_REVIEW","SETUP_DECISION_PENDING","MENTIONS_PREVIEW_NOT_READY","MENTIONS_NOT_VIEWED","KEYWORDS_STEP_INVALID","ONBOARDING_STEP_NOT_CURRENT","ONBOARDING_REVISION_CHANGED","ONBOARDING_IN_PROGRESS","SETUP_DRAFT_NOT_FOUND","PAYWALL","SANDBOX_WORKSPACE","SECOND_FREE_TRIAL_FORBIDDEN","AUTH_LOOKUP_UNAVAILABLE","NOT_IMPLEMENTED","FEED_NOT_ONBOARDING","NOT_FOUND","FEED_NOT_FOUND","KEYWORD_NOT_FOUND","KEYWORDS_NOT_FOUND","POST_NOT_FOUND","MENTION_NOT_FOUND","SUMMARY_NOT_FOUND","SEARCH_NOT_FOUND","SUGGESTION_NOT_FOUND","COMPANY_NOT_FOUND","ORG_NOT_FOUND","SETTINGS_NOT_FOUND","NOTIFICATION_NOT_FOUND","VIEW_NOT_FOUND","ALERT_NOT_FOUND","ATTENTION_ITEM_NOT_FOUND","FEATURE_DISABLED","MENTION_KEYWORD_UNKNOWN","EXPORT_LINK_UNAVAILABLE","INVALID_INPUT","KEYWORD_LIMIT_EXCEEDED","KEYWORD_OPERATOR_SYNTAX","LAST_ADMIN","ITEM_EXISTS","INVALID_DOMAIN","INVALID_TIMEZONE","SLACK_NOT_CONNECTED","SLACK_CHANNEL_NOT_FOUND","SLACK_CHANNEL_REQUIRED","WEBHOOK_URL_INVALID","NO_DESTINATIONS","NO_SAMPLE_MENTION","INVALID_DESTINATION","DESTINATION_INDEX_OUT_OF_RANGE","FILTER_LIMIT_EXCEEDED","FILTER_CONDITION_LIMIT_EXCEEDED","ENGAGEMENT_METRICS_DISABLED","ATTENTION_ACTION_NOT_APPLY","WEB_SOURCE_UNAVAILABLE","INSTAGRAM_SOURCE_UNAVAILABLE","FACEBOOK_SOURCE_UNAVAILABLE","DISCORD_SOURCE_UNAVAILABLE","DISCORD_ADMIN_ONLY","DISCORD_LINK_NOT_FOUND","DISCORD_MONITOR_NOT_FOUND","DISCORD_CHANNEL_INVALID","DISCORD_KEYWORD_NOT_TEXT","DISCORD_MONITOR_EXISTS","DISCORD_LINK_BUSY","DISCORD_MONITOR_BUSY","FEED_FILTER_WRITE_CONFLICT","ENGAGE_FAILED","RELEVANCE_UPDATE_FAILED"],"example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message.","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"description":"HTTP status code — always matches the response status.","example":404,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"description":"Present on `VALIDATION_ERROR` responses. Contains Zod issues describing each failing field (path, code, message).","type":"array","items":{"oneOf":[{}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"any[]"},"upgradeUrl":{"description":"Present on `UPGRADE_REQUIRED` responses (additive — see `ApiErrorCode`): the URL of the upgrade page for this workspace.","example":"https://app.octolens.com/me/upgrade?src=agents","type":"string","uniqueKey":"error.upgradeUrl","typeLabel":"string"},"upgradeCommand":{"description":"Present on `UPGRADE_REQUIRED` responses (additive): the CLI command that mints a single-use, already-authenticated link into the upgrade page.","example":"octolens upgrade","type":"string","uniqueKey":"error.upgradeCommand","typeLabel":"string"}},"required":["code","message","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Resource not found","status":404,"details":["\u003cunknown>"],"upgradeUrl":"https://app.octolens.com/me/upgrade?src=agents","upgradeCommand":"octolens upgrade"}}}},"exampleType":"generated"}},"exampleType":"generated"},"847588bf-3a92-4981-b8fd-2874a8f8263e":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"description":"Standard error envelope returned for all non-2xx responses. The `code` field is stable — safe to branch on programmatically. `code`, `message` and `status` are always present; anything else is additive and per-code (`details` on `VALIDATION_ERROR`, `upgradeUrl`/`upgradeCommand` on `UPGRADE_REQUIRED`).","type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code. See `ApiErrorCode` for the full list.","type":"string","enum":["UNAUTHORIZED","FORBIDDEN","RATE_LIMITED","VALIDATION_ERROR","INTERNAL_ERROR","MEMBER_REQUIRED","BRIEF_DISABLED","INVALID_BRIEF_LINK","PREFERENCE_CHANGED","BRIEF_NOT_FOUND","INVALID_BRIEF_WINDOW","INVALID_RECIPIENT_COUNT","ORGANIZATION_REQUIRED","FORBIDDEN_ORGANIZATION","MASTER_KEY_REQUIRED","AGENCY_INACTIVE","NOT_AN_AGENCY_WORKSPACE","AGENCY_NOT_FOUND","WORKSPACE_NOT_IN_AGENCY","ANCHOR_WORKSPACE","AGENCY_WORKSPACE_LIMIT","INVITE_FANOUT_TOO_LARGE","SUPERADMIN_REMOVE_FORBIDDEN","USER_REQUIRED","FLEX_REQUIRES_CAP","FLEX_REQUIRES_BUDGET","AGENCY_BILLING_NOT_CONFIGURED","WORKSPACE_CREATE_FAILED","WORKSPACE_SETUP_FAILED","WORKSPACE_ACCESS_FAILED","UPGRADE_REQUIRED","QUOTA_EXCEEDED","WORKSPACE_PENDING_REVIEW","SETUP_DECISION_PENDING","MENTIONS_PREVIEW_NOT_READY","MENTIONS_NOT_VIEWED","KEYWORDS_STEP_INVALID","ONBOARDING_STEP_NOT_CURRENT","ONBOARDING_REVISION_CHANGED","ONBOARDING_IN_PROGRESS","SETUP_DRAFT_NOT_FOUND","PAYWALL","SANDBOX_WORKSPACE","SECOND_FREE_TRIAL_FORBIDDEN","AUTH_LOOKUP_UNAVAILABLE","NOT_IMPLEMENTED","FEED_NOT_ONBOARDING","NOT_FOUND","FEED_NOT_FOUND","KEYWORD_NOT_FOUND","KEYWORDS_NOT_FOUND","POST_NOT_FOUND","MENTION_NOT_FOUND","SUMMARY_NOT_FOUND","SEARCH_NOT_FOUND","SUGGESTION_NOT_FOUND","COMPANY_NOT_FOUND","ORG_NOT_FOUND","SETTINGS_NOT_FOUND","NOTIFICATION_NOT_FOUND","VIEW_NOT_FOUND","ALERT_NOT_FOUND","ATTENTION_ITEM_NOT_FOUND","FEATURE_DISABLED","MENTION_KEYWORD_UNKNOWN","EXPORT_LINK_UNAVAILABLE","INVALID_INPUT","KEYWORD_LIMIT_EXCEEDED","KEYWORD_OPERATOR_SYNTAX","LAST_ADMIN","ITEM_EXISTS","INVALID_DOMAIN","INVALID_TIMEZONE","SLACK_NOT_CONNECTED","SLACK_CHANNEL_NOT_FOUND","SLACK_CHANNEL_REQUIRED","WEBHOOK_URL_INVALID","NO_DESTINATIONS","NO_SAMPLE_MENTION","INVALID_DESTINATION","DESTINATION_INDEX_OUT_OF_RANGE","FILTER_LIMIT_EXCEEDED","FILTER_CONDITION_LIMIT_EXCEEDED","ENGAGEMENT_METRICS_DISABLED","ATTENTION_ACTION_NOT_APPLY","WEB_SOURCE_UNAVAILABLE","INSTAGRAM_SOURCE_UNAVAILABLE","FACEBOOK_SOURCE_UNAVAILABLE","DISCORD_SOURCE_UNAVAILABLE","DISCORD_ADMIN_ONLY","DISCORD_LINK_NOT_FOUND","DISCORD_MONITOR_NOT_FOUND","DISCORD_CHANNEL_INVALID","DISCORD_KEYWORD_NOT_TEXT","DISCORD_MONITOR_EXISTS","DISCORD_LINK_BUSY","DISCORD_MONITOR_BUSY","FEED_FILTER_WRITE_CONFLICT","ENGAGE_FAILED","RELEVANCE_UPDATE_FAILED"],"example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message.","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"description":"HTTP status code — always matches the response status.","example":404,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"description":"Present on `VALIDATION_ERROR` responses. Contains Zod issues describing each failing field (path, code, message).","type":"array","items":{"oneOf":[{}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"any[]"},"upgradeUrl":{"description":"Present on `UPGRADE_REQUIRED` responses (additive — see `ApiErrorCode`): the URL of the upgrade page for this workspace.","example":"https://app.octolens.com/me/upgrade?src=agents","type":"string","uniqueKey":"error.upgradeUrl","typeLabel":"string"},"upgradeCommand":{"description":"Present on `UPGRADE_REQUIRED` responses (additive): the CLI command that mints a single-use, already-authenticated link into the upgrade page.","example":"octolens upgrade","type":"string","uniqueKey":"error.upgradeCommand","typeLabel":"string"}},"required":["code","message","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Resource not found","status":404,"details":["\u003cunknown>"],"upgradeUrl":"https://app.octolens.com/me/upgrade?src=agents","upgradeCommand":"octolens upgrade"}}}},"exampleType":"generated"}},"exampleType":"generated"},"039820de-e741-4e85-8628-7a2fb819d340":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Standard error envelope returned for all non-2xx responses. The `code` field is stable — safe to branch on programmatically. `code`, `message` and `status` are always present; anything else is additive and per-code (`details` on `VALIDATION_ERROR`, `upgradeUrl`/`upgradeCommand` on `UPGRADE_REQUIRED`).","type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code. See `ApiErrorCode` for the full list.","type":"string","enum":["UNAUTHORIZED","FORBIDDEN","RATE_LIMITED","VALIDATION_ERROR","INTERNAL_ERROR","MEMBER_REQUIRED","BRIEF_DISABLED","INVALID_BRIEF_LINK","PREFERENCE_CHANGED","BRIEF_NOT_FOUND","INVALID_BRIEF_WINDOW","INVALID_RECIPIENT_COUNT","ORGANIZATION_REQUIRED","FORBIDDEN_ORGANIZATION","MASTER_KEY_REQUIRED","AGENCY_INACTIVE","NOT_AN_AGENCY_WORKSPACE","AGENCY_NOT_FOUND","WORKSPACE_NOT_IN_AGENCY","ANCHOR_WORKSPACE","AGENCY_WORKSPACE_LIMIT","INVITE_FANOUT_TOO_LARGE","SUPERADMIN_REMOVE_FORBIDDEN","USER_REQUIRED","FLEX_REQUIRES_CAP","FLEX_REQUIRES_BUDGET","AGENCY_BILLING_NOT_CONFIGURED","WORKSPACE_CREATE_FAILED","WORKSPACE_SETUP_FAILED","WORKSPACE_ACCESS_FAILED","UPGRADE_REQUIRED","QUOTA_EXCEEDED","WORKSPACE_PENDING_REVIEW","SETUP_DECISION_PENDING","MENTIONS_PREVIEW_NOT_READY","MENTIONS_NOT_VIEWED","KEYWORDS_STEP_INVALID","ONBOARDING_STEP_NOT_CURRENT","ONBOARDING_REVISION_CHANGED","ONBOARDING_IN_PROGRESS","SETUP_DRAFT_NOT_FOUND","PAYWALL","SANDBOX_WORKSPACE","SECOND_FREE_TRIAL_FORBIDDEN","AUTH_LOOKUP_UNAVAILABLE","NOT_IMPLEMENTED","FEED_NOT_ONBOARDING","NOT_FOUND","FEED_NOT_FOUND","KEYWORD_NOT_FOUND","KEYWORDS_NOT_FOUND","POST_NOT_FOUND","MENTION_NOT_FOUND","SUMMARY_NOT_FOUND","SEARCH_NOT_FOUND","SUGGESTION_NOT_FOUND","COMPANY_NOT_FOUND","ORG_NOT_FOUND","SETTINGS_NOT_FOUND","NOTIFICATION_NOT_FOUND","VIEW_NOT_FOUND","ALERT_NOT_FOUND","ATTENTION_ITEM_NOT_FOUND","FEATURE_DISABLED","MENTION_KEYWORD_UNKNOWN","EXPORT_LINK_UNAVAILABLE","INVALID_INPUT","KEYWORD_LIMIT_EXCEEDED","KEYWORD_OPERATOR_SYNTAX","LAST_ADMIN","ITEM_EXISTS","INVALID_DOMAIN","INVALID_TIMEZONE","SLACK_NOT_CONNECTED","SLACK_CHANNEL_NOT_FOUND","SLACK_CHANNEL_REQUIRED","WEBHOOK_URL_INVALID","NO_DESTINATIONS","NO_SAMPLE_MENTION","INVALID_DESTINATION","DESTINATION_INDEX_OUT_OF_RANGE","FILTER_LIMIT_EXCEEDED","FILTER_CONDITION_LIMIT_EXCEEDED","ENGAGEMENT_METRICS_DISABLED","ATTENTION_ACTION_NOT_APPLY","WEB_SOURCE_UNAVAILABLE","INSTAGRAM_SOURCE_UNAVAILABLE","FACEBOOK_SOURCE_UNAVAILABLE","DISCORD_SOURCE_UNAVAILABLE","DISCORD_ADMIN_ONLY","DISCORD_LINK_NOT_FOUND","DISCORD_MONITOR_NOT_FOUND","DISCORD_CHANNEL_INVALID","DISCORD_KEYWORD_NOT_TEXT","DISCORD_MONITOR_EXISTS","DISCORD_LINK_BUSY","DISCORD_MONITOR_BUSY","FEED_FILTER_WRITE_CONFLICT","ENGAGE_FAILED","RELEVANCE_UPDATE_FAILED"],"example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message.","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"description":"HTTP status code — always matches the response status.","example":404,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"description":"Present on `VALIDATION_ERROR` responses. Contains Zod issues describing each failing field (path, code, message).","type":"array","items":{"oneOf":[{}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"any[]"},"upgradeUrl":{"description":"Present on `UPGRADE_REQUIRED` responses (additive — see `ApiErrorCode`): the URL of the upgrade page for this workspace.","example":"https://app.octolens.com/me/upgrade?src=agents","type":"string","uniqueKey":"error.upgradeUrl","typeLabel":"string"},"upgradeCommand":{"description":"Present on `UPGRADE_REQUIRED` responses (additive): the CLI command that mints a single-use, already-authenticated link into the upgrade page.","example":"octolens upgrade","type":"string","uniqueKey":"error.upgradeCommand","typeLabel":"string"}},"required":["code","message","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Resource not found","status":404,"details":["\u003cunknown>"],"upgradeUrl":"https://app.octolens.com/me/upgrade?src=agents","upgradeCommand":"octolens upgrade"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d9ab286a-7cdb-4b08-b643-cb9af2b193a5":{"ApiKey":{"type":"http","scheme":"bearer","description":"Clerk API key. Create one in Settings → API Keys. Pass as `Authorization: Bearer \u003ckey>`. Keys carry a scope — `read`, `write` (implies read) or `admin` (implies write) — chosen when the key is minted. Each operation's `security` requirement (and its `x-required-scope` extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.","x-key-scopes":{"read":"Read-only access: list/query mentions, keywords, feeds, analytics, org metadata.","write":"Read plus mutations: create/update/delete keywords, feeds, tags, filters, notifications. Implies `read`.","admin":"Write plus org administration: member management, invitations, agency workspaces. Implies `write`."},"scopes":["read"],"schemeName":"ApiKey"}}},"servers":{"95c85c73-69fc-4455-89ee-030232ddd6be":{"url":"https://app.octolens.com","description":"Production"},"7edc9ee9-5b0a-4aa6-8470-691b1ed2a22a":{"url":"http://localhost:3000","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Clerk API key. Create one in Settings → API Keys. Pass as `Authorization: Bearer \u003ckey>`. Keys carry a scope — `read`, `write` (implies read) or `admin` (implies write) — chosen when the key is minted. Each operation's `security` requirement (and its `x-required-scope` extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.","x-key-scopes":{"read":"Read-only access: list/query mentions, keywords, feeds, analytics, org metadata.","write":"Read plus mutations: create/update/delete keywords, feeds, tags, filters, notifications. Implies `read`.","admin":"Write plus org administration: member management, invitations, agency workspaces. Implies `write`."},"scopes":["read"],"schemeName":"ApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Clerk API key. Create one in Settings → API Keys. Pass as `Authorization: Bearer \u003ckey>`. Keys carry a scope — `read`, `write` (implies read) or `admin` (implies write) — chosen when the key is minted. Each operation's `security` requirement (and its `x-required-scope` extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"https://app.octolens.com/api/v2/openapi.json"},"subdomain":"octolens","siteName":"Octolens","title":"Estimate keyword volume - Octolens","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T07:20:22.308Z","originalFileLocation":"api-reference/keywords/estimate-keyword-volume.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Beta — behind the sonar-onboarding feature flag. Workspaces the flag is off for get 404 FEATURE_DISABLED. An ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a low–high range and a band (quiet / standard / busy); read high for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in unverifiedSources — it is never counted as zero. additionalTerms / excludeWords are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Octolens\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_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=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Estimate keyword volume - Octolens\">\u003cmeta data-mint-head property=\"og:description\" content=\"Beta — behind the sonar-onboarding feature flag. Workspaces the flag is off for get 404 FEATURE_DISABLED. An ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a low–high range and a band (quiet / standard / busy); read high for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in unverifiedSources — it is never counted as zero. additionalTerms / excludeWords are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Octolens\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://octolens.mintlify.site/docs/_mintlify/api/og/v2?division=Keywords\u0026amp;title=Estimate+keyword+volume\u0026amp;description=**Beta+%E2%80%94+behind+the+%60sonar-onboarding%60+feature+flag.**+Workspaces+the+flag+is+off+for+get+%60404+FEATURE_DISABLED%60.%0A%0AAn+ESTIMATE+of+monthly+mentions+for+up+to+10+\u0026amp;theme=d583b865662c59d3b1e7dd6a\u0026amp;signature=0c06b24d680681e77adecd15b3f57dadad41bf8f787b123a1db67510fa22ec96\">\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=\"Estimate keyword volume - Octolens\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Beta — behind the sonar-onboarding feature flag. Workspaces the flag is off for get 404 FEATURE_DISABLED. An ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a low–high range and a band (quiet / standard / busy); read high for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in unverifiedSources — it is never counted as zero. additionalTerms / excludeWords are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://octolens.mintlify.site/docs/_mintlify/api/og/v2?division=Keywords\u0026amp;title=Estimate+keyword+volume\u0026amp;description=**Beta+%E2%80%94+behind+the+%60sonar-onboarding%60+feature+flag.**+Workspaces+the+flag+is+off+for+get+%60404+FEATURE_DISABLED%60.%0A%0AAn+ESTIMATE+of+monthly+mentions+for+up+to+10+\u0026amp;theme=d583b865662c59d3b1e7dd6a\u0026amp;signature=0c06b24d680681e77adecd15b3f57dadad41bf8f787b123a1db67510fa22ec96\">\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=\"/docs/mintlify-assets/_mintlify/favicons/octolens/5ta3dPrfAAQmNuLw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Octolens\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7551B5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/keywords/estimate-keyword-volume.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://octolens.com/#organization\",\"name\":\"Octolens\",\"url\":\"https://octolens.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/octolens/WNDsqX0Zcsk1Nv6R/logo.png?fit=max\u0026auto=format\u0026n=WNDsqX0Zcsk1Nv6R\u0026q=85\u0026s=3b4eb4dc59ef232691d1bfb70bd366ef\"}},{\"@type\":\"WebSite\",\"@id\":\"https://octolens.com/docs#website\",\"name\":\"Octolens\",\"url\":\"https://octolens.com/docs\",\"publisher\":{\"@id\":\"https://octolens.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume#webpage\",\"url\":\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume\",\"name\":\"Estimate keyword volume\",\"description\":\"Beta — behind the sonar-onboarding feature flag. Workspaces the flag is off for get 404 FEATURE_DISABLED. An ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a low–high range and a band (quiet / standard / busy); read high for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in unverifiedSources — it is never counted as zero. additionalTerms / excludeWords are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.\",\"dateModified\":\"2026-11-06T07:20:22.308Z\",\"isPartOf\":{\"@id\":\"https://octolens.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API v2\",\"item\":\"https://octolens.com/docs/api/v2/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Keywords\",\"item\":\"https://octolens.com/docs/api-reference/keywords/list-keywords\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Estimate keyword volume\",\"item\":\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume#apireference\",\"headline\":\"Estimate keyword volume\",\"name\":\"Estimate keyword volume\",\"description\":\"Beta — behind the sonar-onboarding feature flag. Workspaces the flag is off for get 404 FEATURE_DISABLED. An ESTIMATE of monthly mentions for up to 10 candidate keywords, measured concurrently (about 15 s, up to 25 s when busy sources need a narrower window). Never a point: each estimate is a low–high range and a band (quiet / standard / busy); read high for anything that blocks. Busy sources are re-counted over 7 days, then 1 day, instead of extrapolated. A source that times out is listed in unverifiedSources — it is never counted as zero. additionalTerms / excludeWords are evaluated on the bare sample at no extra cost and return the anchored share and the collision ratio. Creates nothing and consumes no quota.\",\"url\":\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume\",\"mainEntityOfPage\":{\"@id\":\"https://octolens.com/docs/api-reference/keywords/estimate-keyword-volume#webpage\"},\"dateModified\":\"2026-11-06T07:20:22.308Z\",\"publisher\":{\"@id\":\"https://octolens.com/#organization\"},\"isPartOf\":{\"@id\":\"https://octolens.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Octolens\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Octolens","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/v2/overview"}]},{"tab":"API Reference","groups":[{"group":"API v2","root":{"title":"API Reference","href":"/api/v2/overview"},"pages":[{"group":"Auth","pages":[{"title":"Introspect the credential","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/auth","href":"/api-reference/auth/introspect-the-credential"}]},{"group":"Feeds","pages":[{"title":"List feeds","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/feeds","href":"/api-reference/feeds/list-feeds"},{"title":"Create a feed","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/feeds","href":"/api-reference/feeds/create-a-feed"},{"title":"Get a feed","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/feeds/{id}","href":"/api-reference/feeds/get-a-feed"},{"title":"Delete a feed","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/feeds/{id}","href":"/api-reference/feeds/delete-a-feed"},{"title":"Update a feed","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/feeds/{id}","href":"/api-reference/feeds/update-a-feed"}]},{"group":"Keywords","pages":[{"title":"List keywords","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/keywords","href":"/api-reference/keywords/list-keywords"},{"title":"Create a keyword","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/keywords","href":"/api-reference/keywords/create-a-keyword"},{"title":"Delete a keyword","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/keywords/{id}","href":"/api-reference/keywords/delete-a-keyword"},{"title":"Update a keyword","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/keywords/{id}","href":"/api-reference/keywords/update-a-keyword"},{"title":"Pause or resume a keyword","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/keywords/{id}/pause","href":"/api-reference/keywords/pause-or-resume-a-keyword"},{"title":"Preview what deleting a keyword would destroy","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/keywords/{id}/deletion-preview","href":"/api-reference/keywords/preview-what-deleting-a-keyword-would-destroy"},{"title":"List keyword suggestions","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/keywords/suggestions","href":"/api-reference/keywords/list-keyword-suggestions"},{"title":"Accept a keyword suggestion","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/keywords/suggestions","href":"/api-reference/keywords/accept-a-keyword-suggestion"},{"title":"Reject keyword suggestion(s)","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/keywords/suggestions","href":"/api-reference/keywords/reject-keyword-suggestions"},{"title":"Keyword health","description":"Whether this keyword is worth its budget: the `noisy` / `budget` / `healthy` verdict the attention signals use (≥ 50% Low-relevance over ≥ 20 scored mentions, or ≥ 60% of the cycle's mentions), the weekly volume trend, the terms / domains / authors that dominate its low-relevance mentions, its pending AI suggestions and proposed exclude words / context. 404 `KEYWORD_NOT_FOUND` for an unknown or foreign id.","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/keywords/{id}/health","href":"/api-reference/keywords/keyword-health"},{"title":"Estimate keyword volume","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/keywords/estimate","href":"/api-reference/keywords/estimate-keyword-volume"}]},{"group":"Mentions","pages":[{"title":"List mentions","description":"Returns mentions scoped to the authenticated organization. Filter by keyword, source, sentiment, date range, or custom filter groups.\n\nBody shape matches `POST /api/v1/mentions` exactly — simple or advanced `filters` object, `view` to reuse a feed's filters, `includeAll` to toggle low-relevance, cursor pagination via `limit` + `cursor`.\n\nTip: call `POST /api/v2/ai/filter-wizard` with a natural-language prompt to get a ready-to-paste `filters` object.","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/mentions","href":"/api-reference/mentions/list-mentions"},{"title":"List mentions by author","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/mentions/by-author","href":"/api-reference/mentions/list-mentions-by-author"},{"title":"Get a mention","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/mentions/{sourceId}","href":"/api-reference/mentions/get-a-mention"},{"title":"Update a mention","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/mentions/{sourceId}","href":"/api-reference/mentions/update-a-mention"},{"title":"Get a mention (id as query parameter)","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/mentions/by-id","href":"/api-reference/mentions/get-a-mention-id-as-query-parameter"},{"title":"Update a mention (id as query parameter)","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/mentions/by-id","href":"/api-reference/mentions/update-a-mention-id-as-query-parameter"},{"title":"Export mentions","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/mentions/export","href":"/api-reference/mentions/export-mentions"},{"title":"Record feedback on a mention","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/mentions/feedback","href":"/api-reference/mentions/record-feedback-on-a-mention"},{"title":"Export mentions to a download link","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/mentions/export/link","href":"/api-reference/mentions/export-mentions-to-a-download-link"}]},{"group":"Analytics","pages":[{"title":"Sentiment distribution","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/sentiment","href":"/api-reference/analytics/sentiment-distribution"},{"title":"Mention volume over time","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/volume","href":"/api-reference/analytics/mention-volume-over-time"},{"title":"Source/platform breakdown","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/sources","href":"/api-reference/analytics/sourceplatform-breakdown"},{"title":"Per-keyword breakdown","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/keywords","href":"/api-reference/analytics/per-keyword-breakdown"},{"title":"Composite dashboard overview","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/dashboard","href":"/api-reference/analytics/composite-dashboard-overview"},{"title":"Sentiment breakdown per keyword","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/sentiment-by-keyword","href":"/api-reference/analytics/sentiment-breakdown-per-keyword"},{"title":"Volume over time (day / week / month, optional split)","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/volume-over-time","href":"/api-reference/analytics/volume-over-time-day-week-month-optional-split"},{"title":"Top sources by volume, with High-relevance share","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/top-sources","href":"/api-reference/analytics/top-sources-by-volume-with-high-relevance-share"},{"title":"Top keywords by volume, with High-relevance share","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/top-keywords","href":"/api-reference/analytics/top-keywords-by-volume-with-high-relevance-share"},{"title":"Period summary vs the prior period","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/summary","href":"/api-reference/analytics/period-summary-vs-the-prior-period"},{"title":"Share of voice: your brand vs competitors","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/share-of-voice","href":"/api-reference/analytics/share-of-voice:-your-brand-vs-competitors"},{"title":"Share of mentions by one dimension","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/analytics/breakdown","href":"/api-reference/analytics/share-of-mentions-by-one-dimension"}]},{"group":"Organization","pages":[{"title":"Get organization","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/org","href":"/api-reference/organization/get-organization"},{"title":"Update organization","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/org","href":"/api-reference/organization/update-organization"},{"title":"Get usage stats","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/org/usage","href":"/api-reference/organization/get-usage-stats"},{"title":"Mint an authenticated upgrade link","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/org/upgrade-link","href":"/api-reference/organization/mint-an-authenticated-upgrade-link"},{"title":"Get company profile","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/org/company","href":"/api-reference/organization/get-company-profile"},{"title":"Update company profile","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/org/company","href":"/api-reference/organization/update-company-profile"},{"title":"Get your Daily Brief preference","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/me/brief-preference","href":"/api-reference/organization/get-your-daily-brief-preference"},{"title":"Update your Daily Brief preference","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/me/brief-preference","href":"/api-reference/organization/update-your-daily-brief-preference"},{"title":"Build an app deep link","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/app-link","href":"/api-reference/organization/build-an-app-deep-link"}]},{"group":"Feedback","pages":[{"title":"Submit relevance feedback","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/feedback","href":"/api-reference/feedback/submit-relevance-feedback"},{"title":"Remove relevance feedback","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/feedback","href":"/api-reference/feedback/remove-relevance-feedback"},{"title":"Get feedback stats","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/feedback/stats","href":"/api-reference/feedback/get-feedback-stats"}]},{"group":"AI","pages":[{"title":"Convert natural language to filters","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/ai/filter-wizard","href":"/api-reference/ai/convert-natural-language-to-filters"},{"title":"Recommend monitoring settings from search history","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/ai/monitoring-recommendations","href":"/api-reference/ai/recommend-monitoring-settings-from-search-history"}]},{"group":"Setup","pages":[{"title":"Scan a domain into a setup draft","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/setup/scan","href":"/api-reference/setup/scan-a-domain-into-a-setup-draft"},{"title":"Propose a keyword setup for a scanned draft","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/setup/propose","href":"/api-reference/setup/propose-a-keyword-setup-for-a-scanned-draft"},{"title":"Get a setup proposal","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/setup/proposals/{id}","href":"/api-reference/setup/get-a-setup-proposal"},{"title":"Apply a setup proposal","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/setup/proposals/{id}/apply","href":"/api-reference/setup/apply-a-setup-proposal"},{"title":"Clean up an applied setup","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/setup/proposals/{id}/cleanup","href":"/api-reference/setup/clean-up-an-applied-setup"}]},{"group":"Members","pages":[{"title":"List organization members","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/org/members","href":"/api-reference/members/list-organization-members"},{"title":"Invite a member","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/org/members/invite","href":"/api-reference/members/invite-a-member"},{"title":"List pending invitations","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/org/members/invitations","href":"/api-reference/members/list-pending-invitations"},{"title":"Remove a member or revoke an invitation","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/org/members/{id}","href":"/api-reference/members/remove-a-member-or-revoke-an-invitation"}]},{"group":"Filters","pages":[{"title":"Get global filters","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/filters/global","href":"/api-reference/filters/get-global-filters"},{"title":"Update global filters","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/filters/global","href":"/api-reference/filters/update-global-filters"},{"title":"Add values to a global filter list","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/filters/global/add","href":"/api-reference/filters/add-values-to-a-global-filter-list"},{"title":"Remove values from a global filter list","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/filters/global/remove","href":"/api-reference/filters/remove-values-from-a-global-filter-list"},{"title":"List filterable tags","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/tags","href":"/api-reference/filters/list-filterable-tags"}]},{"group":"Integrations","pages":[{"title":"Search Slack channels","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/integrations/slack/channels","href":"/api-reference/integrations/search-slack-channels"},{"title":"Slack connection status","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/integrations/slack","href":"/api-reference/integrations/slack-connection-status"},{"title":"List connected Discord servers","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/integrations/discord/servers","href":"/api-reference/integrations/list-connected-discord-servers"},{"title":"Get a connected Discord server","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/integrations/discord/servers/{linkId}","href":"/api-reference/integrations/get-a-connected-discord-server"},{"title":"Disconnect a Discord server","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/integrations/discord/servers/{linkId}","href":"/api-reference/integrations/disconnect-a-discord-server"},{"title":"Set a Discord server's channel scope","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/integrations/discord/servers/{linkId}","href":"/api-reference/integrations/set-a-discord-servers-channel-scope"},{"title":"List Discord watch monitors","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/integrations/discord/monitors","href":"/api-reference/integrations/list-discord-watch-monitors"},{"title":"Watch a Discord server under a keyword","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/integrations/discord/monitors","href":"/api-reference/integrations/watch-a-discord-server-under-a-keyword"},{"title":"Get a Discord watch monitor","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/integrations/discord/monitors/{id}","href":"/api-reference/integrations/get-a-discord-watch-monitor"},{"title":"Delete a Discord watch monitor","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/integrations/discord/monitors/{id}","href":"/api-reference/integrations/delete-a-discord-watch-monitor"},{"title":"Edit, pause or resume a Discord watch monitor","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/integrations/discord/monitors/{id}","href":"/api-reference/integrations/edit-pause-or-resume-a-discord-watch-monitor"}]},{"group":"Search","pages":[{"title":"List past on-demand searches","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/search","href":"/api-reference/search/list-past-on-demand-searches"},{"title":"Run an on-demand mention search","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/search","href":"/api-reference/search/run-an-on-demand-mention-search"},{"title":"Get an on-demand search","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/search/{searchId}","href":"/api-reference/search/get-an-on-demand-search"}]},{"group":"Notifications","pages":[{"title":"List notifications","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/notifications","href":"/api-reference/notifications/list-notifications"},{"title":"Create a notification","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/notifications","href":"/api-reference/notifications/create-a-notification"},{"title":"Get a notification","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/notifications/{id}","href":"/api-reference/notifications/get-a-notification"},{"title":"Delete a notification","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/notifications/{id}","href":"/api-reference/notifications/delete-a-notification"},{"title":"Update a notification","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/notifications/{id}","href":"/api-reference/notifications/update-a-notification"},{"title":"Test a notification","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/notifications/{id}/test","href":"/api-reference/notifications/test-a-notification"}]},{"group":"Agency","pages":[{"title":"Agency overview","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/agency","href":"/api-reference/agency/agency-overview"},{"title":"List agency workspaces","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/agency/workspaces","href":"/api-reference/agency/list-agency-workspaces"},{"title":"Create an agency workspace","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/agency/workspaces","href":"/api-reference/agency/create-an-agency-workspace"},{"title":"Get an agency workspace","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/agency/workspaces/{orgId}","href":"/api-reference/agency/get-an-agency-workspace"},{"title":"Delete an agency workspace","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json delete /api/v2/agency/workspaces/{orgId}","href":"/api-reference/agency/delete-an-agency-workspace"},{"title":"Update workspace limits / flex","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/agency/workspaces/{orgId}","href":"/api-reference/agency/update-workspace-limits-flex"},{"title":"List workspace members","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/agency/workspaces/{orgId}/members","href":"/api-reference/agency/list-workspace-members"},{"title":"Invite members to workspaces","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/agency/members/invite","href":"/api-reference/agency/invite-members-to-workspaces"},{"title":"Remove a member from workspaces","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/agency/members/remove","href":"/api-reference/agency/remove-a-member-from-workspaces"}]},{"group":"Attention","pages":[{"title":"List attention items","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/attention","href":"/api-reference/attention/list-attention-items"},{"title":"Dismiss or restore an attention item","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/attention/{id}/dismiss","href":"/api-reference/attention/dismiss-or-restore-an-attention-item"}]},{"group":"Onboarding","pages":[{"title":"Read the onboarding state","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/onboarding","href":"/api-reference/onboarding/read-the-onboarding-state"},{"title":"Start the website scan","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/scan","href":"/api-reference/onboarding/start-the-website-scan"},{"title":"Read the onboarding draft","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/onboarding/draft","href":"/api-reference/onboarding/read-the-onboarding-draft"},{"title":"Edit or confirm the company profile","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json patch /api/v2/onboarding/draft/profile","href":"/api-reference/onboarding/edit-or-confirm-the-company-profile"},{"title":"Read the keyword proposal","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/onboarding/proposal","href":"/api-reference/onboarding/read-the-keyword-proposal"},{"title":"Start the keyword proposal","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/proposal","href":"/api-reference/onboarding/start-the-keyword-proposal"},{"title":"Check keyword edits","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/keywords/check","href":"/api-reference/onboarding/check-keyword-edits"},{"title":"Assess a typed-in keyword","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/keywords/assess","href":"/api-reference/onboarding/assess-a-typed-in-keyword"},{"title":"Create the trial workspace","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/trial","href":"/api-reference/onboarding/create-the-trial-workspace"},{"title":"Read the first mentions","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/onboarding/mentions","href":"/api-reference/onboarding/read-the-first-mentions"},{"title":"Record that the mentions were shown","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/mentions/shown","href":"/api-reference/onboarding/record-that-the-mentions-were-shown"},{"title":"Clean up, keep everything, or undo","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/mentions/decision","href":"/api-reference/onboarding/clean-up-keep-everything-or-undo"},{"title":"Take one onboarding transition","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/advance","href":"/api-reference/onboarding/take-one-onboarding-transition"},{"title":"Read the feeds board","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/onboarding/feeds","href":"/api-reference/onboarding/read-the-feeds-board"},{"title":"Read the Slack step","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/onboarding/slack","href":"/api-reference/onboarding/read-the-slack-step"},{"title":"Route feeds to Slack channels","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json put /api/v2/onboarding/slack/routes","href":"/api-reference/onboarding/route-feeds-to-slack-channels"},{"title":"Mint a browser handoff link","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json post /api/v2/onboarding/handoff","href":"/api-reference/onboarding/mint-a-browser-handoff-link"},{"title":"Read the MCP step","deprecated":null,"version":null,"openapi":"https://app.octolens.com/api/v2/openapi.json get /api/v2/onboarding/mcp","href":"/api-reference/onboarding/read-the-mcp-step"}]}]},{"group":"API v1 (Legacy)","pages":[{"title":"API Reference","href":"/api/overview"}]}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]}]},"basePath":"","title":"Estimate keyword volume - Octolens","buildId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","deploymentId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-D_7my4bd.js","utils-Cq_itTNA.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B5KPEvGz.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DBX-JepP.js","snippetPresets-Bsspz-Ge.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-t8ynOKTD.js","ApiExamples-jcs-2nGf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dp53in7F.js","shallow-Dv9eUdUd.js","getApiPlaygroundDisplay-D8cDwNhi.js","CodeSnippet-DkwXLQor.js","CodeSnippets-DcSgKqs5.js","getPastedJson-I2RjoApV.js","icon-BIj57rZC.js","MethodPill-CTwLPWXC.js","DuplicateIcon-BJpFwygY.js","createIcon-C7PorfAe.js","DynamicMarkdown-BBht_uEs.js","SectionHeading-YIBwxbzj.js","axios-vUo_bRtp.js","Markdown--YCeFtOs.js","clsx-CrPa459s.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BWxsj3I0.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fBzVvq7k.js"]}