Skip to main content
GET
/
api
/
v1
/
brands
/
{brandId}
/
shopping
Shopping Results
curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId}/shopping \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "shopping": [
    {
      "id": "<string>",
      "productName": "<string>",
      "description": "<string>",
      "image": "<string>",
      "rating": 123,
      "reviews": 123,
      "options": [
        {}
      ],
      "prompt": "<string>",
      "createdAt": "<string>"
    }
  ]
}
Access product recommendations extracted from AI responses, primarily from Google AI Overview shopping results. Track which products AI platforms recommend in your industry.

​
List Shopping Insights

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

​
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).
​
limit
number
default:"50"
Maximum number of products to return (max: 100)
​
offset
number
default:"0"
Number of results to skip for pagination
​
sort
string
default:"createdAt"
Field to sort by: createdAt, rating, reviews, productName
​
order
string
default:"desc"
Sort order: asc or desc

​
Response

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

​
Example Request

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

​
Example Response

{
  "success": true,
  "pagination": {
    "total": 85,
    "count": 2,
    "limit": 10,
    "offset": 0
  },
  "shopping": [
    {
      "id": "shop1",
      "productName": "Acme Pro CRM Suite",
      "description": "Enterprise-grade CRM solution with AI features",
      "image": "https://example.com/product-image.jpg",
      "rating": 4.5,
      "reviews": 1250,
      "options": [
        {
          "price": "$99/month",
          "currency": "USD",
          "websiteName": "Acme",
          "websiteUrl": "https://acme.com/pricing"
        }
      ],
      "prompt": "What is the best CRM software for enterprise?",
      "createdAt": "2024-12-15T10:30:00Z"
    },
    {
      "id": "shop2",
      "productName": "DataFlow Analytics Pro",
      "description": "Real-time analytics platform",
      "image": null,
      "rating": 4.2,
      "reviews": 890,
      "options": [],
      "prompt": "Compare top analytics platforms",
      "createdAt": "2024-12-14T15:45:00Z"
    }
  ]
}

​
Error Responses

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