Skip to main content
GET
/
api
/
v1
/
brands
/
{brandId}
/
sponsored
Sponsored Content
curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId}/sponsored \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "sponsored": [
    {
      "id": "<string>",
      "advertiserName": "<string>",
      "advertiserLogo": "<string>",
      "productName": "<string>",
      "description": "<string>",
      "imageUrl": "<string>",
      "position": 123,
      "provider": "<string>",
      "competitorRelationship": "<string>",
      "prompt": "<string>",
      "createdAt": "<string>"
    }
  ]
}
Access sponsored content (ads) detected in AI responses, primarily from ChatGPT. Track which advertisers appear, what products they promote, and which prompts trigger these placements.

​
List Sponsored Content

​
Authorization
string
required
Bearer token. Example: Bearer qw-api-xxx
GET /api/v1/brands/{brandId}/sponsored

​
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).
​
advertiser
string
Filter by advertiser name (case-insensitive partial match)
​
limit
number
default:"50"
Maximum number of results to return (max: 100)
​
offset
number
default:"0"
Number of results to skip for pagination
​
sort
string
default:"createdAt"
Field to sort by: createdAt, advertiserName, productName, position
​
order
string
default:"desc"
Sort order: asc or desc

​
Response

​
success
boolean
Indicates if the request was successful
​
pagination
object
​
sponsored
array

​
Example Request

curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/sponsored?period=30&limit=10" \
  -H "Authorization: Bearer qw-api-your-token-here"

​
Example Response

{
  "success": true,
  "pagination": {
    "total": 24,
    "count": 2,
    "limit": 10,
    "offset": 0
  },
  "sponsored": [
    {
      "id": "sp1",
      "advertiserName": "Expedia",
      "advertiserLogo": "https://bzrcdn.openai.com/expedia-logo.png",
      "productName": "Cheap Flights from Chicago, IL",
      "description": "Compare Cheap Flights from Chicago, Illinois. View Deals and Book Now on Expedia.",
      "imageUrl": null,
      "position": 1,
      "provider": "chatgpt-4o",
      "competitorRelationship": "DIRECT",
      "prompt": "What are the best flight deals from Chicago?",
      "createdAt": "2026-04-10T14:30:00Z"
    },
    {
      "id": "sp2",
      "advertiserName": "Nordstrom",
      "advertiserLogo": "https://bzrcdn.openai.com/nordstrom-logo.png",
      "productName": "Spring Collection Sale",
      "description": "Shop the latest spring styles at Nordstrom. Free shipping and returns.",
      "imageUrl": null,
      "position": 1,
      "provider": "chatgpt-4o",
      "competitorRelationship": null,
      "prompt": "Best spring fashion deals 2026",
      "createdAt": "2026-04-09T09:15:00Z"
    }
  ]
}

​
Error Responses

StatusCodeDescription
401INVALID_TOKENAuthentication failed
404BRAND_NOT_FOUNDBrand doesn’t exist or not accessible