Connected sources

POST/v1/shops/{id}/netvisor/reports

Read the shop's Netvisor and file it as a report.

What it does

Reads the source again (never a plan you send back) and files the result as the category's next report, through the same pipeline as an upload. An earlier report read from the same source on the same day is replaced. Needs the sheet ability over the whole shop, and is written to the audit log. Read the plan first and tell the person its warnings. Send an Idempotency-Key header so a retry never files it twice.

Who may call it

A key whose maker's role holds sheet (edit the sheet and upload a report), after the fence, for the shop or category it names.

Request

HTTP
POST https://panlytics.net/api/v1/shops/{id}/netvisor/reports

Parameters

NameInTypeRequiredWhat it is
idpathintegerYesThe shop's id.
AuthorizationheaderstringYesBearer, a space, then the key.
Idempotency-KeyheaderstringNoAny string up to 255 characters, new for each new request. The same key with the same request within 24 hours answers with the first answer again and does nothing twice.

Body

Sent as application/json.

FieldTypeRequiredWhat it is
productGroupstringNoOnly this Netvisor product group. Left out, the whole company.

Example request

curl -X POST https://panlytics.net/api/v1/shops/12/netvisor/reports \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "productGroup": "Beverages"
}'

Response

201: Created. The answer is what was made, as JSON.

FieldTypeAlways thereWhat it is
reportIdintegerYesThe new report's id.
categoryIdinteger or nullYesThe category it was filed under.
shopIdintegerYesThe shop.
categorystringYesThe category's name.
rowsintegerYesHow many products the report holds.
fixesintegerYesHow many values the cleaner repaired or worked out on the way in.
planobjectYesWhat was read, as the plan describes it.
plan.companyNamestringYesThe Netvisor company's name.
plan.windowDaysintegerYesDays the report covers. Never longer than the source will serve.
plan.periodAskedintegerYesThe period the category was set up with, when it differs.
plan.categorystringYesThe category the report would be filed under.
plan.coverageobjectYesHow much of what the report needs the source holds.
plan.coverage.seenintegerYesProducts the source returned, before anything was left out.
plan.coverage.notForSaleintegerYesLeft out because they are drafts or archived.
plan.coverage.rowsintegerYesRows the report will carry.
plan.coverage.withBarcodeintegerYesRows with a barcode.
plan.coverage.withCostintegerYesRows with a cost price.
plan.coverage.withStockTrackingintegerYesRows whose stock is tracked.
plan.coverage.withSalesintegerYesRows that sold at least one piece in the period.
plan.coverage.withAvailabilityintegerYesRows with a measured count of days out of stock.
plan.availabilityobjectYesWhether days out of stock were measured. Fewer days than the window make every count a floor.
plan.availability.measuredbooleanYesTrue when days out of stock were measured.
plan.availability.daysObservedintegerYesOver how many days of history.
plan.availability.firstDaystring or nullYesThe first day observed, or null.
plan.warnings[]string[]YesEverything to know before trusting the figures, in full sentences, in the order they matter.
plan.groups[]object[]YesEvery product group on offer, with its count of products.
plan.groups[].labelstringYesThe product group.
plan.groups[].productsintegerYesIts products.
plan.invoicesintegerYesSales invoices in the window.

Example response

201
{
  "reportId": 311,
  "categoryId": 40,
  "shopId": 12,
  "category": "Beverages",
  "rows": 412,
  "fixes": 37,
  "plan": {
    "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.

StatusCodeWhenWhat to do
400api.invalidA 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.
401api.key_missingThe call had no Authorization header.Send the key in the Authorization header as Bearer, then call again.
401api.key_refusedThe 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.
401api.wrong_key_kindThis key does not open these endpoints.Use the key these endpoints were made for, or ask the person who gave you the key.
403refusedThe 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.
403auth.not_freshThis step needs you to prove it is you.Confirm your password or passkey, then try again.
403refused.demoThe key belongs to a shared demo account, which may not change anything.Use a key made in a real company account.
404not_found.saidNothing 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.
409source.noneNo source is connected to this shop.Connect one from Sources, then try again.
409report.emptyThat came back with nothing in it.Check the source has data for the period, then try again.
409api.idempotency_conflictThat Idempotency-Key was sent before with a different request.Send a new key with a new request, or send the first request again unchanged.
409api.idempotency_busyThe first request with that Idempotency-Key is still running.Wait a few seconds, then send it again.
422source.saidCheck the source's settings, then try again.
429api.rate_limitedThe key made more than 120 calls in this minute. Wait the seconds in Retry-After.Wait the seconds in Retry-After, then call again.
429source.busyThat is a lot of reads from this source in one hour.Give it a few minutes and press again.
500serverSomething failed on our side. The answer carries a requestId to quote.Try again in a minute; if it keeps happening, report it.
502report.failedThat report could not be worked out.Try again; if it keeps happening, report it.
503developer.unavailableAPI keys are not set up on this deployment yet.Report it, and we will switch them on.