# List metric reduction rules

URL: https://docs.hanzo.ai/docs/openapi/o11y/listmetricreductionrules

> Lists the org's metric volume-control (label reduction) rules, pageable and sortable by name, volume or recency.

`GET /v1/o11y/metric_reduction_rules`

> [O11y →](https://docs.hanzo.ai/docs/openapi/o11y) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                       |
| ------------- | ----------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/o11y/metric_reduction_rules` |
| **Method**    | `GET`                                                 |
| **Operation** | `ListMetricReductionRules`                            |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`                |

Lists the org's metric volume-control (label reduction)
rules, pageable and sortable by name, volume or recency.

## Request

6 fields.

| Field        | In    | Type    | Required | Description                                                                         |
| ------------ | ----- | ------- | -------- | ----------------------------------------------------------------------------------- |
| `orderBy`    | query | string  | —        | OrderBy sorts the page: metric, ingested\_volume, reduced\_volume or last\_updated. |
| `order`      | query | string  | —        | Order is asc or desc.                                                               |
| `search`     | query | string  | —        | Search narrows the page to rules whose metric name contains it.                     |
| `metricName` | query | string  | —        | MetricName narrows the page to one metric's rule.                                   |
| `offset`     | query | integer | —        | Offset is how many rules to skip, for paging.                                       |
| `limit`      | query | integer | —        | Limit caps how many rules come back, at most 1000.                                  |

## Response

| Status    | Body                          | Meaning           |
| --------- | ----------------------------- | ----------------- |
| `200`     | o11y.O11yReductionRuleListOut | ok                |
| `202`     | Approval                      | held for approval |
| `default` | problem-details               | refused           |

`200` body — 18 fields.

| Field                          | In   | Type                      | Always | Description                                                            |
| ------------------------------ | ---- | ------------------------- | ------ | ---------------------------------------------------------------------- |
| `data`                         | body | o11y.O11yReductionRules   | —      |                                                                        |
| `data.rules`                   | body | o11y.O11yReductionRule\[] | —      | Rules are the rules.                                                   |
| `data.rules[].active`          | body | boolean                   | —      | Active says whether the rule is in force.                              |
| `data.rules[].createdAt`       | body | string (date-time)        | —      | CreatedAt is when the rule was created.                                |
| `data.rules[].createdBy`       | body | string                    | —      | CreatedBy is who created it.                                           |
| `data.rules[].effectiveFrom`   | body | string (date-time)        | —      | EffectiveFrom is when the rule took effect.                            |
| `data.rules[].id`              | body | string                    | —      | ID is the rule's id.                                                   |
| `data.rules[].ingestedSamples` | body | integer (uint64)          | —      | IngestedSamples is how many samples arrived while the rule was active. |
| `data.rules[].ingestedSeries`  | body | integer (uint64)          | —      | IngestedSeries is how many series arrived while the rule was active.   |
| `data.rules[].labels`          | body | string\[]                 | —      | Labels are the label names the rule matches.                           |
| `data.rules[].matchType`       | body | string                    | —      | MatchType is drop or keep.                                             |
| `data.rules[].metricName`      | body | string                    | —      | MetricName is the metric the rule governs.                             |
| `data.rules[].retainedSamples` | body | integer (uint64)          | —      | RetainedSamples is how many of them were kept.                         |
| `data.rules[].retainedSeries`  | body | integer (uint64)          | —      | RetainedSeries is how many of them were kept.                          |
| `data.rules[].updatedAt`       | body | string (date-time)        | —      | UpdatedAt is when the rule last changed.                               |
| `data.rules[].updatedBy`       | body | string                    | —      | UpdatedBy is who last changed it.                                      |
| `data.total`                   | body | integer (int64)           | —      | Total is how many rules matched, across all pages.                     |
| `status`                       | body | string                    | —      | Status is "success".                                                   |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo o11y metric_reduction_rules list
```

**SDK**

**.ts**

```ts
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listMetricReductionRules();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).list_metric_reduction_rules()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.ListMetricReductionRules(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::list_metric_reduction_rules(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).listMetricReductionRules();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/o11y/metric_reduction_rules \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `o11y`, op `ListMetricReductionRules` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "o11y",
         "arguments": {
           "op": "ListMetricReductionRules",
           "input": {}
         }
       }
     }'
```

---

[O11y API](https://docs.hanzo.ai/docs/openapi/o11y) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
