Categories and figures

GET/v1/categories/{id}/anomalies

The products whose numbers say something is off, grouped by what is off, as the Anomalies page shows them.

What it does

Read straight off the category's newest report. Each group holds at most 60 products, the most money first.

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

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/anomalies \
  -H "Authorization: Bearer $PANLYTICS_KEY"

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/categories/40/anomalies",
    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/anomalies", {
  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 anomalies were read from.
`moneyAtStakeEur`	number	Yes	The euros at stake across every group, each product counted once.
`groups[]`	object[]	Yes	The groups, as the Anomalies page shows them.
`groups[].id`	string	Yes	A stable name for the group.
`groups[].title`	string	Yes	What is wrong, as the Anomalies page says it.
`groups[].question`	string	Yes	The question a shop owner would ask about it.
`groups[].severity`	string: money, data, watch	Yes	money costs euros, data is a figure that cannot be right, watch is worth a look.
`groups[].count`	integer	Yes	How many products are in the group.
`groups[].atStakeEur`	number or null	Yes	The euros at stake across the group, or null.
`groups[].rows[]`	object[]	Yes	The products, at most 60 per group.
`groups[].rows[].ean`	string	Yes	The product's id, usually its barcode (EAN).
`groups[].rows[].name`	string	Yes	The product's name.
`groups[].rows[].figures[]`	object[]	Yes	The figures that show what is wrong.
`groups[].rows[].figures[].label`	string	Yes	What the figure is.
`groups[].rows[].figures[].value`	number	Yes	The figure.
`groups[].rows[].figures[].unit`	string	Yes	Its unit: eur, pcs, pct, days or x.
`groups[].rows[].detail`	string or null	Yes	One more sentence when the figures do not say enough, or null.

Example response

200

{
  "categoryId": 40,
  "reportId": 311,
  "moneyAtStakeEur": 512.3,
  "groups": [
    {
      "id": "wasteNoSales",
      "title": "Thrown away, never sold",
      "question": "Why is this on the shelf at all?",
      "severity": "money",
      "count": 1,
      "atStakeEur": 18.4,
      "rows": [
        {
          "ean": "6410000000093",
          "name": "Tonic water 1 l",
          "figures": [
            {
              "label": "Thrown away",
              "value": 18.4,
              "unit": "eur"
            }
          ],
          "detail": null
        }
      ]
    }
  ]
}

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.