List product rules
The property's product rules in the order they apply: each rule's conditions, the segment or priority it sets (or a segment lock), and whether it is enabled.
GET /properties/{propertyId}/product-rules
Scope read · Access Read only · Operation id product_rules.list
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID first.
productmetrics product-rules list --property-id $PROPERTY_ID --jsonResponse
API response (200), shortened:
{
"data": {
"rules": [
{
"id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
"google_ads_property_feed_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"user_id": "3e9b5c71-2f4a-4d8e-b6c0-1a2b3c4d5e6f",
"name": "Lock Stars during the winter sale",
"description": "Keeps winter jackets as Stars until the sale ends."
// … 14 more fields
}
]
},
"request_id": "req_01JJ324EE4ZJVF62R517AEQ74V"
}CLI output: productmetrics product-rules list --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Rules override Product Segmentation segments for the products they match. Call product_rules.get_impact to see what they change.
Path parameters
| Name | Type | Description |
|---|---|---|
propertyId | string (uuid) | A property_id from 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.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the read scope; connect again and allow it.",
"details": {
"required_scope": "read"
}
},
"request_id": "req_01JV9K4TVMJ7V1GCMN55RDHS0J"
}| 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. |