`insights.map.drilldown`

Inspect up to 100 map records with the same filters, an optional returned clusterKey and an opaque nextCursor. Logical records and stable cursor paging preserve source access and missing-location coverage.

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

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_insights_map_drilldown

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
clusterKeystring
at most 100 characters · Matches ^(?:grid:\d+(?:\.\d+)?:\d+:\d+|(?:city|region):[a-f0-9]{64})$
cursorstring
Where the next page starts: the nextCursor value from the previous response.
Matches ^[A-Za-z0-9_-]{1,300}$
limitinteger
How many results to return at most.
1 to 100

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/insights.map.drilldown", {
  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.drilldown",
    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.drilldown

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/insights.map.drilldown", {
  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.drilldown",
    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