Track how your brand performs across different keywords and topics. Keywords are the semantic themes that organize your monitoring prompts.
See Entities for the complete Keyword object structure. List Keywords
Bearer token. Example: Bearer qw-api-xxx
GET /api/v1/brands/{brandId}/keywords
Path Parameters
The unique identifier of the brand
Query Parameters
Number of days to include. If not specified, returns all data.
Start date (ISO 8601 format)
End date (ISO 8601 format)
Maximum number of keywords to return (max: 100)
Number of results to skip for pagination
Field to sort by: prompts, answers, mentionRate, shareOfVoice, sentiment, keyword
Response
Indicates if the request was successful
Total number of keywords matching filters
Number of keywords in this response
Number of prompts with this keyword
Total AI responses analyzed
Percentage of responses mentioning brand (0-100)
Brand mentions vs competitors (0-100)
Average sentiment score (0-100)
Example Request
curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/keywords?limit=10" \
-H "Authorization: Bearer qw-api-your-token-here"
Example Response
{
"success": true,
"pagination": {
"total": 25,
"count": 2,
"limit": 10,
"offset": 0
},
"keywords": [
{
"id": "kw1",
"keyword": "best CRM software",
"totalPrompts": 15,
"totalAnswers": 120,
"brandMentionRate": 45.5,
"shareOfVoice": 32.1,
"avgSentiment": 78.3
},
{
"id": "kw2",
"keyword": "enterprise solutions",
"totalPrompts": 8,
"totalAnswers": 64,
"brandMentionRate": 28.1,
"shareOfVoice": 18.5,
"avgSentiment": 72.0
}
]
}
Error Responses
| Status | Code | Description |
|---|
| 401 | INVALID_TOKEN | Authentication failed |
| 404 | BRAND_NOT_FOUND | Brand doesn’t exist or not accessible |
