# Filters Reference

This page lists all filter parameter values used across the Limy API.

## Source Categories

Used in citation endpoints via the `categories` parameter:

| Value                          | Description                            |
| ------------------------------ | -------------------------------------- |
| `NEWS_AND_MEDIA`               | News outlets and media publications    |
| `BUSINESS_AND_SERVICES`        | Company websites and business services |
| `EDUCATION`                    | Educational institutions and resources |
| `GOVERNMENT_AND_INSTITUTIONAL` | Government and institutional sites     |
| `SOCIAL_MEDIA`                 | Social media platforms                 |
| `FORUMS_BLOGS_AND_COMMUNITY`   | Forums, blogs, and community sites     |
| `ECOMMERCE_AND_MARKETPLACES`   | E-commerce and marketplace sites       |
| `OTHER`                        | Uncategorized sources                  |

## Entity Scope

Used in citation endpoints via the `entityScope` parameter:

| Value         | Description                            |
| ------------- | -------------------------------------- |
| `MY_BRAND`    | Show citations for your brand only     |
| `INDUSTRY`    | Show citations across the industry     |
| `COMPETITORS` | Show citations for competitor entities |

## Prompt Types

Used via the `promptTypes` parameter:

| Value           | Description                                 |
| --------------- | ------------------------------------------- |
| `COMMERCIAL`    | Purchase-intent and product-related queries |
| `INFORMATIONAL` | Information-seeking queries                 |
| `GENERAL`       | General queries                             |

## Branded Filter

Used via the `isPromptBranded` parameter:

| Value         | Description                            |
| ------------- | -------------------------------------- |
| `Branded`     | Prompts that include a brand name      |
| `Non-Branded` | Generic prompts without brand mentions |

## Shopping Intents

Used in commerce endpoints via the `shoppingIntents` parameter:

| Value                          | Description                              |
| ------------------------------ | ---------------------------------------- |
| `DIRECT_PURCHASE_INTENT`       | User wants to buy a specific product     |
| `BEST_PRODUCT_RECOMMENDATIONS` | User looking for product recommendations |
| `PRODUCT_SPECIFICATIONS`       | User researching product specs           |
| `SHOPPING_RECOMMENDATION`      | User seeking general shopping advice     |
| `DEALS_AND_DISCOUNTS`          | User looking for deals or discounts      |
| `SPECIFIC_PRODUCT_INQUIRY`     | User asking about a specific product     |
| `PRODUCT_AVAILABILITY`         | User checking if a product is available  |

## Recommendation Statuses

Returned in recommendation endpoints:

| Value         | Description                              |
| ------------- | ---------------------------------------- |
| `ACTIVE`      | New recommendation, available for action |
| `IN_PROGRESS` | Currently being implemented              |
| `DONE`        | Completed                                |
| `DISMISSED`   | Dismissed by user                        |
| `TRACKED`     | Being tracked for impact measurement     |

## Progress History Ranges

Used in the recommendations progress-history endpoint via the `range` parameter:

| Value | Description   |
| ----- | ------------- |
| `7d`  | Last 7 days   |
| `1m`  | Last 1 month  |
| `3m`  | Last 3 months |

## Granularity

Used in time-series endpoints via the `granularity` parameter:

| Value      | Description           |
| ---------- | --------------------- |
| `days`     | Daily data points     |
| `weeks`    | Weekly data points    |
| `months`   | Monthly data points   |
| `quarters` | Quarterly data points |


---

# 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/reference/filters.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.