# Commerce

Returns a high-level overview of your brand's visibility in AI-powered shopping experiences, including overall visibility score, trends, active categories, and per-provider coverage.

## Request

```
GET /v1/commerce/overview
```

### Query Parameters

All [common filters](/getting-started/filtering.md) plus [commerce-specific filters](/getting-started/filtering.md#commerce-specific-filters):

| Parameter         | Type              | Required | Default     | Description               |
| ----------------- | ----------------- | -------- | ----------- | ------------------------- |
| `startDate`       | string (ISO 8601) | No       | 30 days ago | Start of date range       |
| `endDate`         | string (ISO 8601) | No       | Today       | End of date range         |
| `providers`       | string\[]         | No       | All         | Filter by AI provider     |
| `topicIds`        | string\[]         | No       | All         | Filter by category/topic  |
| `shoppingIntents` | string\[]         | No       | All         | Filter by shopping intent |

## Response

### Success (200 OK)

```json
{
  "overallVisibility": 45.2,
  "visibilityChange": 3.8,
  "activeCategories": 12,
  "totalProducts": 847,
  "timeSeriesData": [
    {
      "bucketIndex": 0,
      "startDate": "2026-01-01",
      "endDate": "2026-01-31",
      "visibilityPercentage": 41.4
    },
    {
      "bucketIndex": 1,
      "startDate": "2026-02-01",
      "endDate": "2026-02-28",
      "visibilityPercentage": 43.7
    },
    {
      "bucketIndex": 2,
      "startDate": "2026-03-01",
      "endDate": "2026-03-31",
      "visibilityPercentage": 45.2
    }
  ],
  "llmCoverage": [
    {
      "provider": "OPENAI",
      "currentVisibility": 52.1,
      "visibilityChange": 4.2,
      "timeSeriesData": [...]
    },
    {
      "provider": "GEMINI",
      "currentVisibility": 38.6,
      "visibilityChange": 2.1,
      "timeSeriesData": [...]
    }
  ]
}
```

### Fields

| Field                                   | Type           | Description                                     |
| --------------------------------------- | -------------- | ----------------------------------------------- |
| `overallVisibility`                     | number         | Overall shopping visibility score (0-100)       |
| `visibilityChange`                      | number or null | Change from previous period                     |
| `activeCategories`                      | integer        | Number of categories where your products appear |
| `totalProducts`                         | integer        | Total products tracked                          |
| `timeSeriesData`                        | array          | Visibility trend over time                      |
| `timeSeriesData[].bucketIndex`          | integer        | Time bucket index                               |
| `timeSeriesData[].startDate`            | string         | Bucket start date                               |
| `timeSeriesData[].endDate`              | string         | Bucket end date                                 |
| `timeSeriesData[].visibilityPercentage` | number         | Visibility in this period                       |
| `llmCoverage`                           | array          | Per-provider visibility breakdown               |
| `llmCoverage[].provider`                | string         | AI provider name                                |
| `llmCoverage[].currentVisibility`       | number         | Current visibility on this provider             |
| `llmCoverage[].visibilityChange`        | number or null | Change from previous period                     |
| `llmCoverage[].timeSeriesData`          | array          | Visibility trend for this provider              |

## Examples

### curl

```bash
curl "https://app.limy.ai/api/v1/commerce/overview" \
  -H "X-API-Key: YOUR_API_KEY"
```

### Python

```python
response = requests.get(
    f"https://app.limy.ai/api/v1/commerce/overview",
    headers={"X-API-Key": API_KEY}
)

data = response.json()
print(f"Overall visibility: {data['overallVisibility']}% ({data['visibilityChange']:+.1f}%)")
print(f"Active categories: {data['activeCategories']}, Products: {data['totalProducts']}")

for provider in data['llmCoverage']:
    print(f"  {provider['provider']}: {provider['currentVisibility']}%")
```

### JavaScript

```javascript
const response = await fetch(
  `https://app.limy.ai/api/v1/commerce/overview`,
  { headers: { 'X-API-Key': API_KEY } }
);

const data = await response.json();
console.log(`Visibility: ${data.overallVisibility}% (${data.activeCategories} categories)`);
data.llmCoverage.forEach(p =>
  console.log(`  ${p.provider}: ${p.currentVisibility}%`)
);
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api-reference.limy.ai/analytics/overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.