Skip to content
Settings and rules

Get Product Segmentation settings

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

GET /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). Set $PROPERTY_ID first.

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

Response

API response (200), shortened:

{
  "data": {
    "labelizer_settings": {
      "category_cols": [
        "custom_label_0"
      ],
      "category_col_source": "auto",
      "min_clicks": 120,
      "data_range": "L30D"
      // … 5 more fields
    },
    "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 and settings.preview with a changed copy, and save with settings.update, sending settings_version in the If-Match header.

Path parameters

NameTypeDescription
propertyIdstring (uuid)A property_id from properties.list.

Query parameters

NameTypeRequiredDescription
feed_scopestringNoWhich 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.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JQWSM6G7NX33W7ZDX6G0YFMT"
}
StatusCodeWhen
400invalid_requestA path, query or body value does not match this page. details.issues lists each location, path and message.
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
403insufficient_scopeThe token lacks the read scope (details.required_scope): sign in again and allow it.
404not_foundAn id in the path does not exist, or the signed-in person cannot open it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Settings and rules operations