> ## Documentation Index
> Fetch the complete documentation index at: https://85b42a7-productmetrics.manicule.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://85b42a7-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://85b42a7-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://85b42a7-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# Get Product Segmentation settings (/docs/api/settings/get)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1447 · updated: 2026-11-16 -->
Related: [Generate the feed now](/docs/api/settings/feed-generate.md), [Get feed source settings](/docs/api/settings/feed-source-settings-get.md), [Save feed source settings](/docs/api/settings/feed-source-settings-update.md), [Get inventory planning settings](/docs/api/settings/inventory-settings-get.md), [Save an inventory planning setting](/docs/api/settings/inventory-settings-update.md), [Preview segmentation strategy](/docs/api/settings/preview-strategy.md)

> The property's saved Product Segmentation settings (minimum clicks, data range, category column, strategy adjustments, excluded campaigns) and their settings_version.

`GET https://prod-backend.productmetrics.io/api/public/v1/properties/{propertyId}/settings`

**Scope** `read` · **Access** Read only · **Operation id** `settings.get`

## Try it

`productmetrics` runs after `productmetrics login`; curl needs `PM_TOKEN` (see [Authentication](/docs/api/overview#authentication)). Set `$PROPERTY_ID` first.



**productmetrics CLI:**

```bash
productmetrics settings get --property-id $PROPERTY_ID --json
```

**curl:**

```bash
curl "https://prod-backend.productmetrics.io/api/public/v1/properties/$PROPERTY_ID/settings" \
  -H "Authorization: Bearer $PM_TOKEN"
```

## Response



API response (200):

```json
{
  "data": {
    "labelizer_settings": {
      "category_cols": [
        "custom_label_0"
      ],
      "category_col_source": "auto",
      "min_clicks": 120,
      "data_range": "L30D",
      "excluded_campaign_ids": [
        "21334455667"
      ],
      "supplemental_feed_source_settings": {
        "product_segment": {
          "enabled": true,
          "target_custom_label": "custom_label_0"
        },
        "category_priority": {
          "enabled": true,
          "target_custom_label": "custom_label_0"
        },
        "force_override": true,
        "custom_fields": "custom_label_0"
      },
      "auto_optimized": {
        "source": "first_labelizer_call",
        "mode": "aggressive",
        "target_stars_revenue_min": 12.5,
        "target_stars_revenue_max": 12.5,
        "target_stars_revenue_ideal": 12.5,
        "recommended_min_clicks": 120,
        "confidence": "high",
        "reason_code": "target_reached",
        "stars_revenue_share": 0.25,
        "stars_product_share": 0.25,
        "stars_count": 42,
        "total_products": 42,
        "optimized_at": "2026-11-02T09:30:00.000Z"
      },
      "strategy_adjustments": {
        "margin_poas": {
          "enabled": false,
          "margin_value_kind": "percent"
        },
        "target_anchor": {
          "enabled": false,
          "target_roas": null
        },
        "seasonality": {
          "enabled": false
        },
        "price_ratio": {
          "enabled": false
        },
        "inventory": {
          "optimise_for": "revenue",
          "clear_scope": "dead",
          "stockout_protection": true,
          "stability_days": 7,
          "ads_influence": 1,
          "business_influence": 1,
          "stock_influence": 1
        }
      },
      "weather_country": "NL"
    },
    "settings_source": "legacy_property",
    "settings_version": 1,
    "settings_hash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
  },
  "request_id": "req_01J8A94CAYX3K1K9G59EZJ4Q85"
}
```

**CLI output:** `productmetrics settings get --json` prints `{ "ok": true, "data": …, "request_id": "…" }` with the same `data`.

## Before you call

Step 1 of finding the ideal settings: read these first, then call [`settings.recommend_min_clicks`](/docs/api/settings/recommend-min-clicks) and [`settings.preview`](/docs/api/settings/preview) with a changed copy, and save with [`settings.update`](/docs/api/settings/update), sending `settings_version` in the If-Match header.

## Path parameters

| Name         | Type          | Description                                                           |
| ------------ | ------------- | --------------------------------------------------------------------- |
| `propertyId` | string (uuid) | A property_id from [`properties.list`](/docs/api/account/properties-list). |

## Query parameters

| Name         | Type   | Required | Description                                                                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `feed_scope` | string | No       | Which feed of the property: a feed id, or `all` for the property-wide settings. Omitted: the property's default scope. |

## Errors

A failure answers with its HTTP status and `{ error: { code, message, details? }, request_id }`. Branch on `code` (stable, lower_snake); show `message` to the person. The CLI prints the same `error` with `"ok": false`.

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JQWSM6G7NX33W7ZDX6G0YFMT"
}
```

| Status | Code                 | When                                                                                                                      |
| ------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| 400    | `invalid_request`    | A path, query or body value does not match this page. `details.issues` lists each `location`, `path` and `message`.       |
| 401    | `invalid_token`      | The token is missing, expired or revoked: sign in again (`productmetrics login`). The `WWW-Authenticate` header says why. |
| 403    | `insufficient_scope` | The token lacks the `read` scope (`details.required_scope`): sign in again and allow it.                                  |
| 404    | `not_found`          | An id in the path does not exist, or the signed-in person cannot open it.                                                 |
| 429    | `rate_limited`       | More than 600 requests a minute for this person: wait the `Retry-After` seconds (60) and retry.                           |

[All Settings and rules operations](/docs/api/settings)
