Get Brand

Retrieve detailed information about a specific brand

GET /api/v1/brands/{brandId}

Get Brand

cURL

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

200

{
  "success": true,
  "brand": {
    "id": "<string>",
    "name": "<string>",
    "domain": "<string>",
    "description": "<string>",
    "createdAt": "<string>",
    "stats": {
      "promptsCount": 123,
      "answersCount": 123,
      "competitorsCount": 123
    }
  }
}

Retrieve detailed information about a specific brand, including aggregate statistics for prompts, answers, and competitors.

Authorization · string · required

Bearer token. Example: Bearer qw-api-xxx

Path Parameters

brandId · string · required

The unique brand identifier

Response

success · boolean

Indicates if the request was successful

brand · object

Show Brand details

id · string

Unique brand identifier (UUID)

name · string

Brand display name

domain · string

Primary domain for the brand

description · string

Brand description (can be null)

createdAt · string

ISO 8601 creation timestamp

stats · object

Show Brand statistics

promptsCount · number

Number of prompts tracked for this brand

answersCount · number

Total number of AI responses analyzed

competitorsCount · number

Number of competitors (SELF + DIRECT)

Example Request

curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef" \
  -H "Authorization: Bearer qw-api-your-token-here"

Example Response

{
  "success": true,
  "brand": {
    "id": "cm1234567890abcdef",
    "name": "My Brand",
    "domain": "mybrand.com",
    "description": "Leading provider of innovative solutions",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "stats": {
      "promptsCount": 156,
      "answersCount": 312,
      "competitorsCount": 8
    }
  }
}

Error Responses

Status	Code	Description
401	INVALID_TOKEN	Authentication failed
404	BRAND_NOT_FOUND	Brand doesn’t exist or not accessible