Settings, product rules and feed API
API operations for Product Segmentation settings, inventory planning settings, product rules, feed source settings and feed generation.
Read and preview Product Segmentation settings, save them with If-Match, manage product rules, and push the result to the feed now instead of at the nightly run.
18 operations. Paths are relative to https://prod-backend.productmetrics.io/api/public/v1; every request needs Authorization: Bearer $PM_TOKEN. See the API overview for authentication, errors and rate limits.
Product Segmentation settings
GET /properties/{propertyId}/settings
The saved Product Segmentation settings and their version.
POST /properties/{propertyId}/settings/recommend-min-clicks
Computes the minimum clicks before a product is segmented.
POST /properties/{propertyId}/settings/preview
How products would be segmented under draft settings.
POST /properties/{propertyId}/settings/strategy-preview
What draft strategy settings would change, per segment.
PUT /properties/{propertyId}/settings
Saves Product Segmentation settings with If-Match.
Product rules
GET /properties/{propertyId}/product-rules
The property’s product rules in the order they apply.
POST /properties/{propertyId}/product-rules/preview
Which products a draft rule matches, without saving.
POST /properties/{propertyId}/product-rules
Adds a rule that sets or locks segments or priorities.
PUT /properties/{propertyId}/product-rules/{ruleId}
Changes a product rule.
PATCH /properties/{propertyId}/product-rules/{ruleId}/toggle
Turns a product rule on or off.
PUT /properties/{propertyId}/product-rules/reorder
Sets the order the rules apply in.
GET /properties/{propertyId}/product-rules/impact
What the saved, enabled rules change.
DELETE /properties/{propertyId}/product-rules/{ruleId}
Deletes a product rule permanently.
Feed
GET /properties/{propertyId}/feed/source-settings
Which custom labels carry the segment and category priority.
PUT /properties/{propertyId}/feed/source-settings
Saves which custom labels the feed writes to.
POST /properties/{propertyId}/feed/generate
Generates the supplemental feed now instead of at the nightly run.