Skip to main content
GET
List topics
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
array

Synthetic request

Synthetic response

Errors

See Rate limits for retry behavior.