Skip to content
Settings and rules

Get product rules impact

What the saved, enabled product rules change: how many products move between segments compared with the feed without rules, and per rule how many products it matches and changes.

GET /properties/{propertyId}/product-rules/impact

Scope read · Access Read only · Operation id product_rules.get_impact

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID first.

productmetrics product-rules get-impact --property-id $PROPERTY_ID --json

Response

API response (200), shortened:

{
  "data": {
    "total_products": 42,
    "segments": {
      "total": 42,
      "moves": [
        { … }
      ]
      // … 1 more field
    }
    // … 1 more field
  },
  "request_id": "req_01J4FBCXVSETMHM6FDXCJTJHKV"
}

CLI output: productmetrics product-rules get-impact --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Use it after product_rules.list to find rules that do nothing or move too much.

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_01JT2GM5D2TSMBKZ5YHHV3Z47H"
}
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