> ## Documentation Index
> Fetch the complete documentation index at: https://e328d4e-productmetrics.manicule.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://e328d4e-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://e328d4e-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://e328d4e-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# Get Business Health (/docs/api/store-data/store-get-health-slice)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1784 · updated: 2026-11-16 -->
Related: [Get analytics status](/docs/api/store-data/analytics-get-status.md), [Query the lake](/docs/api/store-data/data-query.md), [Get an insight card](/docs/api/store-data/insights-get.md), [Get inventory state](/docs/api/store-data/inventory-get-state.md), [Check orders are available](/docs/api/store-data/orders-get-availability.md), [Get an order](/docs/api/store-data/orders-get.md)

> 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 https://prod-backend.productmetrics.io/api/public/v1/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](/docs/api/overview#authentication)). Set `$PROPERTY_ID` first.



**productmetrics CLI:**

```bash
productmetrics store get-health-slice \
  --property-id $PROPERTY_ID \
  --window-days 30 \
  --compare previous \
  --json
```

**curl:**

```bash
curl "https://prod-backend.productmetrics.io/api/public/v1/properties/$PROPERTY_ID/business-health/slice?window_days=30&compare=previous" \
  -H "Authorization: Bearer $PM_TOKEN"
```

## Response



API response (200):

```json
{
  "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",
      "retainedFromDay": "2026-11-02",
      "firstSaleDay": "2026-11-02",
      "windowDays": 7,
      "compare": "previous",
      "window": {
        "start": "2026-11-02",
        "end": "2026-11-02"
      },
      "comparisonWindow": {
        "start": "2026-11-02",
        "end": "2026-11-02"
      },
      "otherCurrencyShare": {
        "current": 0,
        "comparison": 0
      },
      "categories": [
        "Shoes"
      ],
      "brands": [
        "Example Brand"
      ],
      "current": {
        "category": [
          0
        ],
        "brand": [
          0
        ],
        "revenueMicros": [
          108000000
        ],
        "units": [
          3
        ],
        "unpricedUnits": [
          3
        ],
        "costMicros": [
          40800000
        ],
        "costedRevenueMicros": [
          40800000
        ],
        "refundedMicros": [
          108000000
        ],
        "refundedUnits": [
          3
        ],
        "releasedMicros": [
          108000000
        ]
      },
      "comparison": {
        "category": [
          0
        ],
        "brand": [
          0
        ],
        "revenueMicros": [
          108000000
        ],
        "units": [
          3
        ],
        "unpricedUnits": [
          3
        ],
        "costMicros": [
          40800000
        ],
        "costedRevenueMicros": [
          40800000
        ],
        "refundedMicros": [
          108000000
        ],
        "refundedUnits": [
          3
        ],
        "releasedMicros": [
          108000000
        ]
      },
      "stock": {
        "category": [
          0
        ],
        "brand": [
          0
        ],
        "status": [
          "selling"
        ],
        "stockValueMicros": [
          108000000
        ],
        "units": [
          3
        ],
        "unvaluedUnits": [
          3
        ]
      }
    }
  },
  "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

| Name         | Type          | Description                                                                                                         |
| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------- |
| `propertyId` | string (uuid) | The property id, from `productmetrics whoami` or [`properties.list`](/docs/api/account/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`](/docs/api/store-data/store-list-shops).                      |
| `window_days`            | number        | Yes      | The window in days: 7, 30 or 90.                                                                                  |
| `compare`                | enum          | Yes      | `previous`: against the window before; `year`: against the same window a year earlier. One of `previous`, `year`. |
| `country`                | string        | No       | Two 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`.

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JCSH41VS2KB9SPTT1B7P60MJ"
}
```

| 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.                           |

[All Store data and insights operations](/docs/api/store-data)
