List Business Health products
One shop's products with their revenue, margin and units over the last window_days (7, 30 or 90) and their stock now; page with limit and offset, sort by id or revenue, search by name or id, and keep one category and/or brand.
GET /properties/{propertyId}/business-health/products
Scope read · Access Read only · Operation id store.list_health_products
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID first.
productmetrics store list-health-products \
--property-id $PROPERTY_ID \
--window-days 30 \
--jsonResponse
API response (200), shortened:
{
"data": {
"stores": [
{
"productSpineStoreId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"platform": "lightspeed_c_series"
}
],
"productSpineStoreId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"products": {
"currency": "EUR",
"builtAtMs": 0,
"dataAsOfMs": 0,
"version": "7f3a9c2e"
// … 7 more fields
}
},
"request_id": "req_01JPZRGT40A29B5J28HRNG5N20"
}CLI output: productmetrics store list-health-products --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Needs Pro: without it the call answers 402 subscription_required.
Path parameters
| Name | Type | Description |
|---|---|---|
propertyId | string (uuid) | The property id, from productmetrics whoami or properties.list (property_id). |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
feed_scope | string | No | Which feed of the property: a feed id, or all for the property-wide settings. |
product_spine_store_id | string (uuid) | No | The shop: productSpineStoreId from store.list_shops. |
window_days | number | Yes | The window in days: 7, 30 or 90. |
limit | integer | No | How many items to return. From 1 to 5000. |
offset | integer | No | One shop’s products with their revenue, margin and units over the last window_days (7, 30 or 90) and their stock now; page with limit and offset, sort by id or revenue, search by name or id, and keep one category and/or brand. From 0 to 1000000. |
sort | enum | No | One shop’s products with their revenue, margin and units over the last window_days (7, 30 or 90) and their stock now; page with limit and offset, sort by id or revenue, search by name or id, and keep one category and/or brand. One of id, revenue. |
search | string | No | One shop’s products with their revenue, margin and units over the last window_days (7, 30 or 90) and their stock now; page with limit and offset, sort by id or revenue, search by name or id, and keep one category and/or brand. 1 to 200 characters. |
category | string | No | Keep one product category. 1 to 2000 characters. |
brand | string | No | Keep one brand. 1 to 2000 characters. |
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_01JTSXCYXSVT117J93X81PNRAK"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 402 | subscription_required | Needs Pro: without it the call answers 402 subscription_required. |
| 403 | insufficient_scope | The token lacks the read scope (details.required_scope): sign in again and allow it. |
| 404 | not_found | An id in the path does not exist, or the signed-in person cannot open it. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |