# Mentions

Returns the total number of times your brand was mentioned across AI search engines, along with visibility percentage and period-over-period changes.

## Request

```
GET /v1/visibility/mentions
```

### Query Parameters

All [common filters](/getting-started/filtering.md) are supported, plus:

| 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 topic                          |
| `countries`       | string\[]         | No       | All         | Filter by country code                   |
| `isPromptBranded` | string\[]         | No       | All         | `Branded` or `Non-Branded`               |
| `promptTypes`     | string\[]         | No       | All         | `COMMERCIAL`, `INFORMATIONAL`, `GENERAL` |

## Response

### Success (200 OK)

```json
{
  "mentions": 1247,
  "mentionsChange": 12.5,
  "visibilityPercentage": 68.3,
  "visibilityPercentageChange": 3.2,
  "totalPromptsAnalyzed": 1825,
  "mentionedInPrompts": [
    {
      "promptId": "550e8400-e29b-41d4-a716-446655440001",
      "promptName": "best industrial automation solutions",
      "rank": 1
    }
  ]
}
```

### Fields

| Field                        | Type            | Description                                          |
| ---------------------------- | --------------- | ---------------------------------------------------- |
| `mentions`                   | integer or null | Total times your brand was mentioned in AI responses |
| `mentionsChange`             | number or null  | Percentage change from the previous period           |
| `visibilityPercentage`       | number or null  | Percentage of prompts where your brand appeared      |
| `visibilityPercentageChange` | number or null  | Change in visibility percentage from previous period |
| `totalPromptsAnalyzed`       | integer or null | Total prompts analyzed in the date range             |
| `mentionedInPrompts`         | array           | Prompts where your brand was mentioned               |

## Examples

### curl

```bash
curl "https://app.limy.ai/api/v1/visibility/mentions?\
startDate=2026-01-01&endDate=2026-03-31&providers=OPENAI&providers=GEMINI" \
  -H "X-API-Key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    f"https://app.limy.ai/api/v1/visibility/mentions",
    headers={"X-API-Key": API_KEY},
    params={
        "startDate": "2026-01-01",
        "endDate": "2026-03-31",
        "providers": ["OPENAI", "GEMINI"]
    }
)

data = response.json()
print(f"Mentions: {data['mentions']} ({data['mentionsChange']:+.1f}%)")
```

### JavaScript

```javascript
const params = new URLSearchParams({
  startDate: '2026-01-01',
  endDate: '2026-03-31',
});
params.append('providers', 'OPENAI');
params.append('providers', 'GEMINI');

const response = await fetch(
  `https://app.limy.ai/api/v1/visibility/mentions?${params}`,
  { headers: { 'X-API-Key': API_KEY } }
);

const data = await response.json();
console.log(`Mentions: ${data.mentions} (${data.mentionsChange}% change)`);
```


---

# 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/appearance-over-time/mentions.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.
