# 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.

Markdown twin of https://panlytics.net/developers/api/shops-research (last updated 2026-10-25). Every page of the Panlytics developer docs is listed at https://panlytics.net/developers/llms.txt, and all of them are in one file at https://panlytics.net/developers/llms-full.txt. The site guide is https://panlytics.net/llms.txt.

## 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

| Name | In | Type | Required | What it is |
| --- | --- | --- | --- | --- |
| `id` | path | integer | Yes | The shop's id. |
| `Authorization` | header | string | Yes | Bearer, a space, then the key. |

### Body

Sent as `application/json`.

| Field | Type | Required | What it is |
| --- | --- | --- | --- |
| `country` | string | No | The country to research in. Left out, the shop's own. |
| `city` | string | No | The city. Left out, the shop's own. |
| `area` | string | No | The street or district. Left out, the shop's own. |
| `notes` | string | No | What you already know about who shops here. Left out, the shop's own notes. |

### Example request

```bash title="curl"
curl -X POST https://panlytics.net/api/v1/shops/12/research \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```python title="Python"
import os

import requests

response = requests.post(
    "https://panlytics.net/api/v1/shops/12/research",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    json={},
    timeout=60,
)
response.raise_for_status()
print(response.json())
```
```typescript title="TypeScript"
const response = await fetch("https://panlytics.net/api/v1/shops/12/research", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
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 |
| --- | --- | --- | --- |
| `sources` | integer | Yes | How many web sources the research cites. |
| `mapNote` | string or null | Yes | A sentence when the map could not place the address it settled on, or null. |
| `shop` | object | Yes | The shop as it stands now, with its new `profile`. |
| `shop.id` | integer | Yes | The shop's id. |
| `shop.name` | string | Yes | What the shop is called, as people in the company say it. |
| `shop.branch` | string | Yes | The branch name, or empty. |
| `shop.city` | string | Yes | The city the shop is in. |
| `shop.country` | string | Yes | The country the shop is in, or empty. |
| `shop.createdAt` | string (ISO 8601) | Yes | When the shop was made, in UTC. |
| `shop.givenName` | string | Yes | The name the shop was opened under. Equal to `name` until somebody renames it. |
| `shop.kind` | string: manual, shopify, netvisor | Yes | What feeds the shop: manual (reports somebody uploads), shopify or netvisor. |
| `shop.openToPublic` | boolean | Yes | True for a shop people walk into, false for a warehouse or a stockroom. |
| `shop.notes` | string | Yes | Who shops here, in the company's own words, or empty. |
| `shop.about` | string | Yes | Anything else worth knowing about this shop, or empty. |
| `shop.profile` | string or null | Yes | The short summary of the area around the shop, when it has been researched. Null otherwise. |
| `shop.place` | object or null | Yes | Where the shop stands on the map, when it has a pin. Null otherwise. |
| `shop.place.label` | string | Yes | The address as the map gave it. |
| `shop.place.lat` | number | Yes | Latitude. |
| `shop.place.lon` | number | Yes | Longitude. |
| `shop.archivedAt` | string (ISO 8601) or null | Yes | When the shop was archived, in UTC. Null for an open shop. |

### Example response

```json title="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](https://panlytics.net/developers/security/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. |
| 400 | `bad_request.said` |  | Change it and try 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 | `conflict.said` | The shop already has a supplier with that name. | Use another name, or change the supplier that has it. |
| 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 | `limit.said` |  | Wait for the next hour, or ask us to raise it. |
| 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. |
| 503 | `agent.empty` | The assistant came back with nothing. | Send it again; if it keeps happening, report it. |
| 503 | `unavailable.said` |  | Wait a minute and try again; if it keeps happening, report it. |