Track how your brand performs across different tags. Tags are custom labels you can apply to prompts for grouping and filtering.
See Entities for the complete Tag object structure. Bearer token. Example: Bearer qw-api-xxx
GET /api/v1/brands/{brandId}/tags
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 tags to return (max: 100)
Number of results to skip for pagination
Field to sort by: prompts, answers, mentionRate, shareOfVoice, sentiment, name
Response
Indicates if the request was successful
Total number of tags matching filters
Number of tags in this response
Number of prompts with this tag
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/tags?limit=10" \
-H "Authorization: Bearer qw-api-your-token-here"
Example Response
{
"success": true,
"pagination": {
"total": 12,
"count": 2,
"limit": 10,
"offset": 0
},
"tags": [
{
"id": "tag1",
"name": "Product Comparisons",
"totalPrompts": 25,
"totalAnswers": 200,
"brandMentionRate": 52.0,
"shareOfVoice": 38.5,
"avgSentiment": 81.2
},
{
"id": "tag2",
"name": "Pricing Questions",
"totalPrompts": 18,
"totalAnswers": 144,
"brandMentionRate": 35.4,
"shareOfVoice": 22.1,
"avgSentiment": 68.5
}
]
}
Error Responses
| Status | Code | Description |
|---|
| 401 | INVALID_TOKEN | Authentication failed |
| 404 | BRAND_NOT_FOUND | Brand doesn’t exist or not accessible |
