Skip to content
Settings and rules

Recommend minimum clicks

Computes the minimum clicks a product needs before Product Segmentation segments it, so the best sellers (Stars) carry a healthy share of revenue, from the property's Google Ads data.

POST /properties/{propertyId}/settings/recommend-min-clicks

Scope read · Access Read only · Operation id settings.recommend_min_clicks

Try it

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

productmetrics settings recommend-min-clicks --property-id $PROPERTY_ID --json

Response

API response (200), shortened:

{
  "data": {
    "recommended_min_clicks": 120,
    "confidence": "high",
    "reason_code": "target_reached",
    "target": {
      "stars_revenue_min": 12.5,
      "stars_revenue_max": 12.5,
      "stars_revenue_ideal": 12.5
    }
    // … 3 more fields
  },
  "request_id": "req_01JHFHJRSW80CX3VNS9K3QPHZN"
}

CLI output: productmetrics settings recommend-min-clicks --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Saves nothing: put recommended_min_clicks into the settings from settings.get, check it with settings.preview, then save with settings.update. Takes up to a minute; a 429 means the same calculation is already running, so wait and call again.

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_01JJQ7EZJVSERKTCZA10XS2EQ1"
}
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_limitedTakes up to a minute; a 429 means the same calculation is already running, so wait and call again.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Settings and rules operations