# GET /v1/categories/{id}/summary

> The top of a category's Report page: its headline figures, where the money is, and how long each list of things to do is.

Markdown twin of https://panlytics.net/developers/api/categories-summary (last updated 2026-10-25). Every page of the Panlytics developer docs is listed at https://panlytics.net/developers/llms.txt, and all of them are in one file at https://panlytics.net/developers/llms-full.txt. The site guide is https://panlytics.net/llms.txt.

## What it does

Worked out from the category's newest report when you read it, as the app's Report page is. The three counts under `toDo` are the lengths of the reorder points, order now and stop stocking lists.

## Who may call it

A key whose maker's role holds `figures` (see the figures), after the fence, for the shop or category it names.

## Request

```http
GET https://panlytics.net/api/v1/categories/{id}/summary
```

### Parameters

| Name | In | Type | Required | What it is |
| --- | --- | --- | --- | --- |
| `id` | path | integer | Yes | The category's id. |
| `Authorization` | header | string | Yes | Bearer, a space, then the key. |

### Example request

```bash title="curl"
curl https://panlytics.net/api/v1/categories/40/summary \
  -H "Authorization: Bearer $PANLYTICS_KEY"
```
```python title="Python"
import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/categories/40/summary",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())
```
```typescript title="TypeScript"
const response = await fetch("https://panlytics.net/api/v1/categories/40/summary", {
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
  },
});
if (!response.ok) throw new Error(`Panlytics answered ${response.status}`);
console.log(await response.json());
```

## Response

`200`: The answer, as JSON.

| Field | Type | Always there | What it is |
| --- | --- | --- | --- |
| `categoryId` | integer | Yes | The category. |
| `reportId` | integer | Yes | The report the figures were worked out from: the category's newest. |
| `periodDays` | number | Yes | How many days the report covers. |
| `headline[]` | object[] | Yes | The headline figures, as the top of the Report page shows them. |
| `headline[].key` | string | Yes | A stable name for the figure. |
| `headline[].label` | string | Yes | What the Report page calls it. |
| `headline[].value` | number | Yes | The figure now. |
| `headline[].unit` | string | Yes | The unit: eur, pcs, kg, hours, days, ratio or count. |
| `headline[].expected` | number or null | Yes | What the figure becomes at Panlytics' reorder points, or null. |
| `headline[].delta` | number or null | Yes | `expected` minus `value`, or null. |
| `headline[].higherIsBetter` | boolean | Yes | True when a higher figure is the better one. |
| `gains[]` | object[] | Yes | Where the money is, line by line. |
| `gains[].key` | string | Yes | A stable name for the gain. |
| `gains[].label` | string | Yes | What the Report page calls it. |
| `gains[].valueEur` | number | Yes | The profit, in euros, over the report's period. |
| `gains[].caption` | string | Yes | One sentence about it, as the Report page says it. |
| `lossMakers` | object | Yes | Products sold below what they cost. |
| `lossMakers.count` | integer | Yes | How many products sold at a loss. |
| `lossMakers.drainEur` | number | Yes | What they lost, in euros, over the period. |
| `waste` | object | Yes | What was thrown away. |
| `waste.totalEur` | number | Yes | Thrown away over the period, in euros. |
| `waste.totalPcs` | number | Yes | Thrown away over the period, in pieces. |
| `waste.annualEur` | number | Yes | The same, over a year at this pace, in euros. |
| `stock` | object | Yes | What the shop holds in this category. |
| `stock.valueEur` | number | Yes | The money tied up in stock now. |
| `stock.pieces` | number | Yes | The pieces in stock now. |
| `toDo` | object | Yes | What to do now: how long each of the three lists is. |
| `toDo.reorderPoints` | integer | Yes | Products whose reorder point should change: GET /v1/categories/{id}/reorder-points. |
| `toDo.orderNow` | integer | Yes | Products at or under their reorder point: GET /v1/categories/{id}/order-list. |
| `toDo.stopStocking` | integer | Yes | Products worth no longer stocking: GET /v1/categories/{id}/stop-stocking. |

### Example response

```json title="200"
{
  "categoryId": 40,
  "reportId": 311,
  "periodDays": 30,
  "headline": [
    {
      "key": "sales",
      "label": "Sales",
      "value": 48210.5,
      "unit": "eur",
      "expected": 49520.7,
      "delta": 1310.2,
      "higherIsBetter": true
    }
  ],
  "gains": [
    {
      "key": "recovered",
      "label": "Sales you missed, won back",
      "valueEur": 410.2,
      "caption": "Shelves that ran empty, kept full."
    }
  ],
  "lossMakers": {
    "count": 3,
    "drainEur": 41.5
  },
  "waste": {
    "totalEur": 420.75,
    "totalPcs": 212,
    "annualEur": 5119.1
  },
  "stock": {
    "valueEur": 18200.4,
    "pieces": 9120
  },
  "toDo": {
    "reorderPoints": 58,
    "orderNow": 17,
    "stopStocking": 9
  }
}
```

## Errors

A refusal is JSON with a `code`, a sentence in `error`, and a `requestId` when the fault is ours. Read the code, not the sentence. Every code is listed on [Errors](https://panlytics.net/developers/security/errors).

| Status | Code | When | What to do |
| --- | --- | --- | --- |
| 400 | `api.invalid` | A path id, a query parameter, a header or a body field is missing or not valid. `detail` names the field. | Read that endpoint in the API reference, correct the field and call again. |
| 401 | `api.key_missing` | The call had no Authorization header. | Send the key in the Authorization header as Bearer, then call again. |
| 401 | `api.key_refused` | The key is wrong, revoked, past its end, or its maker or company no longer allows it (developer mode off, the maker removed or switched off, or the maker's role lost the developer ability). | Ask the person who gave you the key to make a new one. |
| 401 | `api.wrong_key_kind` | This key does not open these endpoints. | Use the key these endpoints were made for, or ask the person who gave you the key. |
| 403 | `refused` | The key's maker may not do this here: their role lacks the ability, or the shop or category is outside their reach. | Ask the CEO for a role that allows it, or call it for a shop or category the role reaches. |
| 403 | `auth.not_fresh` | This step needs you to prove it is you. | Confirm your password or passkey, then try again. |
| 404 | `not_found.said` | Nothing with that id in the key's company. An id of another company answers the same. | Check the id. List the shop or category it belongs to and take the id from there. |
| 409 | `report.none` | There is no report yet to work from. | Upload a report first, with POST /v1/shops/{id}/reports. |
| 429 | `api.rate_limited` | The key made more than 120 calls in this minute. Wait the seconds in Retry-After. | Wait the seconds in Retry-After, then call again. |
| 500 | `server` | Something failed on our side. The answer carries a requestId to quote. | Try again in a minute; if it keeps happening, report it. |
| 503 | `developer.unavailable` | API keys are not set up on this deployment yet. | Report it, and we will switch them on. |