Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.
GET
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
keywords
List topics
curl --request GET \ --url https://www.qwairy.co/api/v1/brands/{brandId}/keywords \ --header 'Authorization: <authorization>'
Lists topics with answer counts and response-level SELF metrics for the selected scope. The API route retains keywords and keyword field names for compatibility.
See Entities for the complete Topic object structure.
string
required
Bearer token. Example: Bearer qw-api-xxx
Path parameters
string
required
The unique identifier of the brand
Query parameters
number
Number of days to include. If not specified, returns all data.
string
Start date in YYYY-MM-DD. Provide it with endDate; a lone boundary is currently ignored. Choose either period or the complete date pair.
string
End date in YYYY-MM-DD. Provide it with startDate; a lone boundary is currently ignored. Do not combine the complete date pair with period.
string
Filter by AI provider. Supports comma-separated multi-select (e.g., chatgpt,claude).
string
Filter by tag ID. Supports comma-separated multi-select (e.g., id1,id2).
number
default:"50"
Maximum number of topics to return (max: 100)
number
default:"0"
Number of results to skip for pagination
string
default:"prompts"
Field to sort by: prompts, answers, mentionRate, shareOfVoice, sentiment, keyword
string
default:"desc"
Sort order: asc or desc
Response
boolean
Indicates if the request was successful
object
Show Pagination info
number
Total number of topics matching filters
number
Number of topics in this response
number
Maximum items per page
number
Number of items skipped
array
Show Topic object
string
Topic ID
string
Topic text
number
Number of prompts with this topic
number
Stored answers in the selected scope
number
Answers with a SELF mention divided by answers with a SELF or DIRECT mention
number
SELF mention occurrences divided by SELF and DIRECT mention occurrences
number
Average SELF mention sentiment on a 0 to 100 scale; 0 is returned when no scored SELF mention exists
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Qwairy Documentation","colors":{"primary":"#7b3aee","light":"#9f6aff","dark":"#6930c3"},"logo":{"light":"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/light.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=cb8e1f59f1718fe629b0c49f6b48f531","dark":"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/dark.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=785d06dbaa640b3277a1ccb1db2681f4"},"favicon":"https://mintcdn.com/qwairy/iJ9osnRZHsYMWu0z/favicon.svg?fit=max\u0026auto=format\u0026n=iJ9osnRZHsYMWu0z\u0026q=85\u0026s=ce439f6d1ab0e2580c3e94fffa248755","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true},"url":"full","mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://www.qwairy.co"}},"navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.qwairy.co"}},"search":{"prompt":"Search documentation..."},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"documentation/get-started/what-is-qwairy"},{"language":"fr","navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://www.qwairy.co"}},"href":"fr/documentation/get-started/what-is-qwairy"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"qwairy","hasAudioNarration":false,"actualSubdomain":"qwairy","customDomains":["docs.qwairy.co"],"gitSource":{"type":"github","owner":"nicolasilhe","repo":"docs.qwairy.co","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aef012e32a73c26eb13b479","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"Product","count":75},{"language":"fr","tag":"Produit","count":75},{"language":"en","tag":"Use cases","count":72},{"language":"fr","tag":"Cas d’usage","count":72},{"language":"en","tag":"API","count":49},{"language":"fr","tag":"API","count":49},{"language":"en","tag":"MCP","count":31},{"language":"fr","tag":"MCP","count":31},{"language":"en","tag":"Measure","count":23},{"language":"fr","tag":"Measure","count":23},{"language":"en","tag":"Monitor and measure","count":22},{"language":"fr","tag":"Suivi et mesure","count":22},{"language":"en","tag":"Get started","count":19},{"language":"en","tag":"Changelog","count":19},{"language":"en","tag":"Release notes","count":19},{"language":"fr","tag":"Bien démarrer","count":19},{"language":"fr","tag":"Nouveautés","count":19},{"language":"fr","tag":"Notes de version","count":19},{"language":"en","tag":"Improve content and reputation","count":18},{"language":"fr","tag":"Améliorer le contenu et la réputation","count":18}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navigation-items,#navigation-items *{hyphens:manual}#content a[id]:not([href]){scroll-margin-top:var(--scroll-mt, 152px)}"}],"page":{"pagePath":"developers/endpoints/keywords/list","slug":"/developers/endpoints/keywords/list","pageMetadata":{"title":"List topics","description":"Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.","api":"GET /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/list"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Lists topics with answer counts and response-level SELF metrics for the selected scope. The API route retains `,_jsx(_components.code,{children:`keywords`}),` and `,_jsx(_components.code,{children:`keyword`}),` field names for compatibility.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/developers/entities#topic`,children:`Entities`}),` for the complete Topic object structure.`]})}),`\n`,_jsx(ParamField,{header:`Authorization`,type:`string`,required:true,id:`param-authorization`,children:_jsxs(_components.p,{children:[`Bearer token. Example: `,_jsx(_components.code,{children:`Bearer qw-api-xxx`})]})}),`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path parameters`}),`\n`,_jsx(ParamField,{path:`brandId`,type:`string`,required:true,id:`param-brand-id`,children:_jsx(_components.p,{children:`The unique identifier of the brand`})}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query parameters`}),`\n`,_jsx(ParamField,{query:`period`,type:`number`,id:`param-period`,children:_jsx(_components.p,{children:`Number of days to include. If not specified, returns all data.`})}),`\n`,_jsx(ParamField,{query:`startDate`,type:`string`,id:`param-start-date`,children:_jsxs(_components.p,{children:[`Start date in `,_jsx(_components.code,{children:`YYYY-MM-DD`}),`. Provide it with `,_jsx(_components.code,{children:`endDate`}),`; a lone boundary is currently ignored. Choose either `,_jsx(_components.code,{children:`period`}),` or the complete date pair.`]})}),`\n`,_jsx(ParamField,{query:`endDate`,type:`string`,id:`param-end-date`,children:_jsxs(_components.p,{children:[`End date in `,_jsx(_components.code,{children:`YYYY-MM-DD`}),`. Provide it with `,_jsx(_components.code,{children:`startDate`}),`; a lone boundary is currently ignored. Do not combine the complete date pair with `,_jsx(_components.code,{children:`period`}),`.`]})}),`\n`,_jsx(ParamField,{query:`provider`,type:`string`,id:`param-provider`,children:_jsxs(_components.p,{children:[`Filter by AI provider. Supports comma-separated multi-select (e.g., `,_jsx(_components.code,{children:`chatgpt,claude`}),`).`]})}),`\n`,_jsx(ParamField,{query:`tag`,type:`string`,id:`param-tag`,children:_jsxs(_components.p,{children:[`Filter by tag ID. Supports comma-separated multi-select (e.g., `,_jsx(_components.code,{children:`id1,id2`}),`).`]})}),`\n`,_jsx(ParamField,{query:`limit`,type:`number`,default:`50`,id:`param-limit`,children:_jsx(_components.p,{children:`Maximum number of topics to return (max: 100)`})}),`\n`,_jsx(ParamField,{query:`offset`,type:`number`,default:`0`,id:`param-offset`,children:_jsx(_components.p,{children:`Number of results to skip for pagination`})}),`\n`,_jsx(ParamField,{query:`sort`,type:`string`,default:`prompts`,id:`param-sort`,children:_jsxs(_components.p,{children:[`Field to sort by: `,_jsx(_components.code,{children:`prompts`}),`, `,_jsx(_components.code,{children:`answers`}),`, `,_jsx(_components.code,{children:`mentionRate`}),`, `,_jsx(_components.code,{children:`shareOfVoice`}),`, `,_jsx(_components.code,{children:`sentiment`}),`, `,_jsx(_components.code,{children:`keyword`})]})}),`\n`,_jsx(ParamField,{query:`order`,type:`string`,default:`desc`,id:`param-order`,children:_jsxs(_components.p,{children:[`Sort order: `,_jsx(_components.code,{children:`asc`}),` or `,_jsx(_components.code,{children:`desc`})]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Indicates if the request was successful`})}),`\n`,_jsx(ResponseField,{name:`pagination`,type:`object`,id:`param-pagination`,children:_jsxs(Expandable,{title:`Pagination info`,children:[_jsx(ResponseField,{name:`total`,type:`number`,id:`param-total`,children:`Total number of topics matching filters`}),_jsx(ResponseField,{name:`count`,type:`number`,id:`param-count`,children:`Number of topics in this response`}),_jsx(ResponseField,{name:`limit`,type:`number`,id:`param-limit-1`,children:`Maximum items per page`}),_jsx(ResponseField,{name:`offset`,type:`number`,id:`param-offset-1`,children:`Number of items skipped`})]})}),`\n`,_jsx(ResponseField,{name:`keywords`,type:`array`,id:`param-keywords`,children:_jsxs(Expandable,{title:`Topic object`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:`Topic ID`}),_jsx(ResponseField,{name:`keyword`,type:`string`,id:`param-keyword`,children:`Topic text`}),_jsx(ResponseField,{name:`totalPrompts`,type:`number`,id:`param-total-prompts`,children:`Number of prompts with this topic`}),_jsx(ResponseField,{name:`totalAnswers`,type:`number`,id:`param-total-answers`,children:`Stored answers in the selected scope`}),_jsx(ResponseField,{name:`brandMentionRate`,type:`number`,id:`param-brand-mention-rate`,children:`Answers with a SELF mention divided by answers with a SELF or DIRECT mention`}),_jsx(ResponseField,{name:`shareOfVoice`,type:`number`,id:`param-share-of-voice`,children:`SELF mention occurrences divided by SELF and DIRECT mention occurrences`}),_jsxs(ResponseField,{name:`avgSentiment`,type:`number`,id:`param-avg-sentiment`,children:[`Average SELF mention sentiment on a 0 to 100 scale; `,_jsx(_components.code,{children:`0`}),` is returned when no scored SELF mention exists`]})]})}),`\n`,_jsx(Heading,{level:`2`,id:`synthetic-request`,children:`Synthetic request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://www.qwairy.co/api/v1/brands/YOUR_BRAND_ID/keywords?limit=10\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$QWAIRY_API_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`synthetic-response`,children:`Synthetic response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`29`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`29`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pagination\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`25`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"limit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`10`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"offset\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"keywords\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"topic_01\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"keyword\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"data exports\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"totalPrompts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`15`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"totalAnswers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`120`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brandMentionRate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`45.5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"shareOfVoice\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`32.1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"avgSentiment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`78.3`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"topic_02\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"keyword\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"analytics integrations\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"totalPrompts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`8`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"totalAnswers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`64`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brandMentionRate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`28.1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"shareOfVoice\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`18.5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"avgSentiment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`72.0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:`gateway error`}),_jsx(_components.td,{children:`Missing or invalid API token`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`BRAND_NOT_FOUND`})}),_jsx(_components.td,{children:`Brand doesn’t exist or not accessible`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`429`}),_jsx(_components.td,{children:`gateway error`}),_jsxs(_components.td,{children:[`Rate limit exceeded; honor `,_jsx(_components.code,{children:`Retry-After`})]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/developers/rate-limits`,children:`Rate limits`}),` for retry behavior.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List topics","description":"Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.","api":"GET /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Path parameters","slug":"path-parameters","depth":2,"children":[]},{"title":"Query parameters","slug":"query-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Synthetic request","slug":"synthetic-request","depth":2,"children":[]},{"title":"Synthetic response","slug":"synthetic-response","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"List topics","path":"/api/v1/brands/{brandId}/keywords","servers":[{"url":"https://www.qwairy.co"}],"method":"get","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{"period":{"schema":[{"type":"number","description":"Number of days to include. If not specified, returns all data."}]},"startDate":{"schema":[{"type":"string","description":"Start date in `YYYY-MM-DD` . Provide it with `endDate` ; a lone boundary is currently ignored. Choose either `period` or the complete date pair."}]},"endDate":{"schema":[{"type":"string","description":"End date in `YYYY-MM-DD` . Provide it with `startDate` ; a lone boundary is currently ignored. Do not combine the complete date pair with `period` ."}]},"provider":{"schema":[{"type":"string","description":"Filter by AI provider. Supports comma-separated multi-select (e.g., `chatgpt,claude` )."}]},"tag":{"schema":[{"type":"string","description":"Filter by tag ID. Supports comma-separated multi-select (e.g., `id1,id2` )."}]},"limit":{"schema":[{"type":"number","description":"Maximum number of topics to return (max: 100)"}]},"offset":{"schema":[{"type":"number","description":"Number of results to skip for pagination"}]},"sort":{"schema":[{"type":"string","description":"Field to sort by: `prompts` , `answers` , `mentionRate` , `shareOfVoice` , `sentiment` , `keyword`"}]},"order":{"schema":[{"type":"string","description":"Sort order: `asc` or `desc`"}]}},"header":{"Authorization":{"schema":[{"type":"string","description":"Bearer token. Example: `Bearer qw-api-xxx`","required":true}]}},"cookie":{},"path":{"brandId":{"schema":[{"type":"string","description":"The unique identifier of the brand","required":true}]}}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"success":[{"type":"boolean","description":"Indicates if the request was successful"}],"pagination":[{"type":"object","properties":{"total":[{"type":"number","description":"Total number of topics matching filters"}],"count":[{"type":"number","description":"Number of topics in this response"}],"limit":[{"type":"number","description":"Maximum items per page"}],"offset":[{"type":"number","description":"Number of items skipped"}]}}],"keywords":[{"type":"array","items":[{"type":"object","properties":{"id":[{"type":"string","description":"Topic ID"}],"keyword":[{"type":"string","description":"Topic text"}],"totalPrompts":[{"type":"number","description":"Number of prompts with this topic"}],"totalAnswers":[{"type":"number","description":"Stored answers in the selected scope"}],"brandMentionRate":[{"type":"number","description":"Answers with a SELF mention divided by answers with a SELF or DIRECT mention"}],"shareOfVoice":[{"type":"number","description":"SELF mention occurrences divided by SELF and DIRECT mention occurrences"}],"avgSentiment":[{"type":"number","description":"Average SELF mention sentiment on a 0 to 100 scale; `0` is returned when no scored SELF mention exists"}]}}]}]}}],"examples":{"example":{"value":{"success":true,"pagination":{"total":123,"count":123,"limit":123,"offset":123},"keywords":[{"id":"\u003cstring>","keyword":"\u003cstring>","totalPrompts":123,"totalAnswers":123,"brandMentionRate":123,"shareOfVoice":123,"avgSentiment":123}]}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"qwairy","siteName":"Qwairy Documentation","title":"List topics - Qwairy Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/developers/endpoints/keywords/list","matchLevel":0},"fr":{"href":"/fr/developers/endpoints/keywords/list","matchLevel":1}}},"lastModified":"2026-10-12T17:39:09.580Z","originalFileLocation":"developers/endpoints/keywords/list.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List topics - Qwairy Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.qwairy.co/developers/endpoints/keywords/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://qwairy.mintlify.site/_mintlify/api/og/v2?division=Topics\u0026amp;title=List+topics\u0026amp;description=Analyze+performance+by+topic%2C+with+answer+counts+and+response-level+SELF+metrics+for+the+selected+scope.+Routes+keep+the+keywords+name+for+compatibility.\u0026amp;theme=5fc1096560764d127b1f112c\u0026amp;signature=bc56642e313413bfbed85209894c7e43376365c26a3a4b31ab39829857f384fd\">\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=\"List topics - Qwairy Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://qwairy.mintlify.site/_mintlify/api/og/v2?division=Topics\u0026amp;title=List+topics\u0026amp;description=Analyze+performance+by+topic%2C+with+answer+counts+and+response-level+SELF+metrics+for+the+selected+scope.+Routes+keep+the+keywords+name+for+compatibility.\u0026amp;theme=5fc1096560764d127b1f112c\u0026amp;signature=bc56642e313413bfbed85209894c7e43376365c26a3a4b31ab39829857f384fd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7b3aee\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.qwairy.co/developers/endpoints/keywords/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/endpoints/keywords/list.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.qwairy.co/developers/endpoints/keywords/list\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.qwairy.co/fr/developers/endpoints/keywords/list\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.qwairy.co/developers/endpoints/keywords/list\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.qwairy.co/#organization\",\"name\":\"Qwairy Documentation\",\"url\":\"https://docs.qwairy.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/light.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=cb8e1f59f1718fe629b0c49f6b48f531\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.qwairy.co#website\",\"name\":\"Qwairy Documentation\",\"url\":\"https://docs.qwairy.co\",\"publisher\":{\"@id\":\"https://docs.qwairy.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.qwairy.co/developers/endpoints/keywords/list#webpage\",\"url\":\"https://docs.qwairy.co/developers/endpoints/keywords/list\",\"name\":\"List topics\",\"description\":\"Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.\",\"dateModified\":\"2026-10-12T17:39:09.580Z\",\"isPartOf\":{\"@id\":\"https://docs.qwairy.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.qwairy.co/developers/endpoints/keywords/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.qwairy.co/developers/endpoints/keywords/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Configure data\",\"item\":\"https://docs.qwairy.co/developers/endpoints/brands/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List topics\",\"item\":\"https://docs.qwairy.co/developers/endpoints/keywords/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.qwairy.co/developers/endpoints/keywords/list#apireference\",\"headline\":\"List topics\",\"name\":\"List topics\",\"description\":\"Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility.\",\"url\":\"https://docs.qwairy.co/developers/endpoints/keywords/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.qwairy.co/developers/endpoints/keywords/list#webpage\"},\"dateModified\":\"2026-10-12T17:39:09.580Z\",\"publisher\":{\"@id\":\"https://docs.qwairy.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.qwairy.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Qwairy Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Qwairy Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/endpoints/keywords/list.md","siteName":"Qwairy Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Product","pages":[{"title":"Product","href":"/documentation/get-started/what-is-qwairy"}]},{"tab":"API","groups":[{"group":"Get started","pages":[{"title":"Introduction","icon":"book-open","href":"/developers/introduction"},{"title":"Quick start","href":"/developers/guides/index"},{"title":"Authentication","icon":"key","href":"/developers/authentication"},{"title":"API tokens","href":"/developers/api-keys"},{"title":"Rate limits","icon":"gauge","href":"/developers/rate-limits"},{"title":"Error codes","icon":"triangle-exclamation","href":"/developers/errors"},{"title":"Entities","icon":"cubes","href":"/developers/entities"}]},{"group":"Configure data","pages":[{"group":"Brands","pages":[{"title":"List brands","api":"GET /api/v1/brands","href":"/developers/endpoints/brands/list"},{"title":"Get brand","description":"Retrieve detailed information about one accessible brand, with current counts of non-deleted prompts and answers and SELF or DIRECT competitor domains.","api":"GET /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/get"}]},{"group":"Topics","pages":[{"title":"List topics","api":"GET /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/list"},{"title":"Topic evolution","description":"Get daily time-series metrics for one topic, including Mention Rate, Source Rate, and Share of Voice at the response level for the selected period.","api":"GET /api/v1/brands/{brandId}/keywords/{keywordId}/evolution","href":"/developers/endpoints/keywords/evolution"}]},{"group":"Tags","pages":[{"title":"List tags","api":"GET /api/v1/brands/{brandId}/tags","href":"/developers/endpoints/tags/list"},{"title":"Tag evolution","api":"GET /api/v1/brands/{brandId}/tags/{tagId}/evolution","href":"/developers/endpoints/tags/evolution"}]}]},{"group":"Monitor and measure","pages":[{"group":"Performance","pages":[{"title":"Get performance snapshot","api":"GET /api/v1/brands/{brandId}/performance","href":"/developers/endpoints/performance"},{"title":"Get GEO matrix","api":"GET /api/v1/brands/{brandId}/matrix","href":"/developers/endpoints/matrix"}]},{"group":"Prompts","pages":[{"title":"List prompts","api":"GET /api/v1/brands/{brandId}/prompts","href":"/developers/endpoints/prompts/list"},{"title":"Get prompt","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}","href":"/developers/endpoints/prompts/get"},{"title":"Prompt answers","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}/answers","href":"/developers/endpoints/prompts/answers"},{"title":"Prompt evolution","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}/evolution","href":"/developers/endpoints/prompts/evolution"}]},{"group":"Answers","pages":[{"title":"List answers","api":"GET /api/v1/brands/{brandId}/answers","href":"/developers/endpoints/answers/list"},{"title":"Get answer","api":"GET /api/v1/brands/{brandId}/answers/{answerId}","href":"/developers/endpoints/answers/get"}]},{"group":"Competitors","pages":[{"title":"List competitors","api":"GET /api/v1/brands/{brandId}/competitors","href":"/developers/endpoints/competitors/list"},{"title":"Get competitor","api":"GET /api/v1/brands/{brandId}/competitors/{competitorId}","href":"/developers/endpoints/competitors/get"},{"title":"Competitor evolution","api":"GET /api/v1/brands/{brandId}/competitors/{competitorId}/evolution","href":"/developers/endpoints/competitors/evolution"}]},{"group":"Sources","pages":[{"title":"List source domains","api":"GET /api/v1/brands/{brandId}/source-domains","href":"/developers/endpoints/source-domains/list"},{"title":"Get source domain","api":"GET /api/v1/brands/{brandId}/source-domains/{sourceId}","href":"/developers/endpoints/source-domains/get"},{"title":"Source domain evolution","api":"GET /api/v1/brands/{brandId}/source-domains/{sourceId}/evolution","href":"/developers/endpoints/source-domains/evolution"},{"title":"List source URLs","api":"GET /api/v1/brands/{brandId}/source-urls","href":"/developers/endpoints/source-urls"}]},{"group":"Signals","pages":[{"title":"List query fan-out records","api":"GET /api/v1/brands/{brandId}/search","href":"/developers/endpoints/search"},{"title":"List follow-ups","api":"GET /api/v1/brands/{brandId}/follow-ups","href":"/developers/endpoints/follow-ups"},{"title":"List shopping results","api":"GET /api/v1/brands/{brandId}/shopping","href":"/developers/endpoints/shopping"},{"title":"List local business insights","api":"GET /api/v1/brands/{brandId}/local","href":"/developers/endpoints/local"},{"title":"List social signals","api":"GET /api/v1/brands/{brandId}/social","href":"/developers/endpoints/social"},{"title":"List sponsored content","api":"GET /api/v1/brands/{brandId}/sponsored","href":"/developers/endpoints/sponsored"}]},{"title":"Get crawler analytics","api":"GET /api/v1/brands/{brandId}/crawler-analytics","href":"/developers/endpoints/crawler-analytics"}]},{"group":"Analyze and act","pages":[{"group":"Perception","pages":[{"title":"List perception snapshots","api":"GET /api/v1/brands/{brandId}/perception","href":"/developers/endpoints/perception/list"},{"title":"Get perception snapshot","api":"GET /api/v1/brands/{brandId}/perception/{snapshotId}","href":"/developers/endpoints/perception/get"}]},{"title":"List actions","api":"GET /api/v1/brands/{brandId}/actions","href":"/developers/endpoints/actions/list"},{"group":"Content","pages":[{"title":"List content","api":"GET /api/v1/brands/{brandId}/content","href":"/developers/endpoints/content/list"},{"title":"Get content","api":"GET /api/v1/brands/{brandId}/content/{articleId}","href":"/developers/endpoints/content/get"}]},{"title":"Get Site Readiness analysis","api":"GET /api/v1/brands/{brandId}/technical-analysis","href":"/developers/endpoints/technical-analysis"}]},{"group":"Agency and automation","pages":[{"group":"Pitch audits","pages":[{"title":"List Pitch Audits","api":"GET /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/list"},{"title":"Get Pitch Audit","api":"GET /api/v1/pitch-audits/{auditId}","href":"/developers/endpoints/pitch-audits/get"},{"title":"Get Pitch Audit subject report","api":"GET /api/v1/pitch-audits/{auditId}/reports/{subjectId}","href":"/developers/endpoints/pitch-audits/get-report"}]},{"title":"Outbound webhooks","href":"/developers/webhooks"}]},{"group":"Implementation guides","pages":[{"title":"Custom dashboard","href":"/developers/guides/custom-dashboard"},{"title":"Weekly reports","href":"/developers/guides/weekly-reports"},{"title":"Competitive analysis","href":"/developers/guides/competitive-analysis"},{"title":"Data export","href":"/developers/guides/data-export"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/introduction"}]},{"tab":"Looker Studio","pages":[{"title":"Looker Studio","href":"/looker-studio/getting-started"}]},{"tab":"Agencies","pages":[{"title":"Agencies","href":"/agencies/introduction"}]},{"tab":"Use cases","pages":[{"title":"Use cases","href":"/use-cases"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/updates/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.qwairy.co/blog"},{"anchor":"GEO Guide","icon":"book-open","href":"https://www.qwairy.co/guides/complete-guide-to-generative-engine-optimization"}]}},{"language":"fr","navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://www.qwairy.co"}},"pages":[{"title":"fr","href":"/fr/developers/endpoints/keywords/list"}]}]},"basePath":"","title":"List topics - Qwairy Documentation","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js"]}