The sheet and exceptions

GET/v1/categories/{id}/sheet/{tab}

Rows of one Sheet tab, sorted and searched as the Sheet page does.

What it does

Up to 200 rows a call, from from. Each row's cells follow the tab's column order.

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/{tab}

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The category's id.
`tab`	path	string	Yes	The tab's id, from GET /v1/categories/{id}/sheet.
`from`	query	integer	No	The first row to answer, counted from 0.
`count`	query	integer	No	How many rows, 1 to 200.
`sort`	query	string	No	A column key to order by. Leave it out for the tab's own order.
`dir`	query	string: asc, desc	No	asc or desc.
`q`	query	string	No	Only the rows whose text columns (the product's id, its name) contain this.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

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

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/categories/40/sheet/40",
    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/40", {
  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
`from`	integer	Yes	The first row answered.
`total`	integer	Yes	How many rows match, in all.
`rows[]`	object[]	Yes	The rows.
`rows[].ean`	string	Yes	The product's id.
`rows[].cells[]`	string[]	Yes	One value per column, in the tab's column order.

Example response

200

{
  "from": 0,
  "total": 461,
  "rows": [
    {
      "ean": "6410000000017",
      "cells": [
        "6410000000017",
        "Oat milk 1 l",
        24
      ]
    }
  ]
}

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.