List Tags

Analyze performance by tag

GET /api/v1/brands/{brandId}/tags

List Tags

cURL

curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId}/tags \
  --header 'Authorization: <authorization>'

200

{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "totalPrompts": 123,
      "totalAnswers": 123,
      "brandMentionRate": 123,
      "shareOfVoice": 123,
      "avgSentiment": 123
    }
  ]
}

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.

Authorization · string · required

Bearer token. Example: Bearer qw-api-xxx

Path Parameters

brandId · string · required

The unique identifier of the brand

Query Parameters

period · number

Number of days to include. If not specified, returns all data.

startDate · string

Start date (ISO 8601 format)

endDate · string

End date (ISO 8601 format)

provider · string

Filter by AI provider. Supports comma-separated multi-select (e.g., chatgpt,claude).

topic · string

Filter by topic (keyword) ID. Supports comma-separated multi-select (e.g., id1,id2).

limit · number · default: "50"

Maximum number of tags to return (max: 100)

offset · number · default: "0"

Number of results to skip for pagination

sort · string · default: "prompts"

Field to sort by: prompts, answers, mentionRate, shareOfVoice, sentiment, name

order · string · default: "desc"

Sort order: asc or desc

Response

success · boolean

Indicates if the request was successful

pagination · object

Show Pagination info

total · number

Total number of tags matching filters

count · number

Number of tags in this response

limit · number

Maximum items per page

offset · number

Number of items skipped

tags · array

Show Tag object

id · string

Tag ID

name · string

Tag name

totalPrompts · number

Number of prompts with this tag

totalAnswers · number

Total AI responses analyzed

brandMentionRate · number

Percentage of responses mentioning brand (0-100)

shareOfVoice · number

Brand mentions vs competitors (0-100)

avgSentiment · number

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