The sheet and exceptions

GET/v1/categories/{id}/sheet

The Sheet page's tabs for a category's newest report, with their columns.

What it does

A tab's columns say which ones may be edited. Read a tab's rows with GET /v1/categories/{id}/sheet/{tab}.

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}/sheet

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

curl https://panlytics.net/api/v1/categories/40/sheet \
  -H "Authorization: Bearer $PANLYTICS_KEY"

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/categories/40/sheet",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://panlytics.net/api/v1/categories/40/sheet", {
  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	Its newest report, whose rows these are.
`updatedAt`	string (ISO 8601)	Yes	When that report last changed. Send it back with an edit so a change made since is not overwritten.
`tabs[]`	object[]	Yes	The Sheet page's tabs.
`tabs[].id`	string	Yes	The tab's id, for GET /v1/categories/{id}/sheet/{tab}.
`tabs[].label`	string	Yes	What the Sheet page calls it.
`tabs[].rowCount`	integer	Yes	How many rows it holds.
`tabs[].editable`	boolean	Yes	True when at least one of its columns can be edited.
`tabs[].columns[]`	object[]	Yes	The columns, in order. A row's `cells` follow the same order.
`tabs[].columns[].key`	string	Yes	The column's key, and the `field` of an edit.
`tabs[].columns[].label`	string	Yes	Its heading, as the shop's own workbook writes it.
`tabs[].columns[].format`	string	Yes	How its values are written: a number, euros, pieces, days, a percent or text.
`tabs[].columns[].editable`	boolean	Yes	True when an edit may change it.
`tabs[].columns[].hint`	string or null	Yes	What the column is, in plain words, or null.

Example response

200

{
  "categoryId": 40,
  "reportId": 301,
  "updatedAt": "2026-10-25T09:00:00.000Z",
  "tabs": [
    {
      "id": "input",
      "label": "Input",
      "rowCount": 461,
      "editable": true,
      "columns": [
        {
          "key": "stockPcs",
          "label": "STOCK pcs",
          "format": "pcs",
          "editable": true,
          "hint": "Pieces on the shelf on the report day."
        }
      ]
    }
  ]
}

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.

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.