Skip to content
Settings and rules

Generate the feed now

Starts generating the property's supplemental feed with the saved settings and product rules, instead of waiting for the nightly run.

POST /properties/{propertyId}/feed/generate

Scope write · Access Changes data · Operation id feed.generate

Try it

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

productmetrics feed generate --property-id $PROPERTY_ID --json

Response

API response (200):

{
  "data": {
    "message": "Feed generation started by front-end through c.user.id: 3e9b5c71-2f4a-4d8e-b6c0-1a2b3c4d5e6f",
    "event": {
      "id": "feed-generate-8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f-all-29658240"
    }
  },
  "request_id": "req_01JXXZW4QRB8SAD3MZ5JVQW84B"
}

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

Before you call

The last step after settings.update or a product rule change. Answers once the run has started; a 429 means a run is already in progress. Needs an editor or admin and Product Segmentation subscription.

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 write scope; connect again and allow it.",
    "details": {
      "required_scope": "write"
    }
  },
  "request_id": "req_01JK6GCCRGCND3RSJTDEYH034Y"
}
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 write 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_limitedAnswers once the run has started; a 429 means a run is already in progress.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Settings and rules operations