Shops

POST/v1/shops/{id}/research

Research the area around a shop: who lives there, what they earn, what they buy, with the web sources it rests on.

What it does

The shop page's "Research the area" button, the same AI pass with web search. Needs the sheet ability over the whole shop. It replaces the shop's earlier research and its summary (profile), may move its pin, and is written to the audit log. Fields left out are the shop's own. It spends AI and can take a minute or more. A key's maker may run area research and basket scans 20 times a day in all (429 after that). A place closed to the public has no walk-in customers to research (409).

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

Parameters

NameInTypeRequiredWhat it is
idpathintegerYesThe shop's id.
AuthorizationheaderstringYesBearer, a space, then the key.

Body

Sent as application/json.

FieldTypeRequiredWhat it is
countrystringNoThe country to research in. Left out, the shop's own.
citystringNoThe city. Left out, the shop's own.
areastringNoThe street or district. Left out, the shop's own.
notesstringNoWhat you already know about who shops here. Left out, the shop's own notes.

Example request

curl -X POST https://panlytics.net/api/v1/shops/12/research \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

200: The answer, as JSON.

FieldTypeAlways thereWhat it is
sourcesintegerYesHow many web sources the research cites.
mapNotestring or nullYesA sentence when the map could not place the address it settled on, or null.
shopobjectYesThe shop as it stands now, with its new profile.
shop.idintegerYesThe shop's id.
shop.namestringYesWhat the shop is called, as people in the company say it.
shop.branchstringYesThe branch name, or empty.
shop.citystringYesThe city the shop is in.
shop.countrystringYesThe country the shop is in, or empty.
shop.createdAtstring (ISO 8601)YesWhen the shop was made, in UTC.
shop.givenNamestringYesThe name the shop was opened under. Equal to name until somebody renames it.
shop.kindstring: manual, shopify, netvisorYesWhat feeds the shop: manual (reports somebody uploads), shopify or netvisor.
shop.openToPublicbooleanYesTrue for a shop people walk into, false for a warehouse or a stockroom.
shop.notesstringYesWho shops here, in the company's own words, or empty.
shop.aboutstringYesAnything else worth knowing about this shop, or empty.
shop.profilestring or nullYesThe short summary of the area around the shop, when it has been researched. Null otherwise.
shop.placeobject or nullYesWhere the shop stands on the map, when it has a pin. Null otherwise.
shop.place.labelstringYesThe address as the map gave it.
shop.place.latnumberYesLatitude.
shop.place.lonnumberYesLongitude.
shop.archivedAtstring (ISO 8601) or nullYesWhen the shop was archived, in UTC. Null for an open shop.

Example response

200
{
  "sources": 9,
  "mapNote": null,
  "shop": {
    "id": 12,
    "name": "Harbour",
    "givenName": "Harbour",
    "branch": "",
    "city": "Helsinki",
    "country": "Finland",
    "createdAt": "2026-10-01T08:00:00.000Z",
    "kind": "manual",
    "openToPublic": true,
    "notes": "Students from the campus nearby, and families at the weekend.",
    "about": "A mid-sized grocery next to the ferry terminal.",
    "profile": "A commuter crowd on weekdays and families at the weekend.",
    "place": {
      "label": "Satamakatu 1, Helsinki",
      "lat": 60.1675,
      "lon": 24.9566
    },
    "archivedAt": 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.

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.
400bad_request.saidChange it and try 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.
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.
409conflict.saidThe shop already has a supplier with that name.Use another name, or change the supplier that has it.
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.
429limit.saidWait for the next hour, or ask us to raise it.
500serverSomething failed on our side. The answer carries a requestId to quote.Try again in a minute; 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.
503agent.emptyThe assistant came back with nothing.Send it again; if it keeps happening, report it.
503unavailable.saidWait a minute and try again; if it keeps happening, report it.