> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qwairy.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Shopping Results

> Product recommendations from AI responses

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

<ParamField header="Authorization" type="string" required>
  Bearer token. Example: `Bearer qw-api-xxx`
</ParamField>

```http theme={null}
GET /api/v1/brands/{brandId}/shopping
```

### Path Parameters

<ParamField path="brandId" type="string" required>
  The unique identifier of the brand
</ParamField>

### Query Parameters

<ParamField query="period" type="number">
  Number of days to include. If not specified, returns all data.
</ParamField>

<ParamField query="startDate" type="string">
  Start date (ISO 8601 format)
</ParamField>

<ParamField query="endDate" type="string">
  End date (ISO 8601 format)
</ParamField>

<ParamField query="provider" type="string">
  Filter by AI provider. Supports comma-separated multi-select (e.g., `chatgpt,claude`).
</ParamField>

<ParamField query="limit" type="number" default="50">
  Maximum number of products to return (max: 100)
</ParamField>

<ParamField query="offset" type="number" default="0">
  Number of results to skip for pagination
</ParamField>

<ParamField query="sort" type="string" default="createdAt">
  Field to sort by: `createdAt`, `rating`, `reviews`, `productName`
</ParamField>

<ParamField query="order" type="string" default="desc">
  Sort order: `asc` or `desc`
</ParamField>

### Response

<ResponseField name="success" type="boolean">
  Indicates if the request was successful
</ResponseField>

<ResponseField name="pagination" type="object">
  <Expandable title="Pagination info">
    <ResponseField name="total" type="number">Total number of products matching filters</ResponseField>
    <ResponseField name="count" type="number">Number of products in this response</ResponseField>
    <ResponseField name="limit" type="number">Maximum items per page</ResponseField>
    <ResponseField name="offset" type="number">Number of items skipped</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="shopping" type="array">
  <Expandable title="Shopping object">
    <ResponseField name="id" type="string">Shopping insight ID</ResponseField>
    <ResponseField name="productName" type="string">Product name</ResponseField>
    <ResponseField name="description" type="string">Product description</ResponseField>
    <ResponseField name="image" type="string">Product image URL</ResponseField>
    <ResponseField name="rating" type="number">Product rating (0-5)</ResponseField>
    <ResponseField name="reviews" type="number">Number of reviews</ResponseField>
    <ResponseField name="options" type="array">Purchasing options with prices and sellers</ResponseField>
    <ResponseField name="prompt" type="string">Original prompt that triggered this result</ResponseField>
    <ResponseField name="createdAt" type="string">ISO 8601 timestamp</ResponseField>
  </Expandable>
</ResponseField>

### Example Request

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

### Example Response

```json theme={null}
{
  "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

| Status | Code              | Description                           |
| ------ | ----------------- | ------------------------------------- |
| 401    | `INVALID_TOKEN`   | Authentication failed                 |
| 404    | `BRAND_NOT_FOUND` | Brand doesn't exist or not accessible |