# GET /v1/home

> The Home page: the company's figures, one row per shop, and what is waiting for a person.

Markdown twin of https://panlytics.net/developers/api/organisation-home (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

The same reads as the app's Home page, over every shop the key reaches or one shop with `shopId`. `needsAttention` is the list of things to do now across the shops: an agent waiting for approval, a connection that could not be read, a shop with no report for a month.

## 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/home
```

### Parameters

| Name | In | Type | Required | What it is |
| --- | --- | --- | --- | --- |
| `shopId` | query | integer | No | One shop to read. Leave it out for every shop the key reaches, as the Home page's All shops. |
| `Authorization` | header | string | Yes | Bearer, a space, then the key. |

### Example request

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

import requests

response = requests.get(
    "https://panlytics.net/api/v1/home",
    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/home", {
  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 |
| --- | --- | --- | --- |
| `shopIds[]` | integer[] | Yes | The shops these figures cover. |
| `headline[]` | object[] | Yes | The figures at the top of the Home page, added up over the shops. |
| `headline[].key` | string | Yes | A stable name: sales, recoverable, waste, products, categories or reporting. |
| `headline[].label` | string | Yes | What the Home page calls it. |
| `headline[].value` | number | Yes | The figure across the newest report of every category. |
| `headline[].before` | number or null | Yes | The same figure over the report before, or null when there was none. |
| `headline[].unit` | string: eur, count | Yes | Euros or a count. |
| `headline[].better` | string: up, down | Yes | Which way is good. |
| `shops[]` | object[] | Yes | One row per shop, as the Home page's table shows them. |
| `shops[].shopId` | integer | Yes | The shop. |
| `shops[].name` | string | Yes | What it is called. |
| `shops[].city` | string | Yes | Its city, or empty. |
| `shops[].kind` | string: manual, shopify, netvisor | Yes | What feeds it. |
| `shops[].categories` | integer | Yes | How many categories it has. |
| `shops[].products` | integer | Yes | How many products their newest reports hold. |
| `shops[].salesEur` | number | Yes | Sales over the newest reports, in whole euros. |
| `shops[].missedSalesEur` | number | Yes | Sales missed while shelves were empty, in whole euros. |
| `shops[].wasteEur` | number | Yes | Thrown away, in whole euros. |
| `shops[].lastReport` | string or null | Yes | When a report was last read, or null. |
| `shops[].agentsOn` | boolean | Yes | True when the agents may work in this shop. |
| `shops[].status` | string: reading, quiet, empty | Yes | reading: a report in the last 30 days; quiet: none for longer; empty: none ever. |
| `needsAttention[]` | object[] | Yes | The ten newest things waiting for a person, as the Home page lists them. |
| `needsAttention[].kind` | string: approval, source, report | Yes | approval: an agent waits for a person; source: a connection could not be read; report: no report for over a month. |
| `needsAttention[].shopId` | integer | Yes | The shop it is about. |
| `needsAttention[].shopName` | string | Yes | Its name. |
| `needsAttention[].what` | string | Yes | What happened, in one sentence. |
| `needsAttention[].at` | string | Yes | When it happened, in UTC. |
| `agents` | object | Yes | The agents, in numbers. |
| `agents.runs` | integer | Yes | Runs started in the last seven days. |
| `agents.failed` | integer | Yes | Of those, how many failed. |
| `agents.costEur` | number | Yes | What those runs cost, in euros. |
| `agents.todayEur` | number | Yes | What runs cost today, in euros. |
| `agents.budgetEur` | number | Yes | What the shops allow in a day, in euros. |
| `agents.approvalsWaiting` | integer | Yes | Proposals waiting for a person to approve them in the app. |
| `agents.shopsOn` | integer | Yes | Shops where the agents may work. |

### Example response

```json title="200"
{
  "shopIds": [
    12
  ],
  "headline": [
    {
      "key": "sales",
      "label": "Sales",
      "value": 48210,
      "before": 45102,
      "unit": "eur",
      "better": "up"
    }
  ],
  "shops": [
    {
      "shopId": 12,
      "name": "Harbour",
      "city": "Helsinki",
      "kind": "manual",
      "categories": 3,
      "products": 1204,
      "salesEur": 48210,
      "missedSalesEur": 1310,
      "wasteEur": 421,
      "lastReport": "2026-10-20T07:12:00.000Z",
      "agentsOn": true,
      "status": "reading"
    }
  ],
  "needsAttention": [
    {
      "kind": "approval",
      "shopId": 12,
      "shopName": "Harbour",
      "what": "An agent is waiting to change a reorder point",
      "at": "2026-10-25T09:00:00.000Z"
    }
  ],
  "agents": {
    "runs": 12,
    "failed": 0,
    "costEur": 0.42,
    "todayEur": 0.05,
    "budgetEur": 2,
    "approvalsWaiting": 1,
    "shopsOn": 1
  }
}
```

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