> ## 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

# Preview segmentation strategy (/docs/api/settings/preview-strategy)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1707 · 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 Product Segmentation settings](/docs/api/settings/get.md), [Get inventory planning settings](/docs/api/settings/inventory-settings-get.md), [Save an inventory planning setting](/docs/api/settings/inventory-settings-update.md)

> Shows what draft strategy settings (mostly strategy_adjustments) would do, without saving them: the product and category overviews under the draft, how many products would move between segments compared with the published feed, and Stars that are out of stock.

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

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

## Try it

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



**productmetrics CLI:**

```bash
# body.json holds the JSON body from the curl example
productmetrics settings preview-strategy \
  --property-id $PROPERTY_ID \
  --body-file body.json \
  --json
```

**curl:**

```bash
curl -X POST "https://prod-backend.productmetrics.io/api/public/v1/properties/$PROPERTY_ID/settings/strategy-preview" \
  -H "Authorization: Bearer $PM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"category_col":"custom_label_0","min_clicks":50}'
```

## Response



API response (200):

```json
{
  "data": {
    "product_overview": {
      "summary": [
        {
          "product_segment": "stars",
          "Products": 42,
          "Conversions": 14,
          "Revenue": 108,
          "Spend": 40.8,
          "Clicks": 120,
          "Impressions": 4200,
          "CTR": 2.86,
          "CVR": 11.67,
          "ROAS": 1.5,
          "Gain_Loss": 12.5,
          "CPC": 0.34,
          "CPM": 9.71,
          "product_percentage": 0.25,
          "spend_percentage": 0.25,
          "revenue_percentage": 0.25
        }
      ],
      "preview": [
        {
          "item_id": "SKU-1042",
          "product_segment": "stars",
          "ROAS": 1.5,
          "metrics_conversions": 14,
          "metrics_conversions_value": 108,
          "cost": 40.8,
          "metrics_impressions": 4200,
          "metrics_clicks": 120,
          "ctr": 2.86,
          "cvr": 11.67
        }
      ]
    },
    "category_overview": {
      "overview_breakdown": [
        {
          "category": "Shoes",
          "Products": 42,
          "Conversions": 14,
          "Revenue": 108,
          "Spend": 40.8,
          "Clicks": 120,
          "Impressions": 4200,
          "CTR": 2.86,
          "CVR": 11.67,
          "ROAS": 1.5,
          "CPM": 9.71,
          "revenue_percentage": 0.25,
          "spend_percentage": 0.25,
          "product_percentage": 0.25
        }
      ],
      "product_segment_breakdown": [
        {
          "category": "Shoes",
          "Products": 42,
          "Conversions": 14,
          "Revenue": 108,
          "Spend": 40.8,
          "Clicks": 120,
          "Impressions": 4200,
          "CTR": 2.86,
          "CVR": 11.67,
          "ROAS": 1.5,
          "CPM": 9.71,
          "revenue_percentage": 0.25,
          "spend_percentage": 0.25,
          "product_percentage": 0.25,
          "product_segment": "stars"
        }
      ],
      "priority_breakdown": [
        {
          "category": "Shoes",
          "Products": 42,
          "Conversions": 14,
          "Revenue": 108,
          "Spend": 40.8,
          "Clicks": 120,
          "Impressions": 4200,
          "CTR": 2.86,
          "CVR": 11.67,
          "ROAS": 1.5,
          "CPM": 9.71,
          "revenue_percentage": 0.25,
          "spend_percentage": 0.25,
          "product_percentage": 0.25,
          "category_priority": "high"
        }
      ]
    }
  },
  "request_id": "req_01JY6BMXN0W01GAB7WDYKVEMGP"
}
```

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

## Before you call

Use it instead of [`settings.preview`](/docs/api/settings/preview) when the change is to the strategy; save the chosen draft with [`settings.update`](/docs/api/settings/update).

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

## Body

A draft of Product Segmentation settings, in the shape of `labelizer_settings` from [`settings.get`](/docs/api/settings/get). The preview reads `category_col` (string), `min_clicks` (number), `data_range` (as [`settings.get`](/docs/api/settings/get) returns it), `strategy_adjustments` (object) and `excluded_campaign_ids` (numeric strings); other fields are ignored and missing ones use the defaults.

## 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_01J1B34WHX58NK2HK55EVZA70D"
}
```

| 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)
