Skip to content
Settings and rules

Get feed source settings

Which custom labels of the supplemental feed carry the product segment and the category priority, the custom fields, and settings_version.

GET /properties/{propertyId}/feed/source-settings

Scope read · Access Read only · Operation id feed_source_settings.get

Try it

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

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

Response

API response (200):

{
  "data": {
    "product_segment": {
      "enabled": true,
      "target_custom_label": "custom_label_0"
    },
    "category_priority": {
      "enabled": true,
      "target_custom_label": "custom_label_0"
    },
    "force_override": true,
    "custom_fields": "custom_label_0",
    "preview": true,
    "configured": true,
    "settings_version": 1
  },
  "request_id": "req_01J4050772KZP79NZR523Y9RH7"
}

CLI output: productmetrics feed-source-settings get --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Read this before feed_source_settings.update. preview: true means the property has no Product Segmentation subscription: the settings can be read but no feed is generated.

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