Categories and figures

GET/v1/categories/{id}/reports

Every report of a category, newest first: its history.

What it does

The newest report is the one every figure is worked out from. Download a report's original file with GET /v1/reports/{id}/file when hasFile is true.

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

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The category's id.
`cursor`	query	string	No	The `nextCursor` of the page before. Leave it out for the first page. Treat it as an opaque string.
`limit`	query	integer	No	How many rows on one page: 1 to 200, 50 when left out.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

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

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/categories/40/reports",
    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/reports", {
  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
`data[]`	object[]	Yes	The rows of this page.
`data[].id`	integer	Yes	The report's id. Download its original file with GET /v1/reports/{id}/file.
`data[].categoryId`	integer	Yes	The category the report belongs to.
`data[].fileName`	string or null	Yes	The name of the file that was uploaded, or null for a report read from a connection.
`data[].source`	string	Yes	Where the report came from: csv, xlsx, example, shopify or netvisor.
`data[].products`	integer	Yes	How many products the report holds.
`data[].uploadedAt`	string (ISO 8601)	Yes	When the report was uploaded, in UTC.
`data[].updatedAt`	string (ISO 8601)	Yes	When the report or its settings last changed, in UTC.
`data[].newest`	boolean	Yes	True for the newest report: the one every figure is worked out from.
`data[].hasFile`	boolean	Yes	True when the original file was kept and can be downloaded.
`nextCursor`	string or null	Yes	Send it as `cursor` for the next page. Null on the last page.
`total`	integer	Yes	How many rows the whole list has.

Example response

200

{
  "data": [
    {
      "id": 311,
      "categoryId": 40,
      "fileName": "beverages-october.xlsx",
      "source": "xlsx",
      "products": 412,
      "uploadedAt": "2026-10-20T07:12:00.000Z",
      "updatedAt": "2026-10-20T07:12:00.000Z",
      "newest": true,
      "hasFile": true
    }
  ],
  "nextCursor": null,
  "total": 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.

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.