# Recommendations

Returns a count of recommendations grouped by status, giving an overview of your optimization pipeline.

## Request

```
GET /v1/recommendations/summary
```

### Query Parameters

| Parameter | Type          | Required | Default | Description                              |
| --------- | ------------- | -------- | ------- | ---------------------------------------- |
| `planId`  | string (UUID) | No       | —       | Filter to a specific recommendation plan |

## Response

### Success (200 OK)

```json
{
  "statusCounts": {
    "ACTIVE": 12,
    "IN_PROGRESS": 5,
    "DONE": 23,
    "DISMISSED": 3,
    "TRACKED": 8
  },
  "total": 51
}
```

### Fields

| Field                      | Type    | Description                                 |
| -------------------------- | ------- | ------------------------------------------- |
| `statusCounts`             | object  | Count of recommendations per status         |
| `statusCounts.ACTIVE`      | integer | New recommendations available for action    |
| `statusCounts.IN_PROGRESS` | integer | Recommendations currently being implemented |
| `statusCounts.DONE`        | integer | Completed recommendations                   |
| `statusCounts.DISMISSED`   | integer | Dismissed recommendations                   |
| `statusCounts.TRACKED`     | integer | Recommendations being tracked for impact    |
| `total`                    | integer | Total recommendation count                  |

## Examples

### curl

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

### Python

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

data = response.json()
print(f"Total: {data['total']}")
for status, count in data['statusCounts'].items():
    print(f"  {status}: {count}")
```

### JavaScript

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

const { statusCounts, total } = await response.json();
console.log(`Total: ${total}`);
Object.entries(statusCounts).forEach(([status, count]) =>
  console.log(`  ${status}: ${count}`)
);
```


---

# 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/summary.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.