`insights.map.get`

Read a bounded geographic map of transactions, trips, saved hotel groups and saved event venues. Filter by layers, dates, transaction types, currency, search, explicit country/region/city, bounds and zoom; group by saved city/region or geographic grids. Counts include missing-location coverage, and transaction values stay separate by currency. Only locations and sources the actor can read are included; no geocoding or model calls.

GETPOST/api/v1/accounting/insights.map.get

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_insights_map_get

Fields

layersarray of enum values
transactionstripsstayseventsother
1–5 items
querystring
Text to search for.
1–120 characters
fromstring
The first date to include, as YYYY-MM-DD.
Date as YYYY-MM-DD
tostring
The last date to include, as YYYY-MM-DD.
Date as YYYY-MM-DD
currencystring
Three-letter currency code, such as CAD or USD.
entryTypesarray of enum values
expenseincomeincome_refundrefundtransferfeesuspense
1–7 items
countrystring
1–120 characters
regionstring
1–120 characters
citystring
1–120 characters
boundsobject
No other fields
zoomnumber
0 to 22
groupByenum
autoregioncitygrid

curl https://app.getoatmilk.com/api/v1/accounting/insights.map.get \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/insights.map.get", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/insights.map.get",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

GET/api/v1/accounting/insights.map.get

curl https://app.getoatmilk.com/api/v1/accounting/insights.map.get \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/insights.map.get", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/insights.map.get",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside bounds

Example

Try it