# Filtering

Most analytics endpoints accept a common set of filter parameters to narrow results by provider, topic, region, date range, and more.

## Common Filters

These parameters are available on most analytics endpoints:

| Parameter         | Type                | Description                                                                |
| ----------------- | ------------------- | -------------------------------------------------------------------------- |
| `startDate`       | string (ISO 8601)   | Start of date range. Example: `2026-01-01`                                 |
| `endDate`         | string (ISO 8601)   | End of date range. Example: `2026-03-31`                                   |
| `providers`       | string or string\[] | Filter by AI provider. See [Providers](/reference/providers.md) for values |
| `topicIds`        | string or string\[] | Filter by topic UUID                                                       |
| `countries`       | string or string\[] | Filter by ISO 2-letter country code (e.g., `US`, `DE`, `GB`)               |
| `isPromptBranded` | string or string\[] | `Branded` or `Non-Branded`                                                 |
| `promptTypes`     | string or string\[] | `COMMERCIAL`, `INFORMATIONAL`, or `GENERAL`                                |
| `promptIds`       | string or string\[] | Filter by specific prompt UUIDs                                            |

## Array Parameters

All array parameters accept both single values and multiple values:

```
# Single value
?providers=OPENAI

# Multiple values
?providers=OPENAI&providers=GEMINI

# Works for all array params
?countries=US&countries=DE&topicIds=abc-123&topicIds=def-456
```

## Date Ranges

Dates are accepted in ISO 8601 format:

```
?startDate=2026-01-01&endDate=2026-03-31
```

When no date range is specified, most endpoints default to the last 30 days of data.

## Commerce-Specific Filters

Commerce endpoints accept additional filters:

| Parameter         | Type                | Description                    |
| ----------------- | ------------------- | ------------------------------ |
| `shoppingIntents` | string or string\[] | Filter by shopping intent type |

Shopping intent values: `DIRECT_PURCHASE_INTENT`, `BEST_PRODUCT_RECOMMENDATIONS`, `PRODUCT_SPECIFICATIONS`, `SHOPPING_RECOMMENDATION`, `DEALS_AND_DISCOUNTS`, `SPECIFIC_PRODUCT_INQUIRY`, `PRODUCT_AVAILABILITY`

## Citation-Specific Filters

Citation endpoints accept additional filters:

| Parameter      | Type                | Description                                                      |
| -------------- | ------------------- | ---------------------------------------------------------------- |
| `categories`   | string or string\[] | Source category (see [Filters reference](/reference/filters.md)) |
| `entityScope`  | string              | `MY_BRAND`, `INDUSTRY`, or `COMPETITORS`                         |
| `competitorId` | string (UUID)       | Filter to a specific competitor                                  |
| `domains`      | string or string\[] | Filter by domain name                                            |

## Example Request with Filters

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


---

# 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/getting-started/filtering.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.