Skip to content
Store data and insights

Get Business Health

One shop's Business Health for the last window_days (7, 30 or 90) against compare (previous window, or the same window a year earlier): revenue, margin, units and stock per category × brand × country, order facts and ad spend.

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

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

Try it

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

productmetrics store get-health-slice \
  --property-id $PROPERTY_ID \
  --window-days 30 \
  --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",
    "slice": {
      "currency": "EUR",
      "builtAtMs": 0,
      "dataAsOfMs": 0,
      "version": "7f3a9c2e"
      // … 12 more fields
    }
  },
  "request_id": "req_01J267MJZGQKVTTXY5XXTVF90C"
}

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

Before you call

country (two uppercase letters) keeps one country. 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.
window_daysnumberYesThe window in days: 7, 30 or 90.
compareenumYesprevious: against the window before; year: against the same window a year earlier. One of previous, year.
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_01JCSH41VS2KB9SPTT1B7P60MJ"
}
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