Connected sources

GET/v1/shops/{id}/netvisor/plan

What a report read from the shop's Netvisor would hold, before anything is written.

What it does

Reads the source and describes what a report would hold, with every gap in full sentences, and writes nothing. Thirty plans and reports an hour per person and source, as in the app.

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/shops/{id}/netvisor/plan

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The shop's id.
`productGroup`	query	string	No	Only this Netvisor product group. Left out, the whole company.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

curl https://panlytics.net/api/v1/shops/12/netvisor/plan \
  -H "Authorization: Bearer $PANLYTICS_KEY"

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/shops/12/netvisor/plan",
    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/shops/12/netvisor/plan", {
  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
`companyName`	string	Yes	The Netvisor company's name.
`windowDays`	integer	Yes	Days the report covers. Never longer than the source will serve.
`periodAsked`	integer	Yes	The period the category was set up with, when it differs.
`category`	string	Yes	The category the report would be filed under.
`coverage`	object	Yes	How much of what the report needs the source holds.
`coverage.seen`	integer	Yes	Products the source returned, before anything was left out.
`coverage.notForSale`	integer	Yes	Left out because they are drafts or archived.
`coverage.rows`	integer	Yes	Rows the report will carry.
`coverage.withBarcode`	integer	Yes	Rows with a barcode.
`coverage.withCost`	integer	Yes	Rows with a cost price.
`coverage.withStockTracking`	integer	Yes	Rows whose stock is tracked.
`coverage.withSales`	integer	Yes	Rows that sold at least one piece in the period.
`coverage.withAvailability`	integer	Yes	Rows with a measured count of days out of stock.
`availability`	object	Yes	Whether days out of stock were measured. Fewer days than the window make every count a floor.
`availability.measured`	boolean	Yes	True when days out of stock were measured.
`availability.daysObserved`	integer	Yes	Over how many days of history.
`availability.firstDay`	string or null	Yes	The first day observed, or null.
`warnings[]`	string[]	Yes	Everything to know before trusting the figures, in full sentences, in the order they matter.
`groups[]`	object[]	Yes	Every product group on offer, with its count of products.
`groups[].label`	string	Yes	The product group.
`groups[].products`	integer	Yes	Its products.
`invoices`	integer	Yes	Sales invoices in the window.

Example response

200

{
  "companyName": "Harbour Oy",
  "category": "Beverages",
  "groups": [
    {
      "label": "Beverages",
      "products": 412
    }
  ],
  "invoices": 920,
  "windowDays": 30,
  "periodAsked": 30,
  "coverage": {
    "seen": 420,
    "notForSale": 8,
    "rows": 412,
    "withBarcode": 400,
    "withCost": 380,
    "withStockTracking": 412,
    "withSales": 350,
    "withAvailability": 412
  },
  "availability": {
    "measured": true,
    "daysObserved": 30,
    "firstDay": "2026-09-27"
  },
  "warnings": [
    "Waste is not recorded in this source, so the figures assume none."
  ]
}

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.
403	`refused.demo`	The key belongs to a shared demo account, which may not change anything.	Use a key made in a real company account.
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	`source.none`	No source is connected to this shop.	Connect one from Sources, then try again.
409	`report.empty`	That came back with nothing in it.	Check the source has data for the period, then try again.
422	`source.said`		Check the source's settings, then try again.
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.
429	`source.busy`	That is a lot of reads from this source in one hour.	Give it a few minutes and press 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.
502	`report.failed`	That report could not be worked out.	Try again; 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.