Skip to content
Store data and insights

Get Business Health series

One shop's weekly Business Health measures over the last weeks (13 or 26) with the compare weeks, for the whole shop or one category and/or brand, optionally one country.

GET /properties/{propertyId}/business-health/series

Scope read · Access Read only · Operation id store.get_health_series

Try it

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

productmetrics store get-health-series \
  --property-id $PROPERTY_ID \
  --weeks 12.5 \
  --compare previous \
  --json

Response

API response (200), shortened:

{
  "data": {
    "stores": [
      {
        "productSpineStoreId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
        "platform": "lightspeed_c_series"
      }
    ],
    "productSpineStoreId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
    "series": {
      "currency": "EUR",
      "builtAtMs": 0,
      "dataAsOfMs": 0,
      "version": "7f3a9c2e"
      // … 8 more fields
    }
  },
  "request_id": "req_01JT14TMVZS040CSN51VZVM2QA"
}

CLI output: productmetrics store get-health-series --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Use it for trends; store.get_health_slice for one window’s breakdown. Needs Pro: without it the call answers 402 subscription_required.

Path parameters

NameTypeDescription
propertyIdstring (uuid)The property id, from productmetrics whoami or properties.list (property_id).

Query parameters

NameTypeRequiredDescription
feed_scopestringNoWhich feed of the property: a feed id, or all for the property-wide settings.
product_spine_store_idstring (uuid)NoThe shop: productSpineStoreId from store.list_shops.
weeksnumberYesHow many weeks back: 13 or 26.
compareenumYesprevious: against the window before; year: against the same window a year earlier. One of previous, year.
categorystringNoKeep one product category. 1 to 2000 characters.
brandstringNoKeep one brand. 1 to 2000 characters.
countrystringNoTwo uppercase letters (for example NL) to keep one country; empty for all.

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_01J60FPTRPH3GGM50MS05E5PZ5"
}
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.
402subscription_requiredNeeds Pro: without it the call answers 402 subscription_required.
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 Store data and insights operations